com.amazonaws.services.ivs

Class AmazonIVSAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.ivs.AmazonIVSClient

com.amazonaws.services.ivs.AmazonIVSAsyncClient

All Implemented Interfaces:

AmazonIVS, AmazonIVSAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonIVSAsyncClient
extends AmazonIVSClient
implements AmazonIVSAsync

Client 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.

Introduction

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

The API is an Amazon Web Services regional service. For a list of supported regions and Amazon IVS HTTPS service endpoints, see the Amazon IVS page in the Amazon Web Services General Reference.

All API request parameters and URLs are case sensitive.

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

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.

• Recording configuration — Stores configuration related to recording a live stream and where to store the recorded content. Multiple channels can reference the same recording configuration. See the Recording Configuration endpoints for more information.

Tagging

A tag is a metadata label that you assign to an Amazon Web Services 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 Amazon Web Services Resources for more information, including restrictions that apply to tags.

Tags can help you identify and organize your Amazon Web Services 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, Playback Key Pairs, and Recording Configurations.

At most 50 tags can be applied to a resource.

Authentication versus Authorization

Note the differences between these concepts:

• Authentication is about verifying identity. You need to be authenticated to sign Amazon IVS API requests.

• Authorization is about granting permissions. You need to be authorized to view Amazon IVS private channels. (Private channels are channels that are enabled for "playback authorization.")

Authentication

All Amazon IVS API requests must be authenticated with a signature. The Amazon Web Services Command-Line Interface (CLI) and Amazon IVS Player SDKs take care of signing the underlying API calls for you. However, if your application calls the Amazon IVS API directly, it’s your responsibility to sign the requests.

You generate a signature using valid Amazon Web Services credentials that have permission to perform the requested action. For example, you must sign PutMetadata requests with a signature generated from an IAM user account that has the ivs:PutMetadata permission.

For more information:

• Authentication and generating signatures — See Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon Web Services General Reference.

• Managing Amazon IVS permissions — See Identity and Access Management on the Security page of the Amazon IVS User Guide.

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 Amazon Web Services region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 Conflict Exception).

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

• GetStreamSession — Gets metadata on a specified stream.

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

• ListStreamSessions — Gets a summary of current and previous streams for a specified channel 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 the active stream of the specified channel. At most 5 requests per second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your data into a single PutMetadata call.) At most 155 requests per second per account are allowed.

PlaybackKeyPair Endpoints

For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

• 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 private channels (channels enabled for playback authorization).

• 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 private 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.

RecordingConfiguration Endpoints

• CreateRecordingConfiguration — Creates a new recording configuration, used to enable recording to Amazon S3.

• GetRecordingConfiguration — Gets the recording-configuration metadata for the specified ARN.

• ListRecordingConfigurations — Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.

• DeleteRecordingConfiguration — Deletes the recording configuration for the specified ARN.

Amazon Web Services Tags Endpoints

• TagResource — Adds or updates tags for the Amazon Web Services resource with the specified ARN.

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

• ListTagsForResource — Gets information about Amazon Web Services tags for the specified ARN.

Field Summary

Fields inherited from class com.amazonaws.services.ivs.AmazonIVSClient

configFactory

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonIVSAsyncClientBuilder	asyncBuilder()
Future<BatchGetChannelResult>	batchGetChannelAsync(BatchGetChannelRequest request) Performs GetChannel on multiple ARNs simultaneously.
Future<BatchGetChannelResult>	batchGetChannelAsync(BatchGetChannelRequest request, AsyncHandler<BatchGetChannelRequest,BatchGetChannelResult> asyncHandler) Performs GetChannel on multiple ARNs simultaneously.
Future<BatchGetStreamKeyResult>	batchGetStreamKeyAsync(BatchGetStreamKeyRequest request) Performs GetStreamKey on multiple ARNs simultaneously.
Future<BatchGetStreamKeyResult>	batchGetStreamKeyAsync(BatchGetStreamKeyRequest request, AsyncHandler<BatchGetStreamKeyRequest,BatchGetStreamKeyResult> asyncHandler) Performs GetStreamKey on multiple ARNs simultaneously.
Future<CreateChannelResult>	createChannelAsync(CreateChannelRequest request) Creates a new channel and an associated stream key to start streaming.
Future<CreateChannelResult>	createChannelAsync(CreateChannelRequest request, AsyncHandler<CreateChannelRequest,CreateChannelResult> asyncHandler) Creates a new channel and an associated stream key to start streaming.
Future<CreateRecordingConfigurationResult>	createRecordingConfigurationAsync(CreateRecordingConfigurationRequest request) Creates a new recording configuration, used to enable recording to Amazon S3.
Future<CreateRecordingConfigurationResult>	createRecordingConfigurationAsync(CreateRecordingConfigurationRequest request, AsyncHandler<CreateRecordingConfigurationRequest,CreateRecordingConfigurationResult> asyncHandler) Creates a new recording configuration, used to enable recording to Amazon S3.
Future<CreateStreamKeyResult>	createStreamKeyAsync(CreateStreamKeyRequest request) Creates a stream key, used to initiate a stream, for the specified channel ARN.
Future<CreateStreamKeyResult>	createStreamKeyAsync(CreateStreamKeyRequest request, AsyncHandler<CreateStreamKeyRequest,CreateStreamKeyResult> asyncHandler) Creates a stream key, used to initiate a stream, for the specified channel ARN.
Future<DeleteChannelResult>	deleteChannelAsync(DeleteChannelRequest request) Deletes the specified channel and its associated stream keys.
Future<DeleteChannelResult>	deleteChannelAsync(DeleteChannelRequest request, AsyncHandler<DeleteChannelRequest,DeleteChannelResult> asyncHandler) Deletes the specified channel and its associated stream keys.
Future<DeletePlaybackKeyPairResult>	deletePlaybackKeyPairAsync(DeletePlaybackKeyPairRequest request) Deletes a specified authorization key pair.
Future<DeletePlaybackKeyPairResult>	deletePlaybackKeyPairAsync(DeletePlaybackKeyPairRequest request, AsyncHandler<DeletePlaybackKeyPairRequest,DeletePlaybackKeyPairResult> asyncHandler) Deletes a specified authorization key pair.
Future<DeleteRecordingConfigurationResult>	deleteRecordingConfigurationAsync(DeleteRecordingConfigurationRequest request) Deletes the recording configuration for the specified ARN.
Future<DeleteRecordingConfigurationResult>	deleteRecordingConfigurationAsync(DeleteRecordingConfigurationRequest request, AsyncHandler<DeleteRecordingConfigurationRequest,DeleteRecordingConfigurationResult> asyncHandler) Deletes the recording configuration for the specified ARN.
Future<DeleteStreamKeyResult>	deleteStreamKeyAsync(DeleteStreamKeyRequest request) Deletes the stream key for the specified ARN, so it can no longer be used to stream.
Future<DeleteStreamKeyResult>	deleteStreamKeyAsync(DeleteStreamKeyRequest request, 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 request) Gets the channel configuration for the specified channel ARN.
Future<GetChannelResult>	getChannelAsync(GetChannelRequest request, AsyncHandler<GetChannelRequest,GetChannelResult> asyncHandler) Gets the channel configuration for the specified channel ARN.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<GetPlaybackKeyPairResult>	getPlaybackKeyPairAsync(GetPlaybackKeyPairRequest request) Gets a specified playback authorization key pair and returns the arn and fingerprint.
Future<GetPlaybackKeyPairResult>	getPlaybackKeyPairAsync(GetPlaybackKeyPairRequest request, AsyncHandler<GetPlaybackKeyPairRequest,GetPlaybackKeyPairResult> asyncHandler) Gets a specified playback authorization key pair and returns the arn and fingerprint.
Future<GetRecordingConfigurationResult>	getRecordingConfigurationAsync(GetRecordingConfigurationRequest request) Gets the recording configuration for the specified ARN.
Future<GetRecordingConfigurationResult>	getRecordingConfigurationAsync(GetRecordingConfigurationRequest request, AsyncHandler<GetRecordingConfigurationRequest,GetRecordingConfigurationResult> asyncHandler) Gets the recording configuration for the specified ARN.
Future<GetStreamResult>	getStreamAsync(GetStreamRequest request) Gets information about the active (live) stream on a specified channel.
Future<GetStreamResult>	getStreamAsync(GetStreamRequest request, AsyncHandler<GetStreamRequest,GetStreamResult> asyncHandler) Gets information about the active (live) stream on a specified channel.
Future<GetStreamKeyResult>	getStreamKeyAsync(GetStreamKeyRequest request) Gets stream-key information for a specified ARN.
Future<GetStreamKeyResult>	getStreamKeyAsync(GetStreamKeyRequest request, AsyncHandler<GetStreamKeyRequest,GetStreamKeyResult> asyncHandler) Gets stream-key information for a specified ARN.
Future<GetStreamSessionResult>	getStreamSessionAsync(GetStreamSessionRequest request) Gets metadata on a specified stream.
Future<GetStreamSessionResult>	getStreamSessionAsync(GetStreamSessionRequest request, AsyncHandler<GetStreamSessionRequest,GetStreamSessionResult> asyncHandler) Gets metadata on a specified stream.
Future<ImportPlaybackKeyPairResult>	importPlaybackKeyPairAsync(ImportPlaybackKeyPairRequest request) Imports the public portion of a new key pair and returns its arn and fingerprint.
Future<ImportPlaybackKeyPairResult>	importPlaybackKeyPairAsync(ImportPlaybackKeyPairRequest request, AsyncHandler<ImportPlaybackKeyPairRequest,ImportPlaybackKeyPairResult> asyncHandler) Imports the public portion of a new key pair and returns its arn and fingerprint.
Future<ListChannelsResult>	listChannelsAsync(ListChannelsRequest request) Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed.
Future<ListChannelsResult>	listChannelsAsync(ListChannelsRequest request, AsyncHandler<ListChannelsRequest,ListChannelsResult> asyncHandler) Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed.
Future<ListPlaybackKeyPairsResult>	listPlaybackKeyPairsAsync(ListPlaybackKeyPairsRequest request) Gets summary information about playback key pairs.
Future<ListPlaybackKeyPairsResult>	listPlaybackKeyPairsAsync(ListPlaybackKeyPairsRequest request, AsyncHandler<ListPlaybackKeyPairsRequest,ListPlaybackKeyPairsResult> asyncHandler) Gets summary information about playback key pairs.
Future<ListRecordingConfigurationsResult>	listRecordingConfigurationsAsync(ListRecordingConfigurationsRequest request) Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.
Future<ListRecordingConfigurationsResult>	listRecordingConfigurationsAsync(ListRecordingConfigurationsRequest request, AsyncHandler<ListRecordingConfigurationsRequest,ListRecordingConfigurationsResult> asyncHandler) Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.
Future<ListStreamKeysResult>	listStreamKeysAsync(ListStreamKeysRequest request) Gets summary information about stream keys for the specified channel.
Future<ListStreamKeysResult>	listStreamKeysAsync(ListStreamKeysRequest request, AsyncHandler<ListStreamKeysRequest,ListStreamKeysResult> asyncHandler) Gets summary information about stream keys for the specified channel.
Future<ListStreamsResult>	listStreamsAsync(ListStreamsRequest request) Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.
Future<ListStreamsResult>	listStreamsAsync(ListStreamsRequest request, AsyncHandler<ListStreamsRequest,ListStreamsResult> asyncHandler) Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.
Future<ListStreamSessionsResult>	listStreamSessionsAsync(ListStreamSessionsRequest request) Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed.
Future<ListStreamSessionsResult>	listStreamSessionsAsync(ListStreamSessionsRequest request, AsyncHandler<ListStreamSessionsRequest,ListStreamSessionsResult> asyncHandler) Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed.
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest request) Gets information about Amazon Web Services tags for the specified ARN.
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler) Gets information about Amazon Web Services tags for the specified ARN.
Future<PutMetadataResult>	putMetadataAsync(PutMetadataRequest request) Inserts metadata into the active stream of the specified channel.
Future<PutMetadataResult>	putMetadataAsync(PutMetadataRequest request, AsyncHandler<PutMetadataRequest,PutMetadataResult> asyncHandler) Inserts metadata into the active stream of the specified channel.
void	shutdown() Shuts down the client, releasing all managed resources.
Future<StopStreamResult>	stopStreamAsync(StopStreamRequest request) Disconnects the incoming RTMPS stream for the specified channel.
Future<StopStreamResult>	stopStreamAsync(StopStreamRequest request, AsyncHandler<StopStreamRequest,StopStreamResult> asyncHandler) Disconnects the incoming RTMPS stream for the specified channel.
Future<TagResourceResult>	tagResourceAsync(TagResourceRequest request) Adds or updates tags for the Amazon Web Services resource with the specified ARN.
Future<TagResourceResult>	tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler) Adds or updates tags for the Amazon Web Services resource with the specified ARN.
Future<UntagResourceResult>	untagResourceAsync(UntagResourceRequest request) Removes tags from the resource with the specified ARN.
Future<UntagResourceResult>	untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler) Removes tags from the resource with the specified ARN.
Future<UpdateChannelResult>	updateChannelAsync(UpdateChannelRequest request) Updates a channel's configuration.
Future<UpdateChannelResult>	updateChannelAsync(UpdateChannelRequest request, AsyncHandler<UpdateChannelRequest,UpdateChannelResult> asyncHandler) Updates a channel's configuration.

Methods inherited from class com.amazonaws.services.ivs.AmazonIVSClient

batchGetChannel, batchGetStreamKey, builder, createChannel, createRecordingConfiguration, createStreamKey, deleteChannel, deletePlaybackKeyPair, deleteRecordingConfiguration, deleteStreamKey, getCachedResponseMetadata, getChannel, getPlaybackKeyPair, getRecordingConfiguration, getStream, getStreamKey, getStreamSession, importPlaybackKeyPair, listChannels, listPlaybackKeyPairs, listRecordingConfigurations, listStreamKeys, listStreams, listStreamSessions, listTagsForResource, putMetadata, stopStream, tagResource, untagResource, updateChannel

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

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

batchGetChannel, batchGetStreamKey, createChannel, createRecordingConfiguration, createStreamKey, deleteChannel, deletePlaybackKeyPair, deleteRecordingConfiguration, deleteStreamKey, getCachedResponseMetadata, getChannel, getPlaybackKeyPair, getRecordingConfiguration, getStream, getStreamKey, getStreamSession, importPlaybackKeyPair, listChannels, listPlaybackKeyPairs, listRecordingConfigurations, listStreamKeys, listStreams, listStreamSessions, listTagsForResource, putMetadata, stopStream, tagResource, untagResource, updateChannel

Method Detail

asyncBuilder

public static AmazonIVSAsyncClientBuilder asyncBuilder()

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

batchGetChannelAsync

public Future<BatchGetChannelResult> batchGetChannelAsync(BatchGetChannelRequest request)

Description copied from interface: AmazonIVSAsync

Performs GetChannel on multiple ARNs simultaneously.

Specified by:

batchGetChannelAsync in interface AmazonIVSAsync

Returns:

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

See Also:

AWS API Documentation

batchGetChannelAsync

public Future<BatchGetChannelResult> batchGetChannelAsync(BatchGetChannelRequest request,
                                                          AsyncHandler<BatchGetChannelRequest,BatchGetChannelResult> asyncHandler)

Description copied from interface: AmazonIVSAsync

Performs GetChannel on multiple ARNs simultaneously.

Specified by:

batchGetChannelAsync in interface AmazonIVSAsync

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

public Future<BatchGetStreamKeyResult> batchGetStreamKeyAsync(BatchGetStreamKeyRequest request)

Description copied from interface: AmazonIVSAsync

Performs GetStreamKey on multiple ARNs simultaneously.

Specified by:

batchGetStreamKeyAsync in interface AmazonIVSAsync

Returns:

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

See Also:

AWS API Documentation

batchGetStreamKeyAsync

public Future<BatchGetStreamKeyResult> batchGetStreamKeyAsync(BatchGetStreamKeyRequest request,
                                                              AsyncHandler<BatchGetStreamKeyRequest,BatchGetStreamKeyResult> asyncHandler)

Description copied from interface: AmazonIVSAsync

Performs GetStreamKey on multiple ARNs simultaneously.

Specified by:

batchGetStreamKeyAsync in interface AmazonIVSAsync

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

public Future<CreateChannelResult> createChannelAsync(CreateChannelRequest request)

Description copied from interface: AmazonIVSAsync

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

Specified by:

createChannelAsync in interface AmazonIVSAsync

Returns:

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

See Also:

AWS API Documentation

createChannelAsync

public Future<CreateChannelResult> createChannelAsync(CreateChannelRequest request,
                                                      AsyncHandler<CreateChannelRequest,CreateChannelResult> asyncHandler)

Description copied from interface: AmazonIVSAsync

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

Specified by:

createChannelAsync in interface AmazonIVSAsync

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

createRecordingConfigurationAsync

public Future<CreateRecordingConfigurationResult> createRecordingConfigurationAsync(CreateRecordingConfigurationRequest request)

Description copied from interface: AmazonIVSAsync

Creates a new recording configuration, used to enable recording to Amazon S3.

Known issue: In the us-east-1 region, if you use the Amazon Web Services CLI to create a recording configuration, it returns success even if the S3 bucket is in a different region. In this case, the state of the recording configuration is CREATE_FAILED (instead of ACTIVE). (In other regions, the CLI correctly returns failure if the bucket is in a different region.)

Workaround: Ensure that your S3 bucket is in the same region as the recording configuration. If you create a recording configuration in a different region as your S3 bucket, delete that recording configuration and create a new one with an S3 bucket from the correct region.

Specified by:

createRecordingConfigurationAsync in interface AmazonIVSAsync

Returns:

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

See Also:

AWS API Documentation

createRecordingConfigurationAsync

public Future<CreateRecordingConfigurationResult> createRecordingConfigurationAsync(CreateRecordingConfigurationRequest request,
                                                                                    AsyncHandler<CreateRecordingConfigurationRequest,CreateRecordingConfigurationResult> asyncHandler)

Description copied from interface: AmazonIVSAsync

Creates a new recording configuration, used to enable recording to Amazon S3.

Known issue: In the us-east-1 region, if you use the Amazon Web Services CLI to create a recording configuration, it returns success even if the S3 bucket is in a different region. In this case, the state of the recording configuration is CREATE_FAILED (instead of ACTIVE). (In other regions, the CLI correctly returns failure if the bucket is in a different region.)

Workaround: Ensure that your S3 bucket is in the same region as the recording configuration. If you create a recording configuration in a different region as your S3 bucket, delete that recording configuration and create a new one with an S3 bucket from the correct region.

Specified by:

createRecordingConfigurationAsync in interface AmazonIVSAsync

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 CreateRecordingConfiguration operation returned by the service.

See Also:

AWS API Documentation

createStreamKeyAsync

public Future<CreateStreamKeyResult> createStreamKeyAsync(CreateStreamKeyRequest request)

Description copied from interface: AmazonIVSAsync

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:

createStreamKeyAsync in interface AmazonIVSAsync

Returns:

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

See Also:

AWS API Documentation

createStreamKeyAsync

public Future<CreateStreamKeyResult> createStreamKeyAsync(CreateStreamKeyRequest request,
                                                          AsyncHandler<CreateStreamKeyRequest,CreateStreamKeyResult> asyncHandler)

Description copied from interface: AmazonIVSAsync

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:

createStreamKeyAsync in interface AmazonIVSAsync

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

public Future<DeleteChannelResult> deleteChannelAsync(DeleteChannelRequest request)

Description copied from interface: AmazonIVSAsync

Deletes the specified channel and its associated stream keys.

If you try to delete a live channel, you will get an error (409 ConflictException). To delete a channel that is live, call StopStream, wait for the Amazon EventBridge "Stream End" event (to verify that the stream's state was changed from Live to Offline), then call DeleteChannel. (See Using EventBridge with Amazon IVS.)

Specified by:

deleteChannelAsync in interface AmazonIVSAsync

Returns:

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

See Also:

AWS API Documentation

deleteChannelAsync

public Future<DeleteChannelResult> deleteChannelAsync(DeleteChannelRequest request,
                                                      AsyncHandler<DeleteChannelRequest,DeleteChannelResult> asyncHandler)

Description copied from interface: AmazonIVSAsync

Deletes the specified channel and its associated stream keys.

If you try to delete a live channel, you will get an error (409 ConflictException). To delete a channel that is live, call StopStream, wait for the Amazon EventBridge "Stream End" event (to verify that the stream's state was changed from Live to Offline), then call DeleteChannel. (See Using EventBridge with Amazon IVS.)

Specified by:

deleteChannelAsync in interface AmazonIVSAsync

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

public Future<DeletePlaybackKeyPairResult> deletePlaybackKeyPairAsync(DeletePlaybackKeyPairRequest request)

Description copied from interface: AmazonIVSAsync

Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s privateKey. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

Specified by:

deletePlaybackKeyPairAsync in interface AmazonIVSAsync

Returns:

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

See Also:

AWS API Documentation

deletePlaybackKeyPairAsync

public Future<DeletePlaybackKeyPairResult> deletePlaybackKeyPairAsync(DeletePlaybackKeyPairRequest request,
                                                                      AsyncHandler<DeletePlaybackKeyPairRequest,DeletePlaybackKeyPairResult> asyncHandler)

Description copied from interface: AmazonIVSAsync

Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s privateKey. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

Specified by:

deletePlaybackKeyPairAsync in interface AmazonIVSAsync

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

deleteRecordingConfigurationAsync

public Future<DeleteRecordingConfigurationResult> deleteRecordingConfigurationAsync(DeleteRecordingConfigurationRequest request)

Description copied from interface: AmazonIVSAsync

Deletes the recording configuration for the specified ARN.

If you try to delete a recording configuration that is associated with a channel, you will get an error (409 ConflictException). To avoid this, for all channels that reference the recording configuration, first use UpdateChannel to set the recordingConfigurationArn field to an empty string, then use DeleteRecordingConfiguration.

Specified by:

deleteRecordingConfigurationAsync in interface AmazonIVSAsync

Returns:

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

See Also:

AWS API Documentation

deleteRecordingConfigurationAsync

public Future<DeleteRecordingConfigurationResult> deleteRecordingConfigurationAsync(DeleteRecordingConfigurationRequest request,
                                                                                    AsyncHandler<DeleteRecordingConfigurationRequest,DeleteRecordingConfigurationResult> asyncHandler)

Description copied from interface: AmazonIVSAsync

Deletes the recording configuration for the specified ARN.

If you try to delete a recording configuration that is associated with a channel, you will get an error (409 ConflictException). To avoid this, for all channels that reference the recording configuration, first use UpdateChannel to set the recordingConfigurationArn field to an empty string, then use DeleteRecordingConfiguration.

Specified by:

deleteRecordingConfigurationAsync in interface AmazonIVSAsync

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 DeleteRecordingConfiguration operation returned by the service.

See Also:

AWS API Documentation

deleteStreamKeyAsync

public Future<DeleteStreamKeyResult> deleteStreamKeyAsync(DeleteStreamKeyRequest request)

Description copied from interface: AmazonIVSAsync

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

Specified by:

deleteStreamKeyAsync in interface AmazonIVSAsync

Returns:

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

See Also:

AWS API Documentation

deleteStreamKeyAsync

public Future<DeleteStreamKeyResult> deleteStreamKeyAsync(DeleteStreamKeyRequest request,
                                                          AsyncHandler<DeleteStreamKeyRequest,DeleteStreamKeyResult> asyncHandler)

Description copied from interface: AmazonIVSAsync

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

Specified by:

deleteStreamKeyAsync in interface AmazonIVSAsync

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

public Future<GetChannelResult> getChannelAsync(GetChannelRequest request)

Description copied from interface: AmazonIVSAsync

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

Specified by:

getChannelAsync in interface AmazonIVSAsync

Returns:

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

See Also:

AWS API Documentation

getChannelAsync

public Future<GetChannelResult> getChannelAsync(GetChannelRequest request,
                                                AsyncHandler<GetChannelRequest,GetChannelResult> asyncHandler)

Description copied from interface: AmazonIVSAsync

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

Specified by:

getChannelAsync in interface AmazonIVSAsync

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

public Future<GetPlaybackKeyPairResult> getPlaybackKeyPairAsync(GetPlaybackKeyPairRequest request)

Description copied from interface: AmazonIVSAsync

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 private channels. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

Specified by:

getPlaybackKeyPairAsync in interface AmazonIVSAsync

Returns:

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

See Also:

AWS API Documentation

getPlaybackKeyPairAsync

public Future<GetPlaybackKeyPairResult> getPlaybackKeyPairAsync(GetPlaybackKeyPairRequest request,
                                                                AsyncHandler<GetPlaybackKeyPairRequest,GetPlaybackKeyPairResult> asyncHandler)

Description copied from interface: AmazonIVSAsync

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 private channels. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

Specified by:

getPlaybackKeyPairAsync in interface AmazonIVSAsync

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

getRecordingConfigurationAsync

public Future<GetRecordingConfigurationResult> getRecordingConfigurationAsync(GetRecordingConfigurationRequest request)

Description copied from interface: AmazonIVSAsync

Gets the recording configuration for the specified ARN.

Specified by:

getRecordingConfigurationAsync in interface AmazonIVSAsync

Returns:

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

See Also:

AWS API Documentation

getRecordingConfigurationAsync

public Future<GetRecordingConfigurationResult> getRecordingConfigurationAsync(GetRecordingConfigurationRequest request,
                                                                              AsyncHandler<GetRecordingConfigurationRequest,GetRecordingConfigurationResult> asyncHandler)

Description copied from interface: AmazonIVSAsync

Gets the recording configuration for the specified ARN.

Specified by:

getRecordingConfigurationAsync in interface AmazonIVSAsync

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 GetRecordingConfiguration operation returned by the service.

See Also:

AWS API Documentation

getStreamAsync

public Future<GetStreamResult> getStreamAsync(GetStreamRequest request)

Description copied from interface: AmazonIVSAsync

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

Specified by:

getStreamAsync in interface AmazonIVSAsync

Returns:

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

See Also:

AWS API Documentation

getStreamAsync

public Future<GetStreamResult> getStreamAsync(GetStreamRequest request,
                                              AsyncHandler<GetStreamRequest,GetStreamResult> asyncHandler)

Description copied from interface: AmazonIVSAsync

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

Specified by:

getStreamAsync in interface AmazonIVSAsync

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

public Future<GetStreamKeyResult> getStreamKeyAsync(GetStreamKeyRequest request)

Description copied from interface: AmazonIVSAsync

Gets stream-key information for a specified ARN.

Specified by:

getStreamKeyAsync in interface AmazonIVSAsync

Returns:

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

See Also:

AWS API Documentation

getStreamKeyAsync

public Future<GetStreamKeyResult> getStreamKeyAsync(GetStreamKeyRequest request,
                                                    AsyncHandler<GetStreamKeyRequest,GetStreamKeyResult> asyncHandler)

Description copied from interface: AmazonIVSAsync

Gets stream-key information for a specified ARN.

Specified by:

getStreamKeyAsync in interface AmazonIVSAsync

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

getStreamSessionAsync

public Future<GetStreamSessionResult> getStreamSessionAsync(GetStreamSessionRequest request)

Description copied from interface: AmazonIVSAsync

Gets metadata on a specified stream.

Specified by:

getStreamSessionAsync in interface AmazonIVSAsync

Returns:

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

See Also:

AWS API Documentation

getStreamSessionAsync

public Future<GetStreamSessionResult> getStreamSessionAsync(GetStreamSessionRequest request,
                                                            AsyncHandler<GetStreamSessionRequest,GetStreamSessionResult> asyncHandler)

Description copied from interface: AmazonIVSAsync

Gets metadata on a specified stream.

Specified by:

getStreamSessionAsync in interface AmazonIVSAsync

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 GetStreamSession operation returned by the service.

See Also:

AWS API Documentation

importPlaybackKeyPairAsync

public Future<ImportPlaybackKeyPairResult> importPlaybackKeyPairAsync(ImportPlaybackKeyPairRequest request)

Description copied from interface: AmazonIVSAsync

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 private channels. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

Specified by:

importPlaybackKeyPairAsync in interface AmazonIVSAsync

Returns:

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

See Also:

AWS API Documentation

importPlaybackKeyPairAsync

public Future<ImportPlaybackKeyPairResult> importPlaybackKeyPairAsync(ImportPlaybackKeyPairRequest request,
                                                                      AsyncHandler<ImportPlaybackKeyPairRequest,ImportPlaybackKeyPairResult> asyncHandler)

Description copied from interface: AmazonIVSAsync

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 private channels. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

Specified by:

importPlaybackKeyPairAsync in interface AmazonIVSAsync

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

public Future<ListChannelsResult> listChannelsAsync(ListChannelsRequest request)

Description copied from interface: AmazonIVSAsync

Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 ConflictException).

Specified by:

listChannelsAsync in interface AmazonIVSAsync

Returns:

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

See Also:

AWS API Documentation

listChannelsAsync

public Future<ListChannelsResult> listChannelsAsync(ListChannelsRequest request,
                                                    AsyncHandler<ListChannelsRequest,ListChannelsResult> asyncHandler)

Description copied from interface: AmazonIVSAsync

Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 ConflictException).

Specified by:

listChannelsAsync in interface AmazonIVSAsync

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

public Future<ListPlaybackKeyPairsResult> listPlaybackKeyPairsAsync(ListPlaybackKeyPairsRequest request)

Description copied from interface: AmazonIVSAsync

Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

Specified by:

listPlaybackKeyPairsAsync in interface AmazonIVSAsync

Returns:

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

See Also:

AWS API Documentation

listPlaybackKeyPairsAsync

public Future<ListPlaybackKeyPairsResult> listPlaybackKeyPairsAsync(ListPlaybackKeyPairsRequest request,
                                                                    AsyncHandler<ListPlaybackKeyPairsRequest,ListPlaybackKeyPairsResult> asyncHandler)

Description copied from interface: AmazonIVSAsync

Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

Specified by:

listPlaybackKeyPairsAsync in interface AmazonIVSAsync

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

listRecordingConfigurationsAsync

public Future<ListRecordingConfigurationsResult> listRecordingConfigurationsAsync(ListRecordingConfigurationsRequest request)

Description copied from interface: AmazonIVSAsync

Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.

Specified by:

listRecordingConfigurationsAsync in interface AmazonIVSAsync

Returns:

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

See Also:

AWS API Documentation

listRecordingConfigurationsAsync

public Future<ListRecordingConfigurationsResult> listRecordingConfigurationsAsync(ListRecordingConfigurationsRequest request,
                                                                                  AsyncHandler<ListRecordingConfigurationsRequest,ListRecordingConfigurationsResult> asyncHandler)

Description copied from interface: AmazonIVSAsync

Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.

Specified by:

listRecordingConfigurationsAsync in interface AmazonIVSAsync

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 ListRecordingConfigurations operation returned by the service.

See Also:

AWS API Documentation

listStreamKeysAsync

public Future<ListStreamKeysResult> listStreamKeysAsync(ListStreamKeysRequest request)

Description copied from interface: AmazonIVSAsync

Gets summary information about stream keys for the specified channel.

Specified by:

listStreamKeysAsync in interface AmazonIVSAsync

Returns:

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

See Also:

AWS API Documentation

listStreamKeysAsync

public Future<ListStreamKeysResult> listStreamKeysAsync(ListStreamKeysRequest request,
                                                        AsyncHandler<ListStreamKeysRequest,ListStreamKeysResult> asyncHandler)

Description copied from interface: AmazonIVSAsync

Gets summary information about stream keys for the specified channel.

Specified by:

listStreamKeysAsync in interface AmazonIVSAsync

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

listStreamSessionsAsync

public Future<ListStreamSessionsResult> listStreamSessionsAsync(ListStreamSessionsRequest request)

Description copied from interface: AmazonIVSAsync

Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed.

Specified by:

listStreamSessionsAsync in interface AmazonIVSAsync

Returns:

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

See Also:

AWS API Documentation

listStreamSessionsAsync

public Future<ListStreamSessionsResult> listStreamSessionsAsync(ListStreamSessionsRequest request,
                                                                AsyncHandler<ListStreamSessionsRequest,ListStreamSessionsResult> asyncHandler)

Description copied from interface: AmazonIVSAsync

Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed.

Specified by:

listStreamSessionsAsync in interface AmazonIVSAsync

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 ListStreamSessions operation returned by the service.

See Also:

AWS API Documentation

listStreamsAsync

public Future<ListStreamsResult> listStreamsAsync(ListStreamsRequest request)

Description copied from interface: AmazonIVSAsync

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

Specified by:

listStreamsAsync in interface AmazonIVSAsync

Returns:

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

See Also:

AWS API Documentation

listStreamsAsync

public Future<ListStreamsResult> listStreamsAsync(ListStreamsRequest request,
                                                  AsyncHandler<ListStreamsRequest,ListStreamsResult> asyncHandler)

Description copied from interface: AmazonIVSAsync

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

Specified by:

listStreamsAsync in interface AmazonIVSAsync

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

public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)

Description copied from interface: AmazonIVSAsync

Gets information about Amazon Web Services tags for the specified ARN.

Specified by:

listTagsForResourceAsync in interface AmazonIVSAsync

Returns:

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

See Also:

AWS API Documentation

listTagsForResourceAsync

public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request,
                                                                  AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)

Description copied from interface: AmazonIVSAsync

Gets information about Amazon Web Services tags for the specified ARN.

Specified by:

listTagsForResourceAsync in interface AmazonIVSAsync

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

public Future<PutMetadataResult> putMetadataAsync(PutMetadataRequest request)

Description copied from interface: AmazonIVSAsync

Inserts metadata into the active stream of the specified channel. At most 5 requests per second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your data into a single PutMetadata call.) At most 155 requests per second per account are allowed. Also see Embedding Metadata within a Video Stream in the Amazon IVS User Guide.

Specified by:

putMetadataAsync in interface AmazonIVSAsync

Returns:

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

See Also:

AWS API Documentation

putMetadataAsync

public Future<PutMetadataResult> putMetadataAsync(PutMetadataRequest request,
                                                  AsyncHandler<PutMetadataRequest,PutMetadataResult> asyncHandler)

Description copied from interface: AmazonIVSAsync

Inserts metadata into the active stream of the specified channel. At most 5 requests per second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your data into a single PutMetadata call.) At most 155 requests per second per account are allowed. Also see Embedding Metadata within a Video Stream in the Amazon IVS User Guide.

Specified by:

putMetadataAsync in interface AmazonIVSAsync

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

public Future<StopStreamResult> stopStreamAsync(StopStreamRequest request)

Description copied from interface: AmazonIVSAsync

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:

stopStreamAsync in interface AmazonIVSAsync

Returns:

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

See Also:

AWS API Documentation

stopStreamAsync

public Future<StopStreamResult> stopStreamAsync(StopStreamRequest request,
                                                AsyncHandler<StopStreamRequest,StopStreamResult> asyncHandler)

Description copied from interface: AmazonIVSAsync

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:

stopStreamAsync in interface AmazonIVSAsync

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

public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)

Description copied from interface: AmazonIVSAsync

Adds or updates tags for the Amazon Web Services resource with the specified ARN.

Specified by:

tagResourceAsync in interface AmazonIVSAsync

Returns:

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

See Also:

AWS API Documentation

tagResourceAsync

public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request,
                                                  AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)

Description copied from interface: AmazonIVSAsync

Adds or updates tags for the Amazon Web Services resource with the specified ARN.

Specified by:

tagResourceAsync in interface AmazonIVSAsync

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

public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)

Description copied from interface: AmazonIVSAsync

Removes tags from the resource with the specified ARN.

Specified by:

untagResourceAsync in interface AmazonIVSAsync

Returns:

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

See Also:

AWS API Documentation

untagResourceAsync

public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request,
                                                      AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)

Description copied from interface: AmazonIVSAsync

Removes tags from the resource with the specified ARN.

Specified by:

untagResourceAsync in interface AmazonIVSAsync

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

public Future<UpdateChannelResult> updateChannelAsync(UpdateChannelRequest request)

Description copied from interface: AmazonIVSAsync

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:

updateChannelAsync in interface AmazonIVSAsync

Returns:

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

See Also:

AWS API Documentation

updateChannelAsync

public Future<UpdateChannelResult> updateChannelAsync(UpdateChannelRequest request,
                                                      AsyncHandler<UpdateChannelRequest,UpdateChannelResult> asyncHandler)

Description copied from interface: AmazonIVSAsync

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:

updateChannelAsync in interface AmazonIVSAsync

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

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AmazonIVS

Overrides:

shutdown in class AmazonIVSClient