@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonIVSRealTimeAsyncClient extends AmazonIVSRealTimeClient implements AmazonIVSRealTimeAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, including errors.
Key Concepts
Stage — A virtual space where participants can exchange video in real time.
Participant token — A token that authenticates a participant when they join a stage.
Participant object — Represents participants (people) in the stage and contains information about them. When a token is created, it includes a participant ID; when a participant uses that token to join a stage, the participant is associated with that participant ID. There is a 1:1 mapping between participant tokens and participants.
For server-side composition:
Composition process — Composites participants of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels). Composition endpoints support this process.
Composition — Controls the look of the outputs, including how participants are positioned in the video.
For more information about your IVS live stream, also see Getting Started with Amazon IVS Real-Time Streaming.
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 and "Tag naming limits and requirements"; Amazon IVS stages
has no service-specific constraints beyond what is documented there.
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 real-time API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Stage.
At most 50 tags can be applied to a resource.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXbuilder, createEncoderConfiguration, createParticipantToken, createStage, createStorageConfiguration, deleteEncoderConfiguration, deletePublicKey, deleteStage, deleteStorageConfiguration, disconnectParticipant, getCachedResponseMetadata, getComposition, getEncoderConfiguration, getParticipant, getPublicKey, getStage, getStageSession, getStorageConfiguration, importPublicKey, listCompositions, listEncoderConfigurations, listParticipantEvents, listParticipants, listPublicKeys, listStages, listStageSessions, listStorageConfigurations, listTagsForResource, startComposition, stopComposition, tagResource, untagResource, updateStageaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcreateEncoderConfiguration, createParticipantToken, createStage, createStorageConfiguration, deleteEncoderConfiguration, deletePublicKey, deleteStage, deleteStorageConfiguration, disconnectParticipant, getCachedResponseMetadata, getComposition, getEncoderConfiguration, getParticipant, getPublicKey, getStage, getStageSession, getStorageConfiguration, importPublicKey, listCompositions, listEncoderConfigurations, listParticipantEvents, listParticipants, listPublicKeys, listStages, listStageSessions, listStorageConfigurations, listTagsForResource, startComposition, stopComposition, tagResource, untagResource, updateStagepublic static AmazonIVSRealTimeAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CreateEncoderConfigurationResult> createEncoderConfigurationAsync(CreateEncoderConfigurationRequest request)
AmazonIVSRealTimeAsyncCreates an EncoderConfiguration object.
createEncoderConfigurationAsync in interface AmazonIVSRealTimeAsyncpublic Future<CreateEncoderConfigurationResult> createEncoderConfigurationAsync(CreateEncoderConfigurationRequest request, AsyncHandler<CreateEncoderConfigurationRequest,CreateEncoderConfigurationResult> asyncHandler)
AmazonIVSRealTimeAsyncCreates an EncoderConfiguration object.
createEncoderConfigurationAsync in interface AmazonIVSRealTimeAsyncasyncHandler - 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.public Future<CreateParticipantTokenResult> createParticipantTokenAsync(CreateParticipantTokenRequest request)
AmazonIVSRealTimeAsyncCreates an additional token for a specified stage. This can be done after stage creation or when tokens expire. Tokens always are scoped to the stage for which they are created.
Encryption keys are owned by Amazon IVS and never used directly by your application.
createParticipantTokenAsync in interface AmazonIVSRealTimeAsyncpublic Future<CreateParticipantTokenResult> createParticipantTokenAsync(CreateParticipantTokenRequest request, AsyncHandler<CreateParticipantTokenRequest,CreateParticipantTokenResult> asyncHandler)
AmazonIVSRealTimeAsyncCreates an additional token for a specified stage. This can be done after stage creation or when tokens expire. Tokens always are scoped to the stage for which they are created.
Encryption keys are owned by Amazon IVS and never used directly by your application.
createParticipantTokenAsync in interface AmazonIVSRealTimeAsyncasyncHandler - 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.public Future<CreateStageResult> createStageAsync(CreateStageRequest request)
AmazonIVSRealTimeAsyncCreates a new stage (and optionally participant tokens).
createStageAsync in interface AmazonIVSRealTimeAsyncpublic Future<CreateStageResult> createStageAsync(CreateStageRequest request, AsyncHandler<CreateStageRequest,CreateStageResult> asyncHandler)
AmazonIVSRealTimeAsyncCreates a new stage (and optionally participant tokens).
createStageAsync in interface AmazonIVSRealTimeAsyncasyncHandler - 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.public Future<CreateStorageConfigurationResult> createStorageConfigurationAsync(CreateStorageConfigurationRequest request)
AmazonIVSRealTimeAsyncCreates a new storage configuration, used to enable recording to Amazon S3. When a StorageConfiguration is created, IVS will modify the S3 bucketPolicy of the provided bucket. This will ensure that IVS has sufficient permissions to write content to the provided bucket.
createStorageConfigurationAsync in interface AmazonIVSRealTimeAsyncpublic Future<CreateStorageConfigurationResult> createStorageConfigurationAsync(CreateStorageConfigurationRequest request, AsyncHandler<CreateStorageConfigurationRequest,CreateStorageConfigurationResult> asyncHandler)
AmazonIVSRealTimeAsyncCreates a new storage configuration, used to enable recording to Amazon S3. When a StorageConfiguration is created, IVS will modify the S3 bucketPolicy of the provided bucket. This will ensure that IVS has sufficient permissions to write content to the provided bucket.
createStorageConfigurationAsync in interface AmazonIVSRealTimeAsyncasyncHandler - 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.public Future<DeleteEncoderConfigurationResult> deleteEncoderConfigurationAsync(DeleteEncoderConfigurationRequest request)
AmazonIVSRealTimeAsyncDeletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.
deleteEncoderConfigurationAsync in interface AmazonIVSRealTimeAsyncpublic Future<DeleteEncoderConfigurationResult> deleteEncoderConfigurationAsync(DeleteEncoderConfigurationRequest request, AsyncHandler<DeleteEncoderConfigurationRequest,DeleteEncoderConfigurationResult> asyncHandler)
AmazonIVSRealTimeAsyncDeletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.
deleteEncoderConfigurationAsync in interface AmazonIVSRealTimeAsyncasyncHandler - 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.public Future<DeletePublicKeyResult> deletePublicKeyAsync(DeletePublicKeyRequest request)
AmazonIVSRealTimeAsyncDeletes the specified public key used to sign stage participant tokens. This invalidates future participant tokens generated using the key pair’s private key.
deletePublicKeyAsync in interface AmazonIVSRealTimeAsyncpublic Future<DeletePublicKeyResult> deletePublicKeyAsync(DeletePublicKeyRequest request, AsyncHandler<DeletePublicKeyRequest,DeletePublicKeyResult> asyncHandler)
AmazonIVSRealTimeAsyncDeletes the specified public key used to sign stage participant tokens. This invalidates future participant tokens generated using the key pair’s private key.
deletePublicKeyAsync in interface AmazonIVSRealTimeAsyncasyncHandler - 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.public Future<DeleteStageResult> deleteStageAsync(DeleteStageRequest request)
AmazonIVSRealTimeAsyncShuts down and deletes the specified stage (disconnecting all participants).
deleteStageAsync in interface AmazonIVSRealTimeAsyncpublic Future<DeleteStageResult> deleteStageAsync(DeleteStageRequest request, AsyncHandler<DeleteStageRequest,DeleteStageResult> asyncHandler)
AmazonIVSRealTimeAsyncShuts down and deletes the specified stage (disconnecting all participants).
deleteStageAsync in interface AmazonIVSRealTimeAsyncasyncHandler - 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.public Future<DeleteStorageConfigurationResult> deleteStorageConfigurationAsync(DeleteStorageConfigurationRequest request)
AmazonIVSRealTimeAsyncDeletes the storage configuration for the specified ARN.
If you try to delete a storage configuration that is used by a Composition, you will get an error (409 ConflictException). To avoid this, for all Compositions that reference the storage configuration, first use StopComposition and wait for it to complete, then use DeleteStorageConfiguration.
deleteStorageConfigurationAsync in interface AmazonIVSRealTimeAsyncpublic Future<DeleteStorageConfigurationResult> deleteStorageConfigurationAsync(DeleteStorageConfigurationRequest request, AsyncHandler<DeleteStorageConfigurationRequest,DeleteStorageConfigurationResult> asyncHandler)
AmazonIVSRealTimeAsyncDeletes the storage configuration for the specified ARN.
If you try to delete a storage configuration that is used by a Composition, you will get an error (409 ConflictException). To avoid this, for all Compositions that reference the storage configuration, first use StopComposition and wait for it to complete, then use DeleteStorageConfiguration.
deleteStorageConfigurationAsync in interface AmazonIVSRealTimeAsyncasyncHandler - 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.public Future<DisconnectParticipantResult> disconnectParticipantAsync(DisconnectParticipantRequest request)
AmazonIVSRealTimeAsyncDisconnects a specified participant and revokes the participant permanently from a specified stage.
disconnectParticipantAsync in interface AmazonIVSRealTimeAsyncpublic Future<DisconnectParticipantResult> disconnectParticipantAsync(DisconnectParticipantRequest request, AsyncHandler<DisconnectParticipantRequest,DisconnectParticipantResult> asyncHandler)
AmazonIVSRealTimeAsyncDisconnects a specified participant and revokes the participant permanently from a specified stage.
disconnectParticipantAsync in interface AmazonIVSRealTimeAsyncasyncHandler - 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.public Future<GetCompositionResult> getCompositionAsync(GetCompositionRequest request)
AmazonIVSRealTimeAsyncGet information about the specified Composition resource.
getCompositionAsync in interface AmazonIVSRealTimeAsyncpublic Future<GetCompositionResult> getCompositionAsync(GetCompositionRequest request, AsyncHandler<GetCompositionRequest,GetCompositionResult> asyncHandler)
AmazonIVSRealTimeAsyncGet information about the specified Composition resource.
getCompositionAsync in interface AmazonIVSRealTimeAsyncasyncHandler - 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.public Future<GetEncoderConfigurationResult> getEncoderConfigurationAsync(GetEncoderConfigurationRequest request)
AmazonIVSRealTimeAsyncGets information about the specified EncoderConfiguration resource.
getEncoderConfigurationAsync in interface AmazonIVSRealTimeAsyncpublic Future<GetEncoderConfigurationResult> getEncoderConfigurationAsync(GetEncoderConfigurationRequest request, AsyncHandler<GetEncoderConfigurationRequest,GetEncoderConfigurationResult> asyncHandler)
AmazonIVSRealTimeAsyncGets information about the specified EncoderConfiguration resource.
getEncoderConfigurationAsync in interface AmazonIVSRealTimeAsyncasyncHandler - 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.public Future<GetParticipantResult> getParticipantAsync(GetParticipantRequest request)
AmazonIVSRealTimeAsyncGets information about the specified participant token.
getParticipantAsync in interface AmazonIVSRealTimeAsyncpublic Future<GetParticipantResult> getParticipantAsync(GetParticipantRequest request, AsyncHandler<GetParticipantRequest,GetParticipantResult> asyncHandler)
AmazonIVSRealTimeAsyncGets information about the specified participant token.
getParticipantAsync in interface AmazonIVSRealTimeAsyncasyncHandler - 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.public Future<GetPublicKeyResult> getPublicKeyAsync(GetPublicKeyRequest request)
AmazonIVSRealTimeAsyncGets information for the specified public key.
getPublicKeyAsync in interface AmazonIVSRealTimeAsyncpublic Future<GetPublicKeyResult> getPublicKeyAsync(GetPublicKeyRequest request, AsyncHandler<GetPublicKeyRequest,GetPublicKeyResult> asyncHandler)
AmazonIVSRealTimeAsyncGets information for the specified public key.
getPublicKeyAsync in interface AmazonIVSRealTimeAsyncasyncHandler - 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.public Future<GetStageResult> getStageAsync(GetStageRequest request)
AmazonIVSRealTimeAsyncGets information for the specified stage.
getStageAsync in interface AmazonIVSRealTimeAsyncpublic Future<GetStageResult> getStageAsync(GetStageRequest request, AsyncHandler<GetStageRequest,GetStageResult> asyncHandler)
AmazonIVSRealTimeAsyncGets information for the specified stage.
getStageAsync in interface AmazonIVSRealTimeAsyncasyncHandler - 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.public Future<GetStageSessionResult> getStageSessionAsync(GetStageSessionRequest request)
AmazonIVSRealTimeAsyncGets information for the specified stage session.
getStageSessionAsync in interface AmazonIVSRealTimeAsyncpublic Future<GetStageSessionResult> getStageSessionAsync(GetStageSessionRequest request, AsyncHandler<GetStageSessionRequest,GetStageSessionResult> asyncHandler)
AmazonIVSRealTimeAsyncGets information for the specified stage session.
getStageSessionAsync in interface AmazonIVSRealTimeAsyncasyncHandler - 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.public Future<GetStorageConfigurationResult> getStorageConfigurationAsync(GetStorageConfigurationRequest request)
AmazonIVSRealTimeAsyncGets the storage configuration for the specified ARN.
getStorageConfigurationAsync in interface AmazonIVSRealTimeAsyncpublic Future<GetStorageConfigurationResult> getStorageConfigurationAsync(GetStorageConfigurationRequest request, AsyncHandler<GetStorageConfigurationRequest,GetStorageConfigurationResult> asyncHandler)
AmazonIVSRealTimeAsyncGets the storage configuration for the specified ARN.
getStorageConfigurationAsync in interface AmazonIVSRealTimeAsyncasyncHandler - 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.public Future<ImportPublicKeyResult> importPublicKeyAsync(ImportPublicKeyRequest request)
AmazonIVSRealTimeAsyncImport a public key to be used for signing stage participant tokens.
importPublicKeyAsync in interface AmazonIVSRealTimeAsyncpublic Future<ImportPublicKeyResult> importPublicKeyAsync(ImportPublicKeyRequest request, AsyncHandler<ImportPublicKeyRequest,ImportPublicKeyResult> asyncHandler)
AmazonIVSRealTimeAsyncImport a public key to be used for signing stage participant tokens.
importPublicKeyAsync in interface AmazonIVSRealTimeAsyncasyncHandler - 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.public Future<ListCompositionsResult> listCompositionsAsync(ListCompositionsRequest request)
AmazonIVSRealTimeAsyncGets summary information about all Compositions in your account, in the AWS region where the API request is processed.
listCompositionsAsync in interface AmazonIVSRealTimeAsyncpublic Future<ListCompositionsResult> listCompositionsAsync(ListCompositionsRequest request, AsyncHandler<ListCompositionsRequest,ListCompositionsResult> asyncHandler)
AmazonIVSRealTimeAsyncGets summary information about all Compositions in your account, in the AWS region where the API request is processed.
listCompositionsAsync in interface AmazonIVSRealTimeAsyncasyncHandler - 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.public Future<ListEncoderConfigurationsResult> listEncoderConfigurationsAsync(ListEncoderConfigurationsRequest request)
AmazonIVSRealTimeAsyncGets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.
listEncoderConfigurationsAsync in interface AmazonIVSRealTimeAsyncpublic Future<ListEncoderConfigurationsResult> listEncoderConfigurationsAsync(ListEncoderConfigurationsRequest request, AsyncHandler<ListEncoderConfigurationsRequest,ListEncoderConfigurationsResult> asyncHandler)
AmazonIVSRealTimeAsyncGets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.
listEncoderConfigurationsAsync in interface AmazonIVSRealTimeAsyncasyncHandler - 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.public Future<ListParticipantEventsResult> listParticipantEventsAsync(ListParticipantEventsRequest request)
AmazonIVSRealTimeAsyncLists events for a specified participant that occurred during a specified stage session.
listParticipantEventsAsync in interface AmazonIVSRealTimeAsyncpublic Future<ListParticipantEventsResult> listParticipantEventsAsync(ListParticipantEventsRequest request, AsyncHandler<ListParticipantEventsRequest,ListParticipantEventsResult> asyncHandler)
AmazonIVSRealTimeAsyncLists events for a specified participant that occurred during a specified stage session.
listParticipantEventsAsync in interface AmazonIVSRealTimeAsyncasyncHandler - 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.public Future<ListParticipantsResult> listParticipantsAsync(ListParticipantsRequest request)
AmazonIVSRealTimeAsyncLists all participants in a specified stage session.
listParticipantsAsync in interface AmazonIVSRealTimeAsyncpublic Future<ListParticipantsResult> listParticipantsAsync(ListParticipantsRequest request, AsyncHandler<ListParticipantsRequest,ListParticipantsResult> asyncHandler)
AmazonIVSRealTimeAsyncLists all participants in a specified stage session.
listParticipantsAsync in interface AmazonIVSRealTimeAsyncasyncHandler - 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.public Future<ListPublicKeysResult> listPublicKeysAsync(ListPublicKeysRequest request)
AmazonIVSRealTimeAsyncGets summary information about all public keys in your account, in the AWS region where the API request is processed.
listPublicKeysAsync in interface AmazonIVSRealTimeAsyncpublic Future<ListPublicKeysResult> listPublicKeysAsync(ListPublicKeysRequest request, AsyncHandler<ListPublicKeysRequest,ListPublicKeysResult> asyncHandler)
AmazonIVSRealTimeAsyncGets summary information about all public keys in your account, in the AWS region where the API request is processed.
listPublicKeysAsync in interface AmazonIVSRealTimeAsyncasyncHandler - 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.public Future<ListStageSessionsResult> listStageSessionsAsync(ListStageSessionsRequest request)
AmazonIVSRealTimeAsyncGets all sessions for a specified stage.
listStageSessionsAsync in interface AmazonIVSRealTimeAsyncpublic Future<ListStageSessionsResult> listStageSessionsAsync(ListStageSessionsRequest request, AsyncHandler<ListStageSessionsRequest,ListStageSessionsResult> asyncHandler)
AmazonIVSRealTimeAsyncGets all sessions for a specified stage.
listStageSessionsAsync in interface AmazonIVSRealTimeAsyncasyncHandler - 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.public Future<ListStagesResult> listStagesAsync(ListStagesRequest request)
AmazonIVSRealTimeAsyncGets summary information about all stages in your account, in the AWS region where the API request is processed.
listStagesAsync in interface AmazonIVSRealTimeAsyncpublic Future<ListStagesResult> listStagesAsync(ListStagesRequest request, AsyncHandler<ListStagesRequest,ListStagesResult> asyncHandler)
AmazonIVSRealTimeAsyncGets summary information about all stages in your account, in the AWS region where the API request is processed.
listStagesAsync in interface AmazonIVSRealTimeAsyncasyncHandler - 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.public Future<ListStorageConfigurationsResult> listStorageConfigurationsAsync(ListStorageConfigurationsRequest request)
AmazonIVSRealTimeAsyncGets summary information about all storage configurations in your account, in the AWS region where the API request is processed.
listStorageConfigurationsAsync in interface AmazonIVSRealTimeAsyncpublic Future<ListStorageConfigurationsResult> listStorageConfigurationsAsync(ListStorageConfigurationsRequest request, AsyncHandler<ListStorageConfigurationsRequest,ListStorageConfigurationsResult> asyncHandler)
AmazonIVSRealTimeAsyncGets summary information about all storage configurations in your account, in the AWS region where the API request is processed.
listStorageConfigurationsAsync in interface AmazonIVSRealTimeAsyncasyncHandler - 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.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonIVSRealTimeAsyncGets information about AWS tags for the specified ARN.
listTagsForResourceAsync in interface AmazonIVSRealTimeAsyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonIVSRealTimeAsyncGets information about AWS tags for the specified ARN.
listTagsForResourceAsync in interface AmazonIVSRealTimeAsyncasyncHandler - 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.public Future<StartCompositionResult> startCompositionAsync(StartCompositionRequest request)
AmazonIVSRealTimeAsyncStarts a Composition from a stage based on the configuration provided in the request.
A Composition is an ephemeral resource that exists after this endpoint returns successfully. Composition stops and the resource is deleted:
When StopComposition is called.
After a 1-minute timeout, when all participants are disconnected from the stage.
After a 1-minute timeout, if there are no participants in the stage when StartComposition is called.
When broadcasting to the IVS channel fails and all retries are exhausted.
When broadcasting is disconnected and all attempts to reconnect are exhausted.
startCompositionAsync in interface AmazonIVSRealTimeAsyncpublic Future<StartCompositionResult> startCompositionAsync(StartCompositionRequest request, AsyncHandler<StartCompositionRequest,StartCompositionResult> asyncHandler)
AmazonIVSRealTimeAsyncStarts a Composition from a stage based on the configuration provided in the request.
A Composition is an ephemeral resource that exists after this endpoint returns successfully. Composition stops and the resource is deleted:
When StopComposition is called.
After a 1-minute timeout, when all participants are disconnected from the stage.
After a 1-minute timeout, if there are no participants in the stage when StartComposition is called.
When broadcasting to the IVS channel fails and all retries are exhausted.
When broadcasting is disconnected and all attempts to reconnect are exhausted.
startCompositionAsync in interface AmazonIVSRealTimeAsyncasyncHandler - 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.public Future<StopCompositionResult> stopCompositionAsync(StopCompositionRequest request)
AmazonIVSRealTimeAsyncStops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.
stopCompositionAsync in interface AmazonIVSRealTimeAsyncpublic Future<StopCompositionResult> stopCompositionAsync(StopCompositionRequest request, AsyncHandler<StopCompositionRequest,StopCompositionResult> asyncHandler)
AmazonIVSRealTimeAsyncStops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.
stopCompositionAsync in interface AmazonIVSRealTimeAsyncasyncHandler - 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.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AmazonIVSRealTimeAsyncAdds or updates tags for the AWS resource with the specified ARN.
tagResourceAsync in interface AmazonIVSRealTimeAsyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonIVSRealTimeAsyncAdds or updates tags for the AWS resource with the specified ARN.
tagResourceAsync in interface AmazonIVSRealTimeAsyncasyncHandler - 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.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AmazonIVSRealTimeAsyncRemoves tags from the resource with the specified ARN.
untagResourceAsync in interface AmazonIVSRealTimeAsyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonIVSRealTimeAsyncRemoves tags from the resource with the specified ARN.
untagResourceAsync in interface AmazonIVSRealTimeAsyncasyncHandler - 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.public Future<UpdateStageResult> updateStageAsync(UpdateStageRequest request)
AmazonIVSRealTimeAsyncUpdates a stage’s configuration.
updateStageAsync in interface AmazonIVSRealTimeAsyncpublic Future<UpdateStageResult> updateStageAsync(UpdateStageRequest request, AsyncHandler<UpdateStageRequest,UpdateStageResult> asyncHandler)
AmazonIVSRealTimeAsyncUpdates a stage’s configuration.
updateStageAsync in interface AmazonIVSRealTimeAsyncasyncHandler - 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.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AmazonIVSRealTimeshutdown in class AmazonIVSRealTimeClient