com.amazonaws.services.ivs

Interface AmazonIVSAsync

All Superinterfaces:

AmazonIVS

All Known Implementing Classes:

AbstractAmazonIVSAsync, AmazonIVSAsyncClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonIVSAsync
extends AmazonIVS

Interface for accessing Amazon IVS asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonIVSAsync instead.

Introduction

The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP API and an AWS SNS event stream for responses. JSON is used for both requests and responses, including errors.

The API is an AWS regional service, currently in these regions: us-west-2, us-east-1, and eu-west-1.

All API request parameters and URLs are case sensitive.

For a summary of notable documentation changes in each release, see Document History.

Service Endpoints

The following are the Amazon IVS service endpoints (all HTTPS):

Region name: US West (Oregon)

• Region: us-west-2

• Endpoint: ivs.us-west-2.amazonaws.com

Region name: US East (Virginia)

• Region: us-east-1

• Endpoint: ivs.us-east-1.amazonaws.com

Region name: EU West (Dublin)

• Region: eu-west-1

• Endpoint: ivs.eu-west-1.amazonaws.com

Allowed Header Values

• Accept: application/json

• Accept-Encoding: gzip, deflate

• Content-Type: application/json

Resources

The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS):

• Channel — Stores configuration data related to your live stream. You first create a channel and then use the channel’s stream key to start your live stream. See the Channel endpoints for more information.

• Stream key — An identifier assigned by Amazon IVS when you create a channel, which is then used to authorize streaming. See the StreamKey endpoints for more information. Treat the stream key like a secret, since it allows anyone to stream to the channel.

• Playback key pair — Video playback may be restricted using playback-authorization tokens, which use public-key encryption. A playback key pair is the public-private pair of keys used to sign and validate the playback-authorization token. See the PlaybackKeyPair endpoints for more information.

Tagging

A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature to label a particular video category. See Tagging AWS Resources for more information, including restrictions that apply to tags.

Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).

The Amazon IVS API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resources support tagging: Channels, Stream Keys, and Playback Key Pairs.

Channel Endpoints

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

• GetChannel — Gets the channel configuration for the specified channel ARN (Amazon Resource Name).

• BatchGetChannel — Performs GetChannel on multiple ARNs simultaneously.

• ListChannels — 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.

• UpdateChannel — 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.

• DeleteChannel — Deletes the specified channel.

StreamKey Endpoints

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

• GetStreamKey — Gets stream key information for the specified ARN.

• BatchGetStreamKey — Performs GetStreamKey on multiple ARNs simultaneously.

• ListStreamKeys — Gets summary information about stream keys for the specified channel.

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

Stream Endpoints

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

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

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

• PutMetadata — 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.

PlaybackKeyPair Endpoints

• ImportPlaybackKeyPair — 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.

• GetPlaybackKeyPair — 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.

• ListPlaybackKeyPairs — Gets summary information about playback key pairs.

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

AWS Tags Endpoints

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

• UntagResource — Removes tags from the resource with the specified ARN.

• ListTagsForResource — Gets information about AWS tags for the specified ARN.

Field Summary

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
Future<BatchGetChannelResult>	batchGetChannelAsync(BatchGetChannelRequest batchGetChannelRequest) Performs GetChannel on multiple ARNs simultaneously.
Future<BatchGetChannelResult>	batchGetChannelAsync(BatchGetChannelRequest batchGetChannelRequest, AsyncHandler<BatchGetChannelRequest,BatchGetChannelResult> asyncHandler) Performs GetChannel on multiple ARNs simultaneously.
Future<BatchGetStreamKeyResult>	batchGetStreamKeyAsync(BatchGetStreamKeyRequest batchGetStreamKeyRequest) Performs GetStreamKey on multiple ARNs simultaneously.
Future<BatchGetStreamKeyResult>	batchGetStreamKeyAsync(BatchGetStreamKeyRequest batchGetStreamKeyRequest, AsyncHandler<BatchGetStreamKeyRequest,BatchGetStreamKeyResult> asyncHandler) Performs GetStreamKey on multiple ARNs simultaneously.
Future<CreateChannelResult>	createChannelAsync(CreateChannelRequest createChannelRequest) Creates a new channel and an associated stream key to start streaming.
Future<CreateChannelResult>	createChannelAsync(CreateChannelRequest createChannelRequest, AsyncHandler<CreateChannelRequest,CreateChannelResult> asyncHandler) Creates a new channel and an associated stream key to start streaming.
Future<CreateStreamKeyResult>	createStreamKeyAsync(CreateStreamKeyRequest createStreamKeyRequest) Creates a stream key, used to initiate a stream, for the specified channel ARN.
Future<CreateStreamKeyResult>	createStreamKeyAsync(CreateStreamKeyRequest createStreamKeyRequest, AsyncHandler<CreateStreamKeyRequest,CreateStreamKeyResult> asyncHandler) Creates a stream key, used to initiate a stream, for the specified channel ARN.
Future<DeleteChannelResult>	deleteChannelAsync(DeleteChannelRequest deleteChannelRequest) Deletes the specified channel and its associated stream keys.
Future<DeleteChannelResult>	deleteChannelAsync(DeleteChannelRequest deleteChannelRequest, AsyncHandler<DeleteChannelRequest,DeleteChannelResult> asyncHandler) Deletes the specified channel and its associated stream keys.
Future<DeletePlaybackKeyPairResult>	deletePlaybackKeyPairAsync(DeletePlaybackKeyPairRequest deletePlaybackKeyPairRequest) Deletes a specified authorization key pair.
Future<DeletePlaybackKeyPairResult>	deletePlaybackKeyPairAsync(DeletePlaybackKeyPairRequest deletePlaybackKeyPairRequest, AsyncHandler<DeletePlaybackKeyPairRequest,DeletePlaybackKeyPairResult> asyncHandler) Deletes a specified authorization key pair.
Future<DeleteStreamKeyResult>	deleteStreamKeyAsync(DeleteStreamKeyRequest deleteStreamKeyRequest) Deletes the stream key for the specified ARN, so it can no longer be used to stream.
Future<DeleteStreamKeyResult>	deleteStreamKeyAsync(DeleteStreamKeyRequest deleteStreamKeyRequest, AsyncHandler<DeleteStreamKeyRequest,DeleteStreamKeyResult> asyncHandler) Deletes the stream key for the specified ARN, so it can no longer be used to stream.
Future<GetChannelResult>	getChannelAsync(GetChannelRequest getChannelRequest) Gets the channel configuration for the specified channel ARN.
Future<GetChannelResult>	getChannelAsync(GetChannelRequest getChannelRequest, AsyncHandler<GetChannelRequest,GetChannelResult> asyncHandler) Gets the channel configuration for the specified channel ARN.
Future<GetPlaybackKeyPairResult>	getPlaybackKeyPairAsync(GetPlaybackKeyPairRequest getPlaybackKeyPairRequest) Gets a specified playback authorization key pair and returns the arn and fingerprint.
Future<GetPlaybackKeyPairResult>	getPlaybackKeyPairAsync(GetPlaybackKeyPairRequest getPlaybackKeyPairRequest, AsyncHandler<GetPlaybackKeyPairRequest,GetPlaybackKeyPairResult> asyncHandler) Gets a specified playback authorization key pair and returns the arn and fingerprint.
Future<GetStreamResult>	getStreamAsync(GetStreamRequest getStreamRequest) Gets information about the active (live) stream on a specified channel.
Future<GetStreamResult>	getStreamAsync(GetStreamRequest getStreamRequest, AsyncHandler<GetStreamRequest,GetStreamResult> asyncHandler) Gets information about the active (live) stream on a specified channel.
Future<GetStreamKeyResult>	getStreamKeyAsync(GetStreamKeyRequest getStreamKeyRequest) Gets stream-key information for a specified ARN.
Future<GetStreamKeyResult>	getStreamKeyAsync(GetStreamKeyRequest getStreamKeyRequest, AsyncHandler<GetStreamKeyRequest,GetStreamKeyResult> asyncHandler) Gets stream-key information for a specified ARN.
Future<ImportPlaybackKeyPairResult>	importPlaybackKeyPairAsync(ImportPlaybackKeyPairRequest importPlaybackKeyPairRequest) Imports the public portion of a new key pair and returns its arn and fingerprint.
Future<ImportPlaybackKeyPairResult>	importPlaybackKeyPairAsync(ImportPlaybackKeyPairRequest importPlaybackKeyPairRequest, AsyncHandler<ImportPlaybackKeyPairRequest,ImportPlaybackKeyPairResult> asyncHandler) Imports the public portion of a new key pair and returns its arn and fingerprint.
Future<ListChannelsResult>	listChannelsAsync(ListChannelsRequest listChannelsRequest) Gets summary information about all channels in your account, in the AWS region where the API request is processed.
Future<ListChannelsResult>	listChannelsAsync(ListChannelsRequest listChannelsRequest, AsyncHandler<ListChannelsRequest,ListChannelsResult> asyncHandler) Gets summary information about all channels in your account, in the AWS region where the API request is processed.
Future<ListPlaybackKeyPairsResult>	listPlaybackKeyPairsAsync(ListPlaybackKeyPairsRequest listPlaybackKeyPairsRequest) Gets summary information about playback key pairs.
Future<ListPlaybackKeyPairsResult>	listPlaybackKeyPairsAsync(ListPlaybackKeyPairsRequest listPlaybackKeyPairsRequest, AsyncHandler<ListPlaybackKeyPairsRequest,ListPlaybackKeyPairsResult> asyncHandler) Gets summary information about playback key pairs.
Future<ListStreamKeysResult>	listStreamKeysAsync(ListStreamKeysRequest listStreamKeysRequest) Gets summary information about stream keys for the specified channel.
Future<ListStreamKeysResult>	listStreamKeysAsync(ListStreamKeysRequest listStreamKeysRequest, AsyncHandler<ListStreamKeysRequest,ListStreamKeysResult> asyncHandler) Gets summary information about stream keys for the specified channel.
Future<ListStreamsResult>	listStreamsAsync(ListStreamsRequest listStreamsRequest) Gets summary information about live streams in your account, in the AWS region where the API request is processed.
Future<ListStreamsResult>	listStreamsAsync(ListStreamsRequest listStreamsRequest, AsyncHandler<ListStreamsRequest,ListStreamsResult> asyncHandler) Gets summary information about live streams in your account, in the AWS region where the API request is processed.
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest) Gets information about AWS tags for the specified ARN.
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler) Gets information about AWS tags for the specified ARN.
Future<PutMetadataResult>	putMetadataAsync(PutMetadataRequest putMetadataRequest) Inserts metadata into an RTMPS stream for the specified channel.
Future<PutMetadataResult>	putMetadataAsync(PutMetadataRequest putMetadataRequest, AsyncHandler<PutMetadataRequest,PutMetadataResult> asyncHandler) Inserts metadata into an RTMPS stream for the specified channel.
Future<StopStreamResult>	stopStreamAsync(StopStreamRequest stopStreamRequest) Disconnects the incoming RTMPS stream for the specified channel.
Future<StopStreamResult>	stopStreamAsync(StopStreamRequest stopStreamRequest, AsyncHandler<StopStreamRequest,StopStreamResult> asyncHandler) Disconnects the incoming RTMPS stream for the specified channel.
Future<TagResourceResult>	tagResourceAsync(TagResourceRequest tagResourceRequest) Adds or updates tags for the AWS resource with the specified ARN.
Future<TagResourceResult>	tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler) Adds or updates tags for the AWS resource with the specified ARN.
Future<UntagResourceResult>	untagResourceAsync(UntagResourceRequest untagResourceRequest) Removes tags from the resource with the specified ARN.
Future<UntagResourceResult>	untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler) Removes tags from the resource with the specified ARN.
Future<UpdateChannelResult>	updateChannelAsync(UpdateChannelRequest updateChannelRequest) Updates a channel's configuration.
Future<UpdateChannelResult>	updateChannelAsync(UpdateChannelRequest updateChannelRequest, AsyncHandler<UpdateChannelRequest,UpdateChannelResult> asyncHandler) Updates a channel's configuration.

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

batchGetChannel, batchGetStreamKey, createChannel, createStreamKey, deleteChannel, deletePlaybackKeyPair, deleteStreamKey, getCachedResponseMetadata, getChannel, getPlaybackKeyPair, getStream, getStreamKey, importPlaybackKeyPair, listChannels, listPlaybackKeyPairs, listStreamKeys, listStreams, listTagsForResource, putMetadata, shutdown, stopStream, tagResource, untagResource, updateChannel

Method Detail

batchGetChannelAsync

Future<BatchGetChannelResult> batchGetChannelAsync(BatchGetChannelRequest batchGetChannelRequest)

Performs GetChannel on multiple ARNs simultaneously.

Parameters:

batchGetChannelRequest -

Returns:

A Java Future containing the result of the BatchGetChannel operation returned by the service.

See Also:

AWS API Documentation

batchGetChannelAsync

Future<BatchGetChannelResult> batchGetChannelAsync(BatchGetChannelRequest batchGetChannelRequest,
                                                   AsyncHandler<BatchGetChannelRequest,BatchGetChannelResult> asyncHandler)

Performs GetChannel on multiple ARNs simultaneously.

Parameters:

batchGetChannelRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the BatchGetChannel operation returned by the service.

See Also:

AWS API Documentation

batchGetStreamKeyAsync

Future<BatchGetStreamKeyResult> batchGetStreamKeyAsync(BatchGetStreamKeyRequest batchGetStreamKeyRequest)

Performs GetStreamKey on multiple ARNs simultaneously.

Parameters:

batchGetStreamKeyRequest -

Returns:

A Java Future containing the result of the BatchGetStreamKey operation returned by the service.

See Also:

AWS API Documentation

batchGetStreamKeyAsync

Future<BatchGetStreamKeyResult> batchGetStreamKeyAsync(BatchGetStreamKeyRequest batchGetStreamKeyRequest,
                                                       AsyncHandler<BatchGetStreamKeyRequest,BatchGetStreamKeyResult> asyncHandler)

Performs GetStreamKey on multiple ARNs simultaneously.

Parameters:

batchGetStreamKeyRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the BatchGetStreamKey operation returned by the service.

See Also:

AWS API Documentation

createChannelAsync

Future<CreateChannelResult> createChannelAsync(CreateChannelRequest createChannelRequest)

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

Parameters:

createChannelRequest -

Returns:

A Java Future containing the result of the CreateChannel operation returned by the service.

See Also:

AWS API Documentation

createChannelAsync

Future<CreateChannelResult> createChannelAsync(CreateChannelRequest createChannelRequest,
                                               AsyncHandler<CreateChannelRequest,CreateChannelResult> asyncHandler)

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

Parameters:

createChannelRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CreateChannel operation returned by the service.

See Also:

AWS API Documentation

createStreamKeyAsync

Future<CreateStreamKeyResult> createStreamKeyAsync(CreateStreamKeyRequest createStreamKeyRequest)

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.

Parameters:

createStreamKeyRequest -

Returns:

A Java Future containing the result of the CreateStreamKey operation returned by the service.

See Also:

AWS API Documentation

createStreamKeyAsync

Future<CreateStreamKeyResult> createStreamKeyAsync(CreateStreamKeyRequest createStreamKeyRequest,
                                                   AsyncHandler<CreateStreamKeyRequest,CreateStreamKeyResult> asyncHandler)

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.

Parameters:

createStreamKeyRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CreateStreamKey operation returned by the service.

See Also:

AWS API Documentation

deleteChannelAsync

Future<DeleteChannelResult> deleteChannelAsync(DeleteChannelRequest deleteChannelRequest)

Deletes the specified channel and its associated stream keys.

Parameters:

deleteChannelRequest -

Returns:

A Java Future containing the result of the DeleteChannel operation returned by the service.

See Also:

AWS API Documentation

deleteChannelAsync

Future<DeleteChannelResult> deleteChannelAsync(DeleteChannelRequest deleteChannelRequest,
                                               AsyncHandler<DeleteChannelRequest,DeleteChannelResult> asyncHandler)

Deletes the specified channel and its associated stream keys.

Parameters:

deleteChannelRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteChannel operation returned by the service.

See Also:

AWS API Documentation

deletePlaybackKeyPairAsync

Future<DeletePlaybackKeyPairResult> deletePlaybackKeyPairAsync(DeletePlaybackKeyPairRequest deletePlaybackKeyPairRequest)

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

Parameters:

deletePlaybackKeyPairRequest -

Returns:

A Java Future containing the result of the DeletePlaybackKeyPair operation returned by the service.

See Also:

AWS API Documentation

deletePlaybackKeyPairAsync

Future<DeletePlaybackKeyPairResult> deletePlaybackKeyPairAsync(DeletePlaybackKeyPairRequest deletePlaybackKeyPairRequest,
                                                               AsyncHandler<DeletePlaybackKeyPairRequest,DeletePlaybackKeyPairResult> asyncHandler)

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

Parameters:

deletePlaybackKeyPairRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeletePlaybackKeyPair operation returned by the service.

See Also:

AWS API Documentation

deleteStreamKeyAsync

Future<DeleteStreamKeyResult> deleteStreamKeyAsync(DeleteStreamKeyRequest deleteStreamKeyRequest)

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

Parameters:

deleteStreamKeyRequest -

Returns:

A Java Future containing the result of the DeleteStreamKey operation returned by the service.

See Also:

AWS API Documentation

deleteStreamKeyAsync

Future<DeleteStreamKeyResult> deleteStreamKeyAsync(DeleteStreamKeyRequest deleteStreamKeyRequest,
                                                   AsyncHandler<DeleteStreamKeyRequest,DeleteStreamKeyResult> asyncHandler)

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

Parameters:

deleteStreamKeyRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteStreamKey operation returned by the service.

See Also:

AWS API Documentation

getChannelAsync

Future<GetChannelResult> getChannelAsync(GetChannelRequest getChannelRequest)

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

Parameters:

getChannelRequest -

Returns:

A Java Future containing the result of the GetChannel operation returned by the service.

See Also:

AWS API Documentation

getChannelAsync

Future<GetChannelResult> getChannelAsync(GetChannelRequest getChannelRequest,
                                         AsyncHandler<GetChannelRequest,GetChannelResult> asyncHandler)

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

Parameters:

getChannelRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetChannel operation returned by the service.

See Also:

AWS API Documentation

getPlaybackKeyPairAsync

Future<GetPlaybackKeyPairResult> getPlaybackKeyPairAsync(GetPlaybackKeyPairRequest getPlaybackKeyPairRequest)

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.

Parameters:

getPlaybackKeyPairRequest -

Returns:

A Java Future containing the result of the GetPlaybackKeyPair operation returned by the service.

See Also:

AWS API Documentation

getPlaybackKeyPairAsync

Future<GetPlaybackKeyPairResult> getPlaybackKeyPairAsync(GetPlaybackKeyPairRequest getPlaybackKeyPairRequest,
                                                         AsyncHandler<GetPlaybackKeyPairRequest,GetPlaybackKeyPairResult> asyncHandler)

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.

Parameters:

getPlaybackKeyPairRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetPlaybackKeyPair operation returned by the service.

See Also:

AWS API Documentation

getStreamAsync

Future<GetStreamResult> getStreamAsync(GetStreamRequest getStreamRequest)

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

Parameters:

getStreamRequest -

Returns:

A Java Future containing the result of the GetStream operation returned by the service.

See Also:

AWS API Documentation

getStreamAsync

Future<GetStreamResult> getStreamAsync(GetStreamRequest getStreamRequest,
                                       AsyncHandler<GetStreamRequest,GetStreamResult> asyncHandler)

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

Parameters:

getStreamRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetStream operation returned by the service.

See Also:

AWS API Documentation

getStreamKeyAsync

Future<GetStreamKeyResult> getStreamKeyAsync(GetStreamKeyRequest getStreamKeyRequest)

Gets stream-key information for a specified ARN.

Parameters:

getStreamKeyRequest -

Returns:

A Java Future containing the result of the GetStreamKey operation returned by the service.

See Also:

AWS API Documentation

getStreamKeyAsync

Future<GetStreamKeyResult> getStreamKeyAsync(GetStreamKeyRequest getStreamKeyRequest,
                                             AsyncHandler<GetStreamKeyRequest,GetStreamKeyResult> asyncHandler)

Gets stream-key information for a specified ARN.

Parameters:

getStreamKeyRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetStreamKey operation returned by the service.

See Also:

AWS API Documentation

importPlaybackKeyPairAsync

Future<ImportPlaybackKeyPairResult> importPlaybackKeyPairAsync(ImportPlaybackKeyPairRequest importPlaybackKeyPairRequest)

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.

Parameters:

importPlaybackKeyPairRequest -

Returns:

A Java Future containing the result of the ImportPlaybackKeyPair operation returned by the service.

See Also:

AWS API Documentation

importPlaybackKeyPairAsync

Future<ImportPlaybackKeyPairResult> importPlaybackKeyPairAsync(ImportPlaybackKeyPairRequest importPlaybackKeyPairRequest,
                                                               AsyncHandler<ImportPlaybackKeyPairRequest,ImportPlaybackKeyPairResult> asyncHandler)

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.

Parameters:

importPlaybackKeyPairRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ImportPlaybackKeyPair operation returned by the service.

See Also:

AWS API Documentation

listChannelsAsync

Future<ListChannelsResult> listChannelsAsync(ListChannelsRequest listChannelsRequest)

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.

Parameters:

listChannelsRequest -

Returns:

A Java Future containing the result of the ListChannels operation returned by the service.

See Also:

AWS API Documentation

listChannelsAsync

Future<ListChannelsResult> listChannelsAsync(ListChannelsRequest listChannelsRequest,
                                             AsyncHandler<ListChannelsRequest,ListChannelsResult> asyncHandler)

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.

Parameters:

listChannelsRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListChannels operation returned by the service.

See Also:

AWS API Documentation

listPlaybackKeyPairsAsync

Future<ListPlaybackKeyPairsResult> listPlaybackKeyPairsAsync(ListPlaybackKeyPairsRequest listPlaybackKeyPairsRequest)

Gets summary information about playback key pairs.

Parameters:

listPlaybackKeyPairsRequest -

Returns:

A Java Future containing the result of the ListPlaybackKeyPairs operation returned by the service.

See Also:

AWS API Documentation

listPlaybackKeyPairsAsync

Future<ListPlaybackKeyPairsResult> listPlaybackKeyPairsAsync(ListPlaybackKeyPairsRequest listPlaybackKeyPairsRequest,
                                                             AsyncHandler<ListPlaybackKeyPairsRequest,ListPlaybackKeyPairsResult> asyncHandler)

Gets summary information about playback key pairs.

Parameters:

listPlaybackKeyPairsRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListPlaybackKeyPairs operation returned by the service.

See Also:

AWS API Documentation

listStreamKeysAsync

Future<ListStreamKeysResult> listStreamKeysAsync(ListStreamKeysRequest listStreamKeysRequest)

Gets summary information about stream keys for the specified channel.

Parameters:

listStreamKeysRequest -

Returns:

A Java Future containing the result of the ListStreamKeys operation returned by the service.

See Also:

AWS API Documentation

listStreamKeysAsync

Future<ListStreamKeysResult> listStreamKeysAsync(ListStreamKeysRequest listStreamKeysRequest,
                                                 AsyncHandler<ListStreamKeysRequest,ListStreamKeysResult> asyncHandler)

Gets summary information about stream keys for the specified channel.

Parameters:

listStreamKeysRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListStreamKeys operation returned by the service.

See Also:

AWS API Documentation

listStreamsAsync

Future<ListStreamsResult> listStreamsAsync(ListStreamsRequest listStreamsRequest)

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

Parameters:

listStreamsRequest -

Returns:

A Java Future containing the result of the ListStreams operation returned by the service.

See Also:

AWS API Documentation

listStreamsAsync

Future<ListStreamsResult> listStreamsAsync(ListStreamsRequest listStreamsRequest,
                                           AsyncHandler<ListStreamsRequest,ListStreamsResult> asyncHandler)

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

Parameters:

listStreamsRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListStreams operation returned by the service.

See Also:

AWS API Documentation

listTagsForResourceAsync

Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)

Gets information about AWS tags for the specified ARN.

Parameters:

listTagsForResourceRequest -

Returns:

A Java Future containing the result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

listTagsForResourceAsync

Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
                                                           AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)

Gets information about AWS tags for the specified ARN.

Parameters:

listTagsForResourceRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

putMetadataAsync

Future<PutMetadataResult> putMetadataAsync(PutMetadataRequest putMetadataRequest)

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.

Parameters:

putMetadataRequest -

Returns:

A Java Future containing the result of the PutMetadata operation returned by the service.

See Also:

AWS API Documentation

putMetadataAsync

Future<PutMetadataResult> putMetadataAsync(PutMetadataRequest putMetadataRequest,
                                           AsyncHandler<PutMetadataRequest,PutMetadataResult> asyncHandler)

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.

Parameters:

putMetadataRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the PutMetadata operation returned by the service.

See Also:

AWS API Documentation

stopStreamAsync

Future<StopStreamResult> stopStreamAsync(StopStreamRequest stopStreamRequest)

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.

Parameters:

stopStreamRequest -

Returns:

A Java Future containing the result of the StopStream operation returned by the service.

See Also:

AWS API Documentation

stopStreamAsync

Future<StopStreamResult> stopStreamAsync(StopStreamRequest stopStreamRequest,
                                         AsyncHandler<StopStreamRequest,StopStreamResult> asyncHandler)

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.

Parameters:

stopStreamRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the StopStream operation returned by the service.

See Also:

AWS API Documentation

tagResourceAsync

Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)

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

Parameters:

tagResourceRequest -

Returns:

A Java Future containing the result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

tagResourceAsync

Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest,
                                           AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)

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

Parameters:

tagResourceRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

untagResourceAsync

Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)

Removes tags from the resource with the specified ARN.

Parameters:

untagResourceRequest -

Returns:

A Java Future containing the result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

untagResourceAsync

Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest,
                                               AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)

Removes tags from the resource with the specified ARN.

Parameters:

untagResourceRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

updateChannelAsync

Future<UpdateChannelResult> updateChannelAsync(UpdateChannelRequest updateChannelRequest)

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.

Parameters:

updateChannelRequest -

Returns:

A Java Future containing the result of the UpdateChannel operation returned by the service.

See Also:

AWS API Documentation

updateChannelAsync

Future<UpdateChannelResult> updateChannelAsync(UpdateChannelRequest updateChannelRequest,
                                               AsyncHandler<UpdateChannelRequest,UpdateChannelResult> asyncHandler)

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.

Parameters:

updateChannelRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UpdateChannel operation returned by the service.

See Also:

AWS API Documentation