@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonIVSRealTimeAsync extends AmazonIVSRealTime
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonIVSRealTimeAsync
instead.
Introduction
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.
Terminology:
A stage is a virtual space where participants can exchange video in real time.
A participant token is a token that authenticates a participant when they join a stage.
A 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.
Server-side composition: The 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.
Server-side composition: A composition controls the look of the outputs, including how participants are positioned in the video.
Resources
The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS Real-Time Streaming):
Stage — A stage is a virtual space where participants can exchange video in real time.
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.
Stages Endpoints
CreateParticipantToken — Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire.
CreateStage — Creates a new stage (and optionally participant tokens).
DeleteStage — Shuts down and deletes the specified stage (disconnecting all participants).
DisconnectParticipant — Disconnects a specified participant and revokes the participant permanently from a specified stage.
GetParticipant — Gets information about the specified participant token.
GetStage — Gets information for the specified stage.
GetStageSession — Gets information for the specified stage session.
ListParticipantEvents — Lists events for a specified participant that occurred during a specified stage session.
ListParticipants — Lists all participants in a specified stage session.
ListStages — Gets summary information about all stages in your account, in the AWS region where the API request is processed.
ListStageSessions — Gets all sessions for a specified stage.
UpdateStage — Updates a stage’s configuration.
Composition Endpoints
GetComposition — Gets information about the specified Composition resource.
ListCompositions — Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.
StartComposition — Starts a Composition from a stage based on the configuration provided in the request.
StopComposition — Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.
EncoderConfiguration Endpoints
CreateEncoderConfiguration — Creates an EncoderConfiguration object.
DeleteEncoderConfiguration — Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.
GetEncoderConfiguration — Gets information about the specified EncoderConfiguration resource.
ListEncoderConfigurations — Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.
StorageConfiguration Endpoints
CreateStorageConfiguration — Creates a new storage configuration, used to enable recording to Amazon S3.
DeleteStorageConfiguration — Deletes the storage configuration for the specified ARN.
GetStorageConfiguration — Gets the storage configuration for the specified ARN.
ListStorageConfigurations — Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.
Tags Endpoints
ListTagsForResource — Gets information about AWS tags for the specified ARN.
TagResource — Adds or updates tags for the AWS resource with the specified ARN.
UntagResource — Removes tags from the resource with the specified ARN.
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
Future<CreateEncoderConfigurationResult> |
createEncoderConfigurationAsync(CreateEncoderConfigurationRequest createEncoderConfigurationRequest)
Creates an EncoderConfiguration object.
|
Future<CreateEncoderConfigurationResult> |
createEncoderConfigurationAsync(CreateEncoderConfigurationRequest createEncoderConfigurationRequest,
AsyncHandler<CreateEncoderConfigurationRequest,CreateEncoderConfigurationResult> asyncHandler)
Creates an EncoderConfiguration object.
|
Future<CreateParticipantTokenResult> |
createParticipantTokenAsync(CreateParticipantTokenRequest createParticipantTokenRequest)
Creates an additional token for a specified stage.
|
Future<CreateParticipantTokenResult> |
createParticipantTokenAsync(CreateParticipantTokenRequest createParticipantTokenRequest,
AsyncHandler<CreateParticipantTokenRequest,CreateParticipantTokenResult> asyncHandler)
Creates an additional token for a specified stage.
|
Future<CreateStageResult> |
createStageAsync(CreateStageRequest createStageRequest)
Creates a new stage (and optionally participant tokens).
|
Future<CreateStageResult> |
createStageAsync(CreateStageRequest createStageRequest,
AsyncHandler<CreateStageRequest,CreateStageResult> asyncHandler)
Creates a new stage (and optionally participant tokens).
|
Future<CreateStorageConfigurationResult> |
createStorageConfigurationAsync(CreateStorageConfigurationRequest createStorageConfigurationRequest)
Creates a new storage configuration, used to enable recording to Amazon S3.
|
Future<CreateStorageConfigurationResult> |
createStorageConfigurationAsync(CreateStorageConfigurationRequest createStorageConfigurationRequest,
AsyncHandler<CreateStorageConfigurationRequest,CreateStorageConfigurationResult> asyncHandler)
Creates a new storage configuration, used to enable recording to Amazon S3.
|
Future<DeleteEncoderConfigurationResult> |
deleteEncoderConfigurationAsync(DeleteEncoderConfigurationRequest deleteEncoderConfigurationRequest)
Deletes an EncoderConfiguration resource.
|
Future<DeleteEncoderConfigurationResult> |
deleteEncoderConfigurationAsync(DeleteEncoderConfigurationRequest deleteEncoderConfigurationRequest,
AsyncHandler<DeleteEncoderConfigurationRequest,DeleteEncoderConfigurationResult> asyncHandler)
Deletes an EncoderConfiguration resource.
|
Future<DeleteStageResult> |
deleteStageAsync(DeleteStageRequest deleteStageRequest)
Shuts down and deletes the specified stage (disconnecting all participants).
|
Future<DeleteStageResult> |
deleteStageAsync(DeleteStageRequest deleteStageRequest,
AsyncHandler<DeleteStageRequest,DeleteStageResult> asyncHandler)
Shuts down and deletes the specified stage (disconnecting all participants).
|
Future<DeleteStorageConfigurationResult> |
deleteStorageConfigurationAsync(DeleteStorageConfigurationRequest deleteStorageConfigurationRequest)
Deletes the storage configuration for the specified ARN.
|
Future<DeleteStorageConfigurationResult> |
deleteStorageConfigurationAsync(DeleteStorageConfigurationRequest deleteStorageConfigurationRequest,
AsyncHandler<DeleteStorageConfigurationRequest,DeleteStorageConfigurationResult> asyncHandler)
Deletes the storage configuration for the specified ARN.
|
Future<DisconnectParticipantResult> |
disconnectParticipantAsync(DisconnectParticipantRequest disconnectParticipantRequest)
Disconnects a specified participant and revokes the participant permanently from a specified stage.
|
Future<DisconnectParticipantResult> |
disconnectParticipantAsync(DisconnectParticipantRequest disconnectParticipantRequest,
AsyncHandler<DisconnectParticipantRequest,DisconnectParticipantResult> asyncHandler)
Disconnects a specified participant and revokes the participant permanently from a specified stage.
|
Future<GetCompositionResult> |
getCompositionAsync(GetCompositionRequest getCompositionRequest)
Get information about the specified Composition resource.
|
Future<GetCompositionResult> |
getCompositionAsync(GetCompositionRequest getCompositionRequest,
AsyncHandler<GetCompositionRequest,GetCompositionResult> asyncHandler)
Get information about the specified Composition resource.
|
Future<GetEncoderConfigurationResult> |
getEncoderConfigurationAsync(GetEncoderConfigurationRequest getEncoderConfigurationRequest)
Gets information about the specified EncoderConfiguration resource.
|
Future<GetEncoderConfigurationResult> |
getEncoderConfigurationAsync(GetEncoderConfigurationRequest getEncoderConfigurationRequest,
AsyncHandler<GetEncoderConfigurationRequest,GetEncoderConfigurationResult> asyncHandler)
Gets information about the specified EncoderConfiguration resource.
|
Future<GetParticipantResult> |
getParticipantAsync(GetParticipantRequest getParticipantRequest)
Gets information about the specified participant token.
|
Future<GetParticipantResult> |
getParticipantAsync(GetParticipantRequest getParticipantRequest,
AsyncHandler<GetParticipantRequest,GetParticipantResult> asyncHandler)
Gets information about the specified participant token.
|
Future<GetStageResult> |
getStageAsync(GetStageRequest getStageRequest)
Gets information for the specified stage.
|
Future<GetStageResult> |
getStageAsync(GetStageRequest getStageRequest,
AsyncHandler<GetStageRequest,GetStageResult> asyncHandler)
Gets information for the specified stage.
|
Future<GetStageSessionResult> |
getStageSessionAsync(GetStageSessionRequest getStageSessionRequest)
Gets information for the specified stage session.
|
Future<GetStageSessionResult> |
getStageSessionAsync(GetStageSessionRequest getStageSessionRequest,
AsyncHandler<GetStageSessionRequest,GetStageSessionResult> asyncHandler)
Gets information for the specified stage session.
|
Future<GetStorageConfigurationResult> |
getStorageConfigurationAsync(GetStorageConfigurationRequest getStorageConfigurationRequest)
Gets the storage configuration for the specified ARN.
|
Future<GetStorageConfigurationResult> |
getStorageConfigurationAsync(GetStorageConfigurationRequest getStorageConfigurationRequest,
AsyncHandler<GetStorageConfigurationRequest,GetStorageConfigurationResult> asyncHandler)
Gets the storage configuration for the specified ARN.
|
Future<ListCompositionsResult> |
listCompositionsAsync(ListCompositionsRequest listCompositionsRequest)
Gets summary information about all Compositions in your account, in the AWS region where the API request is
processed.
|
Future<ListCompositionsResult> |
listCompositionsAsync(ListCompositionsRequest listCompositionsRequest,
AsyncHandler<ListCompositionsRequest,ListCompositionsResult> asyncHandler)
Gets summary information about all Compositions in your account, in the AWS region where the API request is
processed.
|
Future<ListEncoderConfigurationsResult> |
listEncoderConfigurationsAsync(ListEncoderConfigurationsRequest listEncoderConfigurationsRequest)
Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request
is processed.
|
Future<ListEncoderConfigurationsResult> |
listEncoderConfigurationsAsync(ListEncoderConfigurationsRequest listEncoderConfigurationsRequest,
AsyncHandler<ListEncoderConfigurationsRequest,ListEncoderConfigurationsResult> asyncHandler)
Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request
is processed.
|
Future<ListParticipantEventsResult> |
listParticipantEventsAsync(ListParticipantEventsRequest listParticipantEventsRequest)
Lists events for a specified participant that occurred during a specified stage session.
|
Future<ListParticipantEventsResult> |
listParticipantEventsAsync(ListParticipantEventsRequest listParticipantEventsRequest,
AsyncHandler<ListParticipantEventsRequest,ListParticipantEventsResult> asyncHandler)
Lists events for a specified participant that occurred during a specified stage session.
|
Future<ListParticipantsResult> |
listParticipantsAsync(ListParticipantsRequest listParticipantsRequest)
Lists all participants in a specified stage session.
|
Future<ListParticipantsResult> |
listParticipantsAsync(ListParticipantsRequest listParticipantsRequest,
AsyncHandler<ListParticipantsRequest,ListParticipantsResult> asyncHandler)
Lists all participants in a specified stage session.
|
Future<ListStagesResult> |
listStagesAsync(ListStagesRequest listStagesRequest)
Gets summary information about all stages in your account, in the AWS region where the API request is processed.
|
Future<ListStagesResult> |
listStagesAsync(ListStagesRequest listStagesRequest,
AsyncHandler<ListStagesRequest,ListStagesResult> asyncHandler)
Gets summary information about all stages in your account, in the AWS region where the API request is processed.
|
Future<ListStageSessionsResult> |
listStageSessionsAsync(ListStageSessionsRequest listStageSessionsRequest)
Gets all sessions for a specified stage.
|
Future<ListStageSessionsResult> |
listStageSessionsAsync(ListStageSessionsRequest listStageSessionsRequest,
AsyncHandler<ListStageSessionsRequest,ListStageSessionsResult> asyncHandler)
Gets all sessions for a specified stage.
|
Future<ListStorageConfigurationsResult> |
listStorageConfigurationsAsync(ListStorageConfigurationsRequest listStorageConfigurationsRequest)
Gets summary information about all storage configurations in your account, in the AWS region where the API
request is processed.
|
Future<ListStorageConfigurationsResult> |
listStorageConfigurationsAsync(ListStorageConfigurationsRequest listStorageConfigurationsRequest,
AsyncHandler<ListStorageConfigurationsRequest,ListStorageConfigurationsResult> asyncHandler)
Gets summary information about all storage configurations in your account, in the AWS region where the API
request is processed.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Gets information about AWS tags for the specified ARN.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Gets information about AWS tags for the specified ARN.
|
Future<StartCompositionResult> |
startCompositionAsync(StartCompositionRequest startCompositionRequest)
Starts a Composition from a stage based on the configuration provided in the request.
|
Future<StartCompositionResult> |
startCompositionAsync(StartCompositionRequest startCompositionRequest,
AsyncHandler<StartCompositionRequest,StartCompositionResult> asyncHandler)
Starts a Composition from a stage based on the configuration provided in the request.
|
Future<StopCompositionResult> |
stopCompositionAsync(StopCompositionRequest stopCompositionRequest)
Stops and deletes a Composition resource.
|
Future<StopCompositionResult> |
stopCompositionAsync(StopCompositionRequest stopCompositionRequest,
AsyncHandler<StopCompositionRequest,StopCompositionResult> asyncHandler)
Stops and deletes a Composition resource.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest)
Adds or updates tags for the AWS resource with the specified ARN.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest,
AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Adds or updates tags for the AWS resource with the specified ARN.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes tags from the resource with the specified ARN.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest,
AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes tags from the resource with the specified ARN.
|
Future<UpdateStageResult> |
updateStageAsync(UpdateStageRequest updateStageRequest)
Updates a stage’s configuration.
|
Future<UpdateStageResult> |
updateStageAsync(UpdateStageRequest updateStageRequest,
AsyncHandler<UpdateStageRequest,UpdateStageResult> asyncHandler)
Updates a stage’s configuration.
|
createEncoderConfiguration, createParticipantToken, createStage, createStorageConfiguration, deleteEncoderConfiguration, deleteStage, deleteStorageConfiguration, disconnectParticipant, getCachedResponseMetadata, getComposition, getEncoderConfiguration, getParticipant, getStage, getStageSession, getStorageConfiguration, listCompositions, listEncoderConfigurations, listParticipantEvents, listParticipants, listStages, listStageSessions, listStorageConfigurations, listTagsForResource, shutdown, startComposition, stopComposition, tagResource, untagResource, updateStage
Future<CreateEncoderConfigurationResult> createEncoderConfigurationAsync(CreateEncoderConfigurationRequest createEncoderConfigurationRequest)
Creates an EncoderConfiguration object.
createEncoderConfigurationRequest
- Future<CreateEncoderConfigurationResult> createEncoderConfigurationAsync(CreateEncoderConfigurationRequest createEncoderConfigurationRequest, AsyncHandler<CreateEncoderConfigurationRequest,CreateEncoderConfigurationResult> asyncHandler)
Creates an EncoderConfiguration object.
createEncoderConfigurationRequest
- 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.Future<CreateParticipantTokenResult> createParticipantTokenAsync(CreateParticipantTokenRequest createParticipantTokenRequest)
Creates 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.
createParticipantTokenRequest
- Future<CreateParticipantTokenResult> createParticipantTokenAsync(CreateParticipantTokenRequest createParticipantTokenRequest, AsyncHandler<CreateParticipantTokenRequest,CreateParticipantTokenResult> asyncHandler)
Creates 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.
createParticipantTokenRequest
- 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.Future<CreateStageResult> createStageAsync(CreateStageRequest createStageRequest)
Creates a new stage (and optionally participant tokens).
createStageRequest
- Future<CreateStageResult> createStageAsync(CreateStageRequest createStageRequest, AsyncHandler<CreateStageRequest,CreateStageResult> asyncHandler)
Creates a new stage (and optionally participant tokens).
createStageRequest
- 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.Future<CreateStorageConfigurationResult> createStorageConfigurationAsync(CreateStorageConfigurationRequest createStorageConfigurationRequest)
Creates 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.
createStorageConfigurationRequest
- Future<CreateStorageConfigurationResult> createStorageConfigurationAsync(CreateStorageConfigurationRequest createStorageConfigurationRequest, AsyncHandler<CreateStorageConfigurationRequest,CreateStorageConfigurationResult> asyncHandler)
Creates 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.
createStorageConfigurationRequest
- 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.Future<DeleteEncoderConfigurationResult> deleteEncoderConfigurationAsync(DeleteEncoderConfigurationRequest deleteEncoderConfigurationRequest)
Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.
deleteEncoderConfigurationRequest
- Future<DeleteEncoderConfigurationResult> deleteEncoderConfigurationAsync(DeleteEncoderConfigurationRequest deleteEncoderConfigurationRequest, AsyncHandler<DeleteEncoderConfigurationRequest,DeleteEncoderConfigurationResult> asyncHandler)
Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.
deleteEncoderConfigurationRequest
- 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.Future<DeleteStageResult> deleteStageAsync(DeleteStageRequest deleteStageRequest)
Shuts down and deletes the specified stage (disconnecting all participants).
deleteStageRequest
- Future<DeleteStageResult> deleteStageAsync(DeleteStageRequest deleteStageRequest, AsyncHandler<DeleteStageRequest,DeleteStageResult> asyncHandler)
Shuts down and deletes the specified stage (disconnecting all participants).
deleteStageRequest
- 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.Future<DeleteStorageConfigurationResult> deleteStorageConfigurationAsync(DeleteStorageConfigurationRequest deleteStorageConfigurationRequest)
Deletes 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.
deleteStorageConfigurationRequest
- Future<DeleteStorageConfigurationResult> deleteStorageConfigurationAsync(DeleteStorageConfigurationRequest deleteStorageConfigurationRequest, AsyncHandler<DeleteStorageConfigurationRequest,DeleteStorageConfigurationResult> asyncHandler)
Deletes 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.
deleteStorageConfigurationRequest
- 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.Future<DisconnectParticipantResult> disconnectParticipantAsync(DisconnectParticipantRequest disconnectParticipantRequest)
Disconnects a specified participant and revokes the participant permanently from a specified stage.
disconnectParticipantRequest
- Future<DisconnectParticipantResult> disconnectParticipantAsync(DisconnectParticipantRequest disconnectParticipantRequest, AsyncHandler<DisconnectParticipantRequest,DisconnectParticipantResult> asyncHandler)
Disconnects a specified participant and revokes the participant permanently from a specified stage.
disconnectParticipantRequest
- 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.Future<GetCompositionResult> getCompositionAsync(GetCompositionRequest getCompositionRequest)
Get information about the specified Composition resource.
getCompositionRequest
- Future<GetCompositionResult> getCompositionAsync(GetCompositionRequest getCompositionRequest, AsyncHandler<GetCompositionRequest,GetCompositionResult> asyncHandler)
Get information about the specified Composition resource.
getCompositionRequest
- 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.Future<GetEncoderConfigurationResult> getEncoderConfigurationAsync(GetEncoderConfigurationRequest getEncoderConfigurationRequest)
Gets information about the specified EncoderConfiguration resource.
getEncoderConfigurationRequest
- Future<GetEncoderConfigurationResult> getEncoderConfigurationAsync(GetEncoderConfigurationRequest getEncoderConfigurationRequest, AsyncHandler<GetEncoderConfigurationRequest,GetEncoderConfigurationResult> asyncHandler)
Gets information about the specified EncoderConfiguration resource.
getEncoderConfigurationRequest
- 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.Future<GetParticipantResult> getParticipantAsync(GetParticipantRequest getParticipantRequest)
Gets information about the specified participant token.
getParticipantRequest
- Future<GetParticipantResult> getParticipantAsync(GetParticipantRequest getParticipantRequest, AsyncHandler<GetParticipantRequest,GetParticipantResult> asyncHandler)
Gets information about the specified participant token.
getParticipantRequest
- 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.Future<GetStageResult> getStageAsync(GetStageRequest getStageRequest)
Gets information for the specified stage.
getStageRequest
- Future<GetStageResult> getStageAsync(GetStageRequest getStageRequest, AsyncHandler<GetStageRequest,GetStageResult> asyncHandler)
Gets information for the specified stage.
getStageRequest
- 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.Future<GetStageSessionResult> getStageSessionAsync(GetStageSessionRequest getStageSessionRequest)
Gets information for the specified stage session.
getStageSessionRequest
- Future<GetStageSessionResult> getStageSessionAsync(GetStageSessionRequest getStageSessionRequest, AsyncHandler<GetStageSessionRequest,GetStageSessionResult> asyncHandler)
Gets information for the specified stage session.
getStageSessionRequest
- 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.Future<GetStorageConfigurationResult> getStorageConfigurationAsync(GetStorageConfigurationRequest getStorageConfigurationRequest)
Gets the storage configuration for the specified ARN.
getStorageConfigurationRequest
- Future<GetStorageConfigurationResult> getStorageConfigurationAsync(GetStorageConfigurationRequest getStorageConfigurationRequest, AsyncHandler<GetStorageConfigurationRequest,GetStorageConfigurationResult> asyncHandler)
Gets the storage configuration for the specified ARN.
getStorageConfigurationRequest
- 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.Future<ListCompositionsResult> listCompositionsAsync(ListCompositionsRequest listCompositionsRequest)
Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.
listCompositionsRequest
- Future<ListCompositionsResult> listCompositionsAsync(ListCompositionsRequest listCompositionsRequest, AsyncHandler<ListCompositionsRequest,ListCompositionsResult> asyncHandler)
Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.
listCompositionsRequest
- 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.Future<ListEncoderConfigurationsResult> listEncoderConfigurationsAsync(ListEncoderConfigurationsRequest listEncoderConfigurationsRequest)
Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.
listEncoderConfigurationsRequest
- Future<ListEncoderConfigurationsResult> listEncoderConfigurationsAsync(ListEncoderConfigurationsRequest listEncoderConfigurationsRequest, AsyncHandler<ListEncoderConfigurationsRequest,ListEncoderConfigurationsResult> asyncHandler)
Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.
listEncoderConfigurationsRequest
- 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.Future<ListParticipantEventsResult> listParticipantEventsAsync(ListParticipantEventsRequest listParticipantEventsRequest)
Lists events for a specified participant that occurred during a specified stage session.
listParticipantEventsRequest
- Future<ListParticipantEventsResult> listParticipantEventsAsync(ListParticipantEventsRequest listParticipantEventsRequest, AsyncHandler<ListParticipantEventsRequest,ListParticipantEventsResult> asyncHandler)
Lists events for a specified participant that occurred during a specified stage session.
listParticipantEventsRequest
- 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.Future<ListParticipantsResult> listParticipantsAsync(ListParticipantsRequest listParticipantsRequest)
Lists all participants in a specified stage session.
listParticipantsRequest
- Future<ListParticipantsResult> listParticipantsAsync(ListParticipantsRequest listParticipantsRequest, AsyncHandler<ListParticipantsRequest,ListParticipantsResult> asyncHandler)
Lists all participants in a specified stage session.
listParticipantsRequest
- 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.Future<ListStageSessionsResult> listStageSessionsAsync(ListStageSessionsRequest listStageSessionsRequest)
Gets all sessions for a specified stage.
listStageSessionsRequest
- Future<ListStageSessionsResult> listStageSessionsAsync(ListStageSessionsRequest listStageSessionsRequest, AsyncHandler<ListStageSessionsRequest,ListStageSessionsResult> asyncHandler)
Gets all sessions for a specified stage.
listStageSessionsRequest
- 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.Future<ListStagesResult> listStagesAsync(ListStagesRequest listStagesRequest)
Gets summary information about all stages in your account, in the AWS region where the API request is processed.
listStagesRequest
- Future<ListStagesResult> listStagesAsync(ListStagesRequest listStagesRequest, AsyncHandler<ListStagesRequest,ListStagesResult> asyncHandler)
Gets summary information about all stages in your account, in the AWS region where the API request is processed.
listStagesRequest
- 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.Future<ListStorageConfigurationsResult> listStorageConfigurationsAsync(ListStorageConfigurationsRequest listStorageConfigurationsRequest)
Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.
listStorageConfigurationsRequest
- Future<ListStorageConfigurationsResult> listStorageConfigurationsAsync(ListStorageConfigurationsRequest listStorageConfigurationsRequest, AsyncHandler<ListStorageConfigurationsRequest,ListStorageConfigurationsResult> asyncHandler)
Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.
listStorageConfigurationsRequest
- 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.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Gets information about AWS tags for the specified ARN.
listTagsForResourceRequest
- Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Gets information about AWS tags for the specified ARN.
listTagsForResourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartCompositionResult> startCompositionAsync(StartCompositionRequest startCompositionRequest)
Starts 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.
startCompositionRequest
- Future<StartCompositionResult> startCompositionAsync(StartCompositionRequest startCompositionRequest, AsyncHandler<StartCompositionRequest,StartCompositionResult> asyncHandler)
Starts 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.
startCompositionRequest
- 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.Future<StopCompositionResult> stopCompositionAsync(StopCompositionRequest stopCompositionRequest)
Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.
stopCompositionRequest
- Future<StopCompositionResult> stopCompositionAsync(StopCompositionRequest stopCompositionRequest, AsyncHandler<StopCompositionRequest,StopCompositionResult> asyncHandler)
Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.
stopCompositionRequest
- 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.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Adds or updates tags for the AWS resource with the specified ARN.
tagResourceRequest
- Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Adds or updates tags for the AWS resource with the specified ARN.
tagResourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes tags from the resource with the specified ARN.
untagResourceRequest
- Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes tags from the resource with the specified ARN.
untagResourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateStageResult> updateStageAsync(UpdateStageRequest updateStageRequest)
Updates a stage’s configuration.
updateStageRequest
- Future<UpdateStageResult> updateStageAsync(UpdateStageRequest updateStageRequest, AsyncHandler<UpdateStageRequest,UpdateStageResult> asyncHandler)
Updates a stage’s configuration.
updateStageRequest
- 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.