com.amazonaws.services.ivs

Class AbstractAmazonIVS

java.lang.Object

com.amazonaws.services.ivs.AbstractAmazonIVS

All Implemented Interfaces:

AmazonIVS

Direct Known Subclasses:

AbstractAmazonIVSAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonIVS
extends Object
implements AmazonIVS

Abstract implementation of AmazonIVS. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

Fields inherited from interface com.amazonaws.services.ivs.AmazonIVS

ENDPOINT_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAmazonIVS()

Method Summary

Modifier and Type	Method and Description
BatchGetChannelResult	batchGetChannel(BatchGetChannelRequest request) Performs GetChannel on multiple ARNs simultaneously.
BatchGetStreamKeyResult	batchGetStreamKey(BatchGetStreamKeyRequest request) Performs GetStreamKey on multiple ARNs simultaneously.
CreateChannelResult	createChannel(CreateChannelRequest request) Creates a new channel and an associated stream key to start streaming.
CreateStreamKeyResult	createStreamKey(CreateStreamKeyRequest request) Creates a stream key, used to initiate a stream, for the specified channel ARN.
DeleteChannelResult	deleteChannel(DeleteChannelRequest request) Deletes the specified channel and its associated stream keys.
DeletePlaybackKeyPairResult	deletePlaybackKeyPair(DeletePlaybackKeyPairRequest request) Deletes a specified authorization key pair.
DeleteStreamKeyResult	deleteStreamKey(DeleteStreamKeyRequest request) Deletes the stream key for the specified ARN, so it can no longer be used to stream.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetChannelResult	getChannel(GetChannelRequest request) Gets the channel configuration for the specified channel ARN.
GetPlaybackKeyPairResult	getPlaybackKeyPair(GetPlaybackKeyPairRequest request) Gets a specified playback authorization key pair and returns the arn and fingerprint.
GetStreamResult	getStream(GetStreamRequest request) Gets information about the active (live) stream on a specified channel.
GetStreamKeyResult	getStreamKey(GetStreamKeyRequest request) Gets stream-key information for a specified ARN.
ImportPlaybackKeyPairResult	importPlaybackKeyPair(ImportPlaybackKeyPairRequest request) Imports the public portion of a new key pair and returns its arn and fingerprint.
ListChannelsResult	listChannels(ListChannelsRequest request) Gets summary information about all channels in your account, in the AWS region where the API request is processed.
ListPlaybackKeyPairsResult	listPlaybackKeyPairs(ListPlaybackKeyPairsRequest request) Gets summary information about playback key pairs.
ListStreamKeysResult	listStreamKeys(ListStreamKeysRequest request) Gets summary information about stream keys for the specified channel.
ListStreamsResult	listStreams(ListStreamsRequest request) Gets summary information about live streams in your account, in the AWS region where the API request is processed.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Gets information about AWS tags for the specified ARN.
PutMetadataResult	putMetadata(PutMetadataRequest request) Inserts metadata into an RTMPS stream for the specified channel.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StopStreamResult	stopStream(StopStreamRequest request) Disconnects the incoming RTMPS stream for the specified channel.
TagResourceResult	tagResource(TagResourceRequest request) Adds or updates tags for the AWS resource with the specified ARN.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes tags from the resource with the specified ARN.
UpdateChannelResult	updateChannel(UpdateChannelRequest request) Updates a channel's configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractAmazonIVS

protected AbstractAmazonIVS()

Method Detail

batchGetChannel

public BatchGetChannelResult batchGetChannel(BatchGetChannelRequest request)

Description copied from interface: AmazonIVS

Performs GetChannel on multiple ARNs simultaneously.

Specified by:

batchGetChannel in interface AmazonIVS

Returns:

Result of the BatchGetChannel operation returned by the service.

See Also:

AWS API Documentation

batchGetStreamKey

public BatchGetStreamKeyResult batchGetStreamKey(BatchGetStreamKeyRequest request)

Description copied from interface: AmazonIVS

Performs GetStreamKey on multiple ARNs simultaneously.

Specified by:

batchGetStreamKey in interface AmazonIVS

Returns:

Result of the BatchGetStreamKey operation returned by the service.

See Also:

AWS API Documentation

createChannel

public CreateChannelResult createChannel(CreateChannelRequest request)

Description copied from interface: AmazonIVS

Creates a new channel and an associated stream key to start streaming.

Specified by:

createChannel in interface AmazonIVS

Returns:

Result of the CreateChannel operation returned by the service.

See Also:

AWS API Documentation

createStreamKey

public CreateStreamKeyResult createStreamKey(CreateStreamKeyRequest request)

Description copied from interface: AmazonIVS

Creates a stream key, used to initiate a stream, for the specified channel ARN.

Note that CreateChannel creates a stream key. If you subsequently use CreateStreamKey on the same channel, it will fail because a stream key already exists and there is a limit of 1 stream key per channel. To reset the stream key on a channel, use DeleteStreamKey and then CreateStreamKey.

Specified by:

createStreamKey in interface AmazonIVS

Returns:

Result of the CreateStreamKey operation returned by the service.

See Also:

AWS API Documentation

deleteChannel

public DeleteChannelResult deleteChannel(DeleteChannelRequest request)

Description copied from interface: AmazonIVS

Deletes the specified channel and its associated stream keys.

Specified by:

deleteChannel in interface AmazonIVS

Returns:

Result of the DeleteChannel operation returned by the service.

See Also:

AWS API Documentation

deletePlaybackKeyPair

public DeletePlaybackKeyPairResult deletePlaybackKeyPair(DeletePlaybackKeyPairRequest request)

Description copied from interface: AmazonIVS

Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s privateKey.

Specified by:

deletePlaybackKeyPair in interface AmazonIVS

Returns:

Result of the DeletePlaybackKeyPair operation returned by the service.

See Also:

AWS API Documentation

deleteStreamKey

public DeleteStreamKeyResult deleteStreamKey(DeleteStreamKeyRequest request)

Description copied from interface: AmazonIVS

Deletes the stream key for the specified ARN, so it can no longer be used to stream.

Specified by:

deleteStreamKey in interface AmazonIVS

Returns:

Result of the DeleteStreamKey operation returned by the service.

See Also:

AWS API Documentation

getChannel

public GetChannelResult getChannel(GetChannelRequest request)

Description copied from interface: AmazonIVS

Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.

Specified by:

getChannel in interface AmazonIVS

Returns:

Result of the GetChannel operation returned by the service.

See Also:

AWS API Documentation

getPlaybackKeyPair

public GetPlaybackKeyPairResult getPlaybackKeyPair(GetPlaybackKeyPairRequest request)

Description copied from interface: AmazonIVS

Gets a specified playback authorization key pair and returns the arn and fingerprint. The privateKey held by the caller can be used to generate viewer authorization tokens, to grant viewers access to authorized channels.

Specified by:

getPlaybackKeyPair in interface AmazonIVS

Returns:

Result of the GetPlaybackKeyPair operation returned by the service.

See Also:

AWS API Documentation

getStream

public GetStreamResult getStream(GetStreamRequest request)

Description copied from interface: AmazonIVS

Gets information about the active (live) stream on a specified channel.

Specified by:

getStream in interface AmazonIVS

Returns:

Result of the GetStream operation returned by the service.

See Also:

AWS API Documentation

getStreamKey

public GetStreamKeyResult getStreamKey(GetStreamKeyRequest request)

Description copied from interface: AmazonIVS

Gets stream-key information for a specified ARN.

Specified by:

getStreamKey in interface AmazonIVS

Returns:

Result of the GetStreamKey operation returned by the service.

See Also:

AWS API Documentation

importPlaybackKeyPair

public ImportPlaybackKeyPairResult importPlaybackKeyPair(ImportPlaybackKeyPairRequest request)

Description copied from interface: AmazonIVS

Imports the public portion of a new key pair and returns its arn and fingerprint. The privateKey can then be used to generate viewer authorization tokens, to grant viewers access to authorized channels.

Specified by:

importPlaybackKeyPair in interface AmazonIVS

Returns:

Result of the ImportPlaybackKeyPair operation returned by the service.

See Also:

AWS API Documentation

listChannels

public ListChannelsResult listChannels(ListChannelsRequest request)

Description copied from interface: AmazonIVS

Gets summary information about all channels in your account, in the AWS region where the API request is processed. This list can be filtered to match a specified string.

Specified by:

listChannels in interface AmazonIVS

Returns:

Result of the ListChannels operation returned by the service.

See Also:

AWS API Documentation

listPlaybackKeyPairs

public ListPlaybackKeyPairsResult listPlaybackKeyPairs(ListPlaybackKeyPairsRequest request)

Description copied from interface: AmazonIVS

Gets summary information about playback key pairs.

Specified by:

listPlaybackKeyPairs in interface AmazonIVS

Returns:

Result of the ListPlaybackKeyPairs operation returned by the service.

See Also:

AWS API Documentation

listStreamKeys

public ListStreamKeysResult listStreamKeys(ListStreamKeysRequest request)

Description copied from interface: AmazonIVS

Gets summary information about stream keys for the specified channel.

Specified by:

listStreamKeys in interface AmazonIVS

Returns:

Result of the ListStreamKeys operation returned by the service.

See Also:

AWS API Documentation

listStreams

public ListStreamsResult listStreams(ListStreamsRequest request)

Description copied from interface: AmazonIVS

Gets summary information about live streams in your account, in the AWS region where the API request is processed.

Specified by:

listStreams in interface AmazonIVS

Returns:

Result of the ListStreams operation returned by the service.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Description copied from interface: AmazonIVS

Gets information about AWS tags for the specified ARN.

Specified by:

listTagsForResource in interface AmazonIVS

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

putMetadata

public PutMetadataResult putMetadata(PutMetadataRequest request)

Description copied from interface: AmazonIVS

Inserts metadata into an RTMPS stream for the specified channel. A maximum of 5 requests per second per channel is allowed, each with a maximum 1KB payload.

Specified by:

putMetadata in interface AmazonIVS

Returns:

Result of the PutMetadata operation returned by the service.

See Also:

AWS API Documentation

stopStream

public StopStreamResult stopStream(StopStreamRequest request)

Description copied from interface: AmazonIVS

Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel.

Many streaming client-software libraries automatically reconnect a dropped RTMPS session, so to stop the stream permanently, you may want to first revoke the streamKey attached to the channel.

Specified by:

stopStream in interface AmazonIVS

Returns:

Result of the StopStream operation returned by the service.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Description copied from interface: AmazonIVS

Adds or updates tags for the AWS resource with the specified ARN.

Specified by:

tagResource in interface AmazonIVS

Returns:

Result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Description copied from interface: AmazonIVS

Removes tags from the resource with the specified ARN.

Specified by:

untagResource in interface AmazonIVS

Returns:

Result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

updateChannel

public UpdateChannelResult updateChannel(UpdateChannelRequest request)

Description copied from interface: AmazonIVS

Updates a channel's configuration. This does not affect an ongoing stream of this channel. You must stop and restart the stream for the changes to take effect.

Specified by:

updateChannel in interface AmazonIVS

Returns:

Result of the UpdateChannel operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: AmazonIVS

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonIVS

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AmazonIVS

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Specified by:

getCachedResponseMetadata in interface AmazonIVS

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.