com.amazonaws.services.ivsrealtime

Interface AmazonIVSRealTimeAsync

All Superinterfaces:

AmazonIVSRealTime

All Known Implementing Classes:

AbstractAmazonIVSRealTimeAsync, AmazonIVSRealTimeAsyncClient

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

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

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

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.

Field Summary

Fields inherited from interface com.amazonaws.services.ivsrealtime.AmazonIVSRealTime

ENDPOINT_PREFIX

Method Summary

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<DeletePublicKeyResult>	deletePublicKeyAsync(DeletePublicKeyRequest deletePublicKeyRequest) Deletes the specified public key used to sign stage participant tokens.
Future<DeletePublicKeyResult>	deletePublicKeyAsync(DeletePublicKeyRequest deletePublicKeyRequest, AsyncHandler<DeletePublicKeyRequest,DeletePublicKeyResult> asyncHandler) Deletes the specified public key used to sign stage participant tokens.
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<GetPublicKeyResult>	getPublicKeyAsync(GetPublicKeyRequest getPublicKeyRequest) Gets information for the specified public key.
Future<GetPublicKeyResult>	getPublicKeyAsync(GetPublicKeyRequest getPublicKeyRequest, AsyncHandler<GetPublicKeyRequest,GetPublicKeyResult> asyncHandler) Gets information for the specified public key.
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<ImportPublicKeyResult>	importPublicKeyAsync(ImportPublicKeyRequest importPublicKeyRequest) Import a public key to be used for signing stage participant tokens.
Future<ImportPublicKeyResult>	importPublicKeyAsync(ImportPublicKeyRequest importPublicKeyRequest, AsyncHandler<ImportPublicKeyRequest,ImportPublicKeyResult> asyncHandler) Import a public key to be used for signing stage participant tokens.
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<ListPublicKeysResult>	listPublicKeysAsync(ListPublicKeysRequest listPublicKeysRequest) Gets summary information about all public keys in your account, in the AWS region where the API request is processed.
Future<ListPublicKeysResult>	listPublicKeysAsync(ListPublicKeysRequest listPublicKeysRequest, AsyncHandler<ListPublicKeysRequest,ListPublicKeysResult> asyncHandler) Gets summary information about all public keys in your account, in the AWS region where the API request is processed.
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.

Methods inherited from interface com.amazonaws.services.ivsrealtime.AmazonIVSRealTime

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, shutdown, startComposition, stopComposition, tagResource, untagResource, updateStage

Method Detail

createEncoderConfigurationAsync

Future<CreateEncoderConfigurationResult> createEncoderConfigurationAsync(CreateEncoderConfigurationRequest createEncoderConfigurationRequest)

Creates an EncoderConfiguration object.

Parameters:

createEncoderConfigurationRequest -

Returns:

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

See Also:

AWS API Documentation

createEncoderConfigurationAsync

Future<CreateEncoderConfigurationResult> createEncoderConfigurationAsync(CreateEncoderConfigurationRequest createEncoderConfigurationRequest,
                                                                         AsyncHandler<CreateEncoderConfigurationRequest,CreateEncoderConfigurationResult> asyncHandler)

Creates an EncoderConfiguration object.

Parameters:

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.

Returns:

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

See Also:

AWS API Documentation

createParticipantTokenAsync

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.

Parameters:

createParticipantTokenRequest -

Returns:

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

See Also:

AWS API Documentation

createParticipantTokenAsync

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.

Parameters:

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.

Returns:

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

See Also:

AWS API Documentation

createStageAsync

Future<CreateStageResult> createStageAsync(CreateStageRequest createStageRequest)

Creates a new stage (and optionally participant tokens).

Parameters:

createStageRequest -

Returns:

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

See Also:

AWS API Documentation

createStageAsync

Future<CreateStageResult> createStageAsync(CreateStageRequest createStageRequest,
                                           AsyncHandler<CreateStageRequest,CreateStageResult> asyncHandler)

Creates a new stage (and optionally participant tokens).

Parameters:

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.

Returns:

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

See Also:

AWS API Documentation

createStorageConfigurationAsync

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.

Parameters:

createStorageConfigurationRequest -

Returns:

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

See Also:

AWS API Documentation

createStorageConfigurationAsync

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.

Parameters:

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.

Returns:

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

See Also:

AWS API Documentation

deleteEncoderConfigurationAsync

Future<DeleteEncoderConfigurationResult> deleteEncoderConfigurationAsync(DeleteEncoderConfigurationRequest deleteEncoderConfigurationRequest)

Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.

Parameters:

deleteEncoderConfigurationRequest -

Returns:

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

See Also:

AWS API Documentation

deleteEncoderConfigurationAsync

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.

Parameters:

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.

Returns:

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

See Also:

AWS API Documentation

deletePublicKeyAsync

Future<DeletePublicKeyResult> deletePublicKeyAsync(DeletePublicKeyRequest deletePublicKeyRequest)

Deletes the specified public key used to sign stage participant tokens. This invalidates future participant tokens generated using the key pair’s private key.

Parameters:

deletePublicKeyRequest -

Returns:

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

See Also:

AWS API Documentation

deletePublicKeyAsync

Future<DeletePublicKeyResult> deletePublicKeyAsync(DeletePublicKeyRequest deletePublicKeyRequest,
                                                   AsyncHandler<DeletePublicKeyRequest,DeletePublicKeyResult> asyncHandler)

Deletes the specified public key used to sign stage participant tokens. This invalidates future participant tokens generated using the key pair’s private key.

Parameters:

deletePublicKeyRequest -

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

See Also:

AWS API Documentation

deleteStageAsync

Future<DeleteStageResult> deleteStageAsync(DeleteStageRequest deleteStageRequest)

Shuts down and deletes the specified stage (disconnecting all participants).

Parameters:

deleteStageRequest -

Returns:

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

See Also:

AWS API Documentation

deleteStageAsync

Future<DeleteStageResult> deleteStageAsync(DeleteStageRequest deleteStageRequest,
                                           AsyncHandler<DeleteStageRequest,DeleteStageResult> asyncHandler)

Shuts down and deletes the specified stage (disconnecting all participants).

Parameters:

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.

Returns:

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

See Also:

AWS API Documentation

deleteStorageConfigurationAsync

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.

Parameters:

deleteStorageConfigurationRequest -

Returns:

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

See Also:

AWS API Documentation

deleteStorageConfigurationAsync

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.

Parameters:

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.

Returns:

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

See Also:

AWS API Documentation

disconnectParticipantAsync

Future<DisconnectParticipantResult> disconnectParticipantAsync(DisconnectParticipantRequest disconnectParticipantRequest)

Disconnects a specified participant and revokes the participant permanently from a specified stage.

Parameters:

disconnectParticipantRequest -

Returns:

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

See Also:

AWS API Documentation

disconnectParticipantAsync

Future<DisconnectParticipantResult> disconnectParticipantAsync(DisconnectParticipantRequest disconnectParticipantRequest,
                                                               AsyncHandler<DisconnectParticipantRequest,DisconnectParticipantResult> asyncHandler)

Disconnects a specified participant and revokes the participant permanently from a specified stage.

Parameters:

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.

Returns:

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

See Also:

AWS API Documentation

getCompositionAsync

Future<GetCompositionResult> getCompositionAsync(GetCompositionRequest getCompositionRequest)

Get information about the specified Composition resource.

Parameters:

getCompositionRequest -

Returns:

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

See Also:

AWS API Documentation

getCompositionAsync

Future<GetCompositionResult> getCompositionAsync(GetCompositionRequest getCompositionRequest,
                                                 AsyncHandler<GetCompositionRequest,GetCompositionResult> asyncHandler)

Get information about the specified Composition resource.

Parameters:

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.

Returns:

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

See Also:

AWS API Documentation

getEncoderConfigurationAsync

Future<GetEncoderConfigurationResult> getEncoderConfigurationAsync(GetEncoderConfigurationRequest getEncoderConfigurationRequest)

Gets information about the specified EncoderConfiguration resource.

Parameters:

getEncoderConfigurationRequest -

Returns:

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

See Also:

AWS API Documentation

getEncoderConfigurationAsync

Future<GetEncoderConfigurationResult> getEncoderConfigurationAsync(GetEncoderConfigurationRequest getEncoderConfigurationRequest,
                                                                   AsyncHandler<GetEncoderConfigurationRequest,GetEncoderConfigurationResult> asyncHandler)

Gets information about the specified EncoderConfiguration resource.

Parameters:

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.

Returns:

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

See Also:

AWS API Documentation

getParticipantAsync

Future<GetParticipantResult> getParticipantAsync(GetParticipantRequest getParticipantRequest)

Gets information about the specified participant token.

Parameters:

getParticipantRequest -

Returns:

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

See Also:

AWS API Documentation

getParticipantAsync

Future<GetParticipantResult> getParticipantAsync(GetParticipantRequest getParticipantRequest,
                                                 AsyncHandler<GetParticipantRequest,GetParticipantResult> asyncHandler)

Gets information about the specified participant token.

Parameters:

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.

Returns:

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

See Also:

AWS API Documentation

getPublicKeyAsync

Future<GetPublicKeyResult> getPublicKeyAsync(GetPublicKeyRequest getPublicKeyRequest)

Gets information for the specified public key.

Parameters:

getPublicKeyRequest -

Returns:

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

See Also:

AWS API Documentation

getPublicKeyAsync

Future<GetPublicKeyResult> getPublicKeyAsync(GetPublicKeyRequest getPublicKeyRequest,
                                             AsyncHandler<GetPublicKeyRequest,GetPublicKeyResult> asyncHandler)

Gets information for the specified public key.

Parameters:

getPublicKeyRequest -

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

See Also:

AWS API Documentation

getStageAsync

Future<GetStageResult> getStageAsync(GetStageRequest getStageRequest)

Gets information for the specified stage.

Parameters:

getStageRequest -

Returns:

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

See Also:

AWS API Documentation

getStageAsync

Future<GetStageResult> getStageAsync(GetStageRequest getStageRequest,
                                     AsyncHandler<GetStageRequest,GetStageResult> asyncHandler)

Gets information for the specified stage.

Parameters:

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.

Returns:

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

See Also:

AWS API Documentation

getStageSessionAsync

Future<GetStageSessionResult> getStageSessionAsync(GetStageSessionRequest getStageSessionRequest)

Gets information for the specified stage session.

Parameters:

getStageSessionRequest -

Returns:

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

See Also:

AWS API Documentation

getStageSessionAsync

Future<GetStageSessionResult> getStageSessionAsync(GetStageSessionRequest getStageSessionRequest,
                                                   AsyncHandler<GetStageSessionRequest,GetStageSessionResult> asyncHandler)

Gets information for the specified stage session.

Parameters:

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.

Returns:

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

See Also:

AWS API Documentation

getStorageConfigurationAsync

Future<GetStorageConfigurationResult> getStorageConfigurationAsync(GetStorageConfigurationRequest getStorageConfigurationRequest)

Gets the storage configuration for the specified ARN.

Parameters:

getStorageConfigurationRequest -

Returns:

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

See Also:

AWS API Documentation

getStorageConfigurationAsync

Future<GetStorageConfigurationResult> getStorageConfigurationAsync(GetStorageConfigurationRequest getStorageConfigurationRequest,
                                                                   AsyncHandler<GetStorageConfigurationRequest,GetStorageConfigurationResult> asyncHandler)

Gets the storage configuration for the specified ARN.

Parameters:

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.

Returns:

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

See Also:

AWS API Documentation

importPublicKeyAsync

Future<ImportPublicKeyResult> importPublicKeyAsync(ImportPublicKeyRequest importPublicKeyRequest)

Import a public key to be used for signing stage participant tokens.

Parameters:

importPublicKeyRequest -

Returns:

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

See Also:

AWS API Documentation

importPublicKeyAsync

Future<ImportPublicKeyResult> importPublicKeyAsync(ImportPublicKeyRequest importPublicKeyRequest,
                                                   AsyncHandler<ImportPublicKeyRequest,ImportPublicKeyResult> asyncHandler)

Import a public key to be used for signing stage participant tokens.

Parameters:

importPublicKeyRequest -

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

See Also:

AWS API Documentation

listCompositionsAsync

Future<ListCompositionsResult> listCompositionsAsync(ListCompositionsRequest listCompositionsRequest)

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

Parameters:

listCompositionsRequest -

Returns:

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

See Also:

AWS API Documentation

listCompositionsAsync

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.

Parameters:

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.

Returns:

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

See Also:

AWS API Documentation

listEncoderConfigurationsAsync

Future<ListEncoderConfigurationsResult> listEncoderConfigurationsAsync(ListEncoderConfigurationsRequest listEncoderConfigurationsRequest)

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

Parameters:

listEncoderConfigurationsRequest -

Returns:

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

See Also:

AWS API Documentation

listEncoderConfigurationsAsync

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.

Parameters:

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.

Returns:

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

See Also:

AWS API Documentation

listParticipantEventsAsync

Future<ListParticipantEventsResult> listParticipantEventsAsync(ListParticipantEventsRequest listParticipantEventsRequest)

Lists events for a specified participant that occurred during a specified stage session.

Parameters:

listParticipantEventsRequest -

Returns:

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

See Also:

AWS API Documentation

listParticipantEventsAsync

Future<ListParticipantEventsResult> listParticipantEventsAsync(ListParticipantEventsRequest listParticipantEventsRequest,
                                                               AsyncHandler<ListParticipantEventsRequest,ListParticipantEventsResult> asyncHandler)

Lists events for a specified participant that occurred during a specified stage session.

Parameters:

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.

Returns:

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

See Also:

AWS API Documentation

listParticipantsAsync

Future<ListParticipantsResult> listParticipantsAsync(ListParticipantsRequest listParticipantsRequest)

Lists all participants in a specified stage session.

Parameters:

listParticipantsRequest -

Returns:

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

See Also:

AWS API Documentation

listParticipantsAsync

Future<ListParticipantsResult> listParticipantsAsync(ListParticipantsRequest listParticipantsRequest,
                                                     AsyncHandler<ListParticipantsRequest,ListParticipantsResult> asyncHandler)

Lists all participants in a specified stage session.

Parameters:

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.

Returns:

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

See Also:

AWS API Documentation

listPublicKeysAsync

Future<ListPublicKeysResult> listPublicKeysAsync(ListPublicKeysRequest listPublicKeysRequest)

Gets summary information about all public keys in your account, in the AWS region where the API request is processed.

Parameters:

listPublicKeysRequest -

Returns:

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

See Also:

AWS API Documentation

listPublicKeysAsync

Future<ListPublicKeysResult> listPublicKeysAsync(ListPublicKeysRequest listPublicKeysRequest,
                                                 AsyncHandler<ListPublicKeysRequest,ListPublicKeysResult> asyncHandler)

Gets summary information about all public keys in your account, in the AWS region where the API request is processed.

Parameters:

listPublicKeysRequest -

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

See Also:

AWS API Documentation

listStageSessionsAsync

Future<ListStageSessionsResult> listStageSessionsAsync(ListStageSessionsRequest listStageSessionsRequest)

Gets all sessions for a specified stage.

Parameters:

listStageSessionsRequest -

Returns:

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

See Also:

AWS API Documentation

listStageSessionsAsync

Future<ListStageSessionsResult> listStageSessionsAsync(ListStageSessionsRequest listStageSessionsRequest,
                                                       AsyncHandler<ListStageSessionsRequest,ListStageSessionsResult> asyncHandler)

Gets all sessions for a specified stage.

Parameters:

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.

Returns:

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

See Also:

AWS API Documentation

listStagesAsync

Future<ListStagesResult> listStagesAsync(ListStagesRequest listStagesRequest)

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

Parameters:

listStagesRequest -

Returns:

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

See Also:

AWS API Documentation

listStagesAsync

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.

Parameters:

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.

Returns:

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

See Also:

AWS API Documentation

listStorageConfigurationsAsync

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.

Parameters:

listStorageConfigurationsRequest -

Returns:

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

See Also:

AWS API Documentation

listStorageConfigurationsAsync

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.

Parameters:

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.

Returns:

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

See Also:

AWS API Documentation

listTagsForResourceAsync

Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)

Gets information about AWS tags for the specified ARN.

Parameters:

listTagsForResourceRequest -

Returns:

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

See Also:

AWS API Documentation

listTagsForResourceAsync

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

Gets information about AWS tags for the specified ARN.

Parameters:

listTagsForResourceRequest -

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

Returns:

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

See Also:

AWS API Documentation

startCompositionAsync

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.

Parameters:

startCompositionRequest -

Returns:

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

See Also:

AWS API Documentation

startCompositionAsync

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.

Parameters:

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.

Returns:

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

See Also:

AWS API Documentation

stopCompositionAsync

Future<StopCompositionResult> stopCompositionAsync(StopCompositionRequest stopCompositionRequest)

Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.

Parameters:

stopCompositionRequest -

Returns:

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

See Also:

AWS API Documentation

stopCompositionAsync

Future<StopCompositionResult> stopCompositionAsync(StopCompositionRequest stopCompositionRequest,
                                                   AsyncHandler<StopCompositionRequest,StopCompositionResult> asyncHandler)

Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.

Parameters:

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.

Returns:

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

See Also:

AWS API Documentation

tagResourceAsync

Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)

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

Parameters:

tagResourceRequest -

Returns:

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

See Also:

AWS API Documentation

tagResourceAsync

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

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

Parameters:

tagResourceRequest -

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

Returns:

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

See Also:

AWS API Documentation

untagResourceAsync

Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)

Removes tags from the resource with the specified ARN.

Parameters:

untagResourceRequest -

Returns:

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

See Also:

AWS API Documentation

untagResourceAsync

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

Removes tags from the resource with the specified ARN.

Parameters:

untagResourceRequest -

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

Returns:

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

See Also:

AWS API Documentation

updateStageAsync

Future<UpdateStageResult> updateStageAsync(UpdateStageRequest updateStageRequest)

Updates a stage’s configuration.

Parameters:

updateStageRequest -

Returns:

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

See Also:

AWS API Documentation

updateStageAsync

Future<UpdateStageResult> updateStageAsync(UpdateStageRequest updateStageRequest,
                                           AsyncHandler<UpdateStageRequest,UpdateStageResult> asyncHandler)

Updates a stage’s configuration.

Parameters:

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.

Returns:

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

See Also:

AWS API Documentation