@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonIVSRealTimeAsyncClient extends AmazonIVSRealTimeClient implements AmazonIVSRealTimeAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXbuilder, createParticipantToken, createStage, deleteStage, disconnectParticipant, getCachedResponseMetadata, getParticipant, getStage, getStageSession, listParticipantEvents, listParticipants, listStages, listStageSessions, listTagsForResource, tagResource, untagResource, updateStageaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcreateParticipantToken, createStage, deleteStage, disconnectParticipant, getCachedResponseMetadata, getParticipant, getStage, getStageSession, listParticipantEvents, listParticipants, listStages, listStageSessions, listTagsForResource, tagResource, untagResource, updateStagepublic static AmazonIVSRealTimeAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CreateParticipantTokenResult> createParticipantTokenAsync(CreateParticipantTokenRequest request)
AmazonIVSRealTimeAsyncCreates an additional token for a specified stage. This can be done after stage creation or when tokens expire. Tokens always are scoped to the stage for which they are created.
Encryption keys are owned by Amazon IVS and never used directly by your application.
createParticipantTokenAsync in interface AmazonIVSRealTimeAsyncpublic Future<CreateParticipantTokenResult> createParticipantTokenAsync(CreateParticipantTokenRequest request, AsyncHandler<CreateParticipantTokenRequest,CreateParticipantTokenResult> asyncHandler)
AmazonIVSRealTimeAsyncCreates an additional token for a specified stage. This can be done after stage creation or when tokens expire. Tokens always are scoped to the stage for which they are created.
Encryption keys are owned by Amazon IVS and never used directly by your application.
createParticipantTokenAsync in interface AmazonIVSRealTimeAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateStageResult> createStageAsync(CreateStageRequest request)
AmazonIVSRealTimeAsyncCreates a new stage (and optionally participant tokens).
createStageAsync in interface AmazonIVSRealTimeAsyncpublic Future<CreateStageResult> createStageAsync(CreateStageRequest request, AsyncHandler<CreateStageRequest,CreateStageResult> asyncHandler)
AmazonIVSRealTimeAsyncCreates a new stage (and optionally participant tokens).
createStageAsync in interface AmazonIVSRealTimeAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteStageResult> deleteStageAsync(DeleteStageRequest request)
AmazonIVSRealTimeAsyncShuts down and deletes the specified stage (disconnecting all participants).
deleteStageAsync in interface AmazonIVSRealTimeAsyncpublic Future<DeleteStageResult> deleteStageAsync(DeleteStageRequest request, AsyncHandler<DeleteStageRequest,DeleteStageResult> asyncHandler)
AmazonIVSRealTimeAsyncShuts down and deletes the specified stage (disconnecting all participants).
deleteStageAsync in interface AmazonIVSRealTimeAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DisconnectParticipantResult> disconnectParticipantAsync(DisconnectParticipantRequest request)
AmazonIVSRealTimeAsyncDisconnects a specified participant and revokes the participant permanently from a specified stage.
disconnectParticipantAsync in interface AmazonIVSRealTimeAsyncpublic Future<DisconnectParticipantResult> disconnectParticipantAsync(DisconnectParticipantRequest request, AsyncHandler<DisconnectParticipantRequest,DisconnectParticipantResult> asyncHandler)
AmazonIVSRealTimeAsyncDisconnects a specified participant and revokes the participant permanently from a specified stage.
disconnectParticipantAsync in interface AmazonIVSRealTimeAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetParticipantResult> getParticipantAsync(GetParticipantRequest request)
AmazonIVSRealTimeAsyncGets information about the specified participant token.
getParticipantAsync in interface AmazonIVSRealTimeAsyncpublic Future<GetParticipantResult> getParticipantAsync(GetParticipantRequest request, AsyncHandler<GetParticipantRequest,GetParticipantResult> asyncHandler)
AmazonIVSRealTimeAsyncGets information about the specified participant token.
getParticipantAsync in interface AmazonIVSRealTimeAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetStageResult> getStageAsync(GetStageRequest request)
AmazonIVSRealTimeAsyncGets information for the specified stage.
getStageAsync in interface AmazonIVSRealTimeAsyncpublic Future<GetStageResult> getStageAsync(GetStageRequest request, AsyncHandler<GetStageRequest,GetStageResult> asyncHandler)
AmazonIVSRealTimeAsyncGets information for the specified stage.
getStageAsync in interface AmazonIVSRealTimeAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetStageSessionResult> getStageSessionAsync(GetStageSessionRequest request)
AmazonIVSRealTimeAsyncGets information for the specified stage session.
getStageSessionAsync in interface AmazonIVSRealTimeAsyncpublic Future<GetStageSessionResult> getStageSessionAsync(GetStageSessionRequest request, AsyncHandler<GetStageSessionRequest,GetStageSessionResult> asyncHandler)
AmazonIVSRealTimeAsyncGets information for the specified stage session.
getStageSessionAsync in interface AmazonIVSRealTimeAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListParticipantEventsResult> listParticipantEventsAsync(ListParticipantEventsRequest request)
AmazonIVSRealTimeAsyncLists events for a specified participant that occurred during a specified stage session.
listParticipantEventsAsync in interface AmazonIVSRealTimeAsyncpublic Future<ListParticipantEventsResult> listParticipantEventsAsync(ListParticipantEventsRequest request, AsyncHandler<ListParticipantEventsRequest,ListParticipantEventsResult> asyncHandler)
AmazonIVSRealTimeAsyncLists events for a specified participant that occurred during a specified stage session.
listParticipantEventsAsync in interface AmazonIVSRealTimeAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListParticipantsResult> listParticipantsAsync(ListParticipantsRequest request)
AmazonIVSRealTimeAsyncLists all participants in a specified stage session.
listParticipantsAsync in interface AmazonIVSRealTimeAsyncpublic Future<ListParticipantsResult> listParticipantsAsync(ListParticipantsRequest request, AsyncHandler<ListParticipantsRequest,ListParticipantsResult> asyncHandler)
AmazonIVSRealTimeAsyncLists all participants in a specified stage session.
listParticipantsAsync in interface AmazonIVSRealTimeAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListStageSessionsResult> listStageSessionsAsync(ListStageSessionsRequest request)
AmazonIVSRealTimeAsyncGets all sessions for a specified stage.
listStageSessionsAsync in interface AmazonIVSRealTimeAsyncpublic Future<ListStageSessionsResult> listStageSessionsAsync(ListStageSessionsRequest request, AsyncHandler<ListStageSessionsRequest,ListStageSessionsResult> asyncHandler)
AmazonIVSRealTimeAsyncGets all sessions for a specified stage.
listStageSessionsAsync in interface AmazonIVSRealTimeAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListStagesResult> listStagesAsync(ListStagesRequest request)
AmazonIVSRealTimeAsyncGets summary information about all stages in your account, in the AWS region where the API request is processed.
listStagesAsync in interface AmazonIVSRealTimeAsyncpublic Future<ListStagesResult> listStagesAsync(ListStagesRequest request, AsyncHandler<ListStagesRequest,ListStagesResult> asyncHandler)
AmazonIVSRealTimeAsyncGets summary information about all stages in your account, in the AWS region where the API request is processed.
listStagesAsync in interface AmazonIVSRealTimeAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonIVSRealTimeAsyncGets information about AWS tags for the specified ARN.
listTagsForResourceAsync in interface AmazonIVSRealTimeAsyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonIVSRealTimeAsyncGets information about AWS tags for the specified ARN.
listTagsForResourceAsync in interface AmazonIVSRealTimeAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AmazonIVSRealTimeAsyncAdds or updates tags for the AWS resource with the specified ARN.
tagResourceAsync in interface AmazonIVSRealTimeAsyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonIVSRealTimeAsyncAdds or updates tags for the AWS resource with the specified ARN.
tagResourceAsync in interface AmazonIVSRealTimeAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AmazonIVSRealTimeAsyncRemoves tags from the resource with the specified ARN.
untagResourceAsync in interface AmazonIVSRealTimeAsyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonIVSRealTimeAsyncRemoves tags from the resource with the specified ARN.
untagResourceAsync in interface AmazonIVSRealTimeAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateStageResult> updateStageAsync(UpdateStageRequest request)
AmazonIVSRealTimeAsyncUpdates a stage’s configuration.
updateStageAsync in interface AmazonIVSRealTimeAsyncpublic Future<UpdateStageResult> updateStageAsync(UpdateStageRequest request, AsyncHandler<UpdateStageRequest,UpdateStageResult> asyncHandler)
AmazonIVSRealTimeAsyncUpdates a stage’s configuration.
updateStageAsync in interface AmazonIVSRealTimeAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AmazonIVSRealTimeshutdown in class AmazonIVSRealTimeClient