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.

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.

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.

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.

Field Summary

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
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<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<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<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<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<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<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

createParticipantToken, createStage, deleteStage, disconnectParticipant, getCachedResponseMetadata, getParticipant, getStage, getStageSession, listParticipantEvents, listParticipants, listStages, listStageSessions, listTagsForResource, shutdown, tagResource, untagResource, updateStage

Method Detail

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

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

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

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

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

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

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

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

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