Interface IvsRealTimeAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
Introduction
The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, including errors.
Terminology:
-
A stage is a virtual space where participants can exchange video in real time.
-
A participant token is a token that authenticates a participant when they join a stage.
-
A participant object represents participants (people) in the stage and contains information about them. When a token is created, it includes a participant ID; when a participant uses that token to join a stage, the participant is associated with that participant ID. There is a 1:1 mapping between participant tokens and participants.
-
Server-side composition: The composition process composites participants of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels). Composition endpoints support this process.
-
Server-side composition: A composition controls the look of the outputs, including how participants are positioned in the video.
Resources
The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS Real-Time Streaming):
-
Stage — A stage is a virtual space where participants can exchange video in real time.
Tagging
A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value,
both set by you. For example, you might set a tag as topic:nature
to label a particular video category.
See Tagging AWS Resources for more
information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS stages
has no service-specific constraints beyond what is documented there.
Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).
The Amazon IVS real-time API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Stage.
At most 50 tags can be applied to a resource.
Stages Endpoints
-
CreateParticipantToken — Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire.
-
CreateStage — Creates a new stage (and optionally participant tokens).
-
DeleteStage — Shuts down and deletes the specified stage (disconnecting all participants).
-
DisconnectParticipant — Disconnects a specified participant and revokes the participant permanently from a specified stage.
-
GetParticipant — Gets information about the specified participant token.
-
GetStage — Gets information for the specified stage.
-
GetStageSession — Gets information for the specified stage session.
-
ListParticipantEvents — Lists events for a specified participant that occurred during a specified stage session.
-
ListParticipants — Lists all participants in a specified stage session.
-
ListStages — Gets summary information about all stages in your account, in the AWS region where the API request is processed.
-
ListStageSessions — Gets all sessions for a specified stage.
-
UpdateStage — Updates a stage’s configuration.
Composition Endpoints
-
GetComposition — Gets information about the specified Composition resource.
-
ListCompositions — Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.
-
StartComposition — Starts a Composition from a stage based on the configuration provided in the request.
-
StopComposition — Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.
EncoderConfiguration Endpoints
-
CreateEncoderConfiguration — Creates an EncoderConfiguration object.
-
DeleteEncoderConfiguration — Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.
-
GetEncoderConfiguration — Gets information about the specified EncoderConfiguration resource.
-
ListEncoderConfigurations — Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.
StorageConfiguration Endpoints
-
CreateStorageConfiguration — Creates a new storage configuration, used to enable recording to Amazon S3.
-
DeleteStorageConfiguration — Deletes the storage configuration for the specified ARN.
-
GetStorageConfiguration — Gets the storage configuration for the specified ARN.
-
ListStorageConfigurations — Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.
Tags Endpoints
-
ListTagsForResource — Gets information about AWS tags for the specified ARN.
-
TagResource — Adds or updates tags for the AWS resource with the specified ARN.
-
UntagResource — Removes tags from the resource with the specified ARN.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aIvsRealTimeAsyncClient
.static IvsRealTimeAsyncClient
create()
Create aIvsRealTimeAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createEncoderConfiguration
(Consumer<CreateEncoderConfigurationRequest.Builder> createEncoderConfigurationRequest) Creates an EncoderConfiguration object.createEncoderConfiguration
(CreateEncoderConfigurationRequest createEncoderConfigurationRequest) Creates an EncoderConfiguration object.createParticipantToken
(Consumer<CreateParticipantTokenRequest.Builder> createParticipantTokenRequest) Creates an additional token for a specified stage.createParticipantToken
(CreateParticipantTokenRequest createParticipantTokenRequest) Creates an additional token for a specified stage.default CompletableFuture
<CreateStageResponse> createStage
(Consumer<CreateStageRequest.Builder> createStageRequest) Creates a new stage (and optionally participant tokens).default CompletableFuture
<CreateStageResponse> createStage
(CreateStageRequest createStageRequest) Creates a new stage (and optionally participant tokens).createStorageConfiguration
(Consumer<CreateStorageConfigurationRequest.Builder> createStorageConfigurationRequest) Creates a new storage configuration, used to enable recording to Amazon S3.createStorageConfiguration
(CreateStorageConfigurationRequest createStorageConfigurationRequest) Creates a new storage configuration, used to enable recording to Amazon S3.deleteEncoderConfiguration
(Consumer<DeleteEncoderConfigurationRequest.Builder> deleteEncoderConfigurationRequest) Deletes an EncoderConfiguration resource.deleteEncoderConfiguration
(DeleteEncoderConfigurationRequest deleteEncoderConfigurationRequest) Deletes an EncoderConfiguration resource.default CompletableFuture
<DeleteStageResponse> deleteStage
(Consumer<DeleteStageRequest.Builder> deleteStageRequest) Shuts down and deletes the specified stage (disconnecting all participants).default CompletableFuture
<DeleteStageResponse> deleteStage
(DeleteStageRequest deleteStageRequest) Shuts down and deletes the specified stage (disconnecting all participants).deleteStorageConfiguration
(Consumer<DeleteStorageConfigurationRequest.Builder> deleteStorageConfigurationRequest) Deletes the storage configuration for the specified ARN.deleteStorageConfiguration
(DeleteStorageConfigurationRequest deleteStorageConfigurationRequest) Deletes the storage configuration for the specified ARN.disconnectParticipant
(Consumer<DisconnectParticipantRequest.Builder> disconnectParticipantRequest) Disconnects a specified participant and revokes the participant permanently from a specified stage.disconnectParticipant
(DisconnectParticipantRequest disconnectParticipantRequest) Disconnects a specified participant and revokes the participant permanently from a specified stage.default CompletableFuture
<GetCompositionResponse> getComposition
(Consumer<GetCompositionRequest.Builder> getCompositionRequest) Get information about the specified Composition resource.default CompletableFuture
<GetCompositionResponse> getComposition
(GetCompositionRequest getCompositionRequest) Get information about the specified Composition resource.getEncoderConfiguration
(Consumer<GetEncoderConfigurationRequest.Builder> getEncoderConfigurationRequest) Gets information about the specified EncoderConfiguration resource.getEncoderConfiguration
(GetEncoderConfigurationRequest getEncoderConfigurationRequest) Gets information about the specified EncoderConfiguration resource.default CompletableFuture
<GetParticipantResponse> getParticipant
(Consumer<GetParticipantRequest.Builder> getParticipantRequest) Gets information about the specified participant token.default CompletableFuture
<GetParticipantResponse> getParticipant
(GetParticipantRequest getParticipantRequest) Gets information about the specified participant token.default CompletableFuture
<GetStageResponse> getStage
(Consumer<GetStageRequest.Builder> getStageRequest) Gets information for the specified stage.default CompletableFuture
<GetStageResponse> getStage
(GetStageRequest getStageRequest) Gets information for the specified stage.default CompletableFuture
<GetStageSessionResponse> getStageSession
(Consumer<GetStageSessionRequest.Builder> getStageSessionRequest) Gets information for the specified stage session.default CompletableFuture
<GetStageSessionResponse> getStageSession
(GetStageSessionRequest getStageSessionRequest) Gets information for the specified stage session.getStorageConfiguration
(Consumer<GetStorageConfigurationRequest.Builder> getStorageConfigurationRequest) Gets the storage configuration for the specified ARN.getStorageConfiguration
(GetStorageConfigurationRequest getStorageConfigurationRequest) Gets the storage configuration for the specified ARN.listCompositions
(Consumer<ListCompositionsRequest.Builder> listCompositionsRequest) Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.listCompositions
(ListCompositionsRequest listCompositionsRequest) Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.default ListCompositionsPublisher
listCompositionsPaginator
(Consumer<ListCompositionsRequest.Builder> listCompositionsRequest) This is a variant oflistCompositions(software.amazon.awssdk.services.ivsrealtime.model.ListCompositionsRequest)
operation.default ListCompositionsPublisher
listCompositionsPaginator
(ListCompositionsRequest listCompositionsRequest) This is a variant oflistCompositions(software.amazon.awssdk.services.ivsrealtime.model.ListCompositionsRequest)
operation.listEncoderConfigurations
(Consumer<ListEncoderConfigurationsRequest.Builder> listEncoderConfigurationsRequest) Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.listEncoderConfigurations
(ListEncoderConfigurationsRequest listEncoderConfigurationsRequest) Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.listEncoderConfigurationsPaginator
(Consumer<ListEncoderConfigurationsRequest.Builder> listEncoderConfigurationsRequest) This is a variant oflistEncoderConfigurations(software.amazon.awssdk.services.ivsrealtime.model.ListEncoderConfigurationsRequest)
operation.listEncoderConfigurationsPaginator
(ListEncoderConfigurationsRequest listEncoderConfigurationsRequest) This is a variant oflistEncoderConfigurations(software.amazon.awssdk.services.ivsrealtime.model.ListEncoderConfigurationsRequest)
operation.listParticipantEvents
(Consumer<ListParticipantEventsRequest.Builder> listParticipantEventsRequest) Lists events for a specified participant that occurred during a specified stage session.listParticipantEvents
(ListParticipantEventsRequest listParticipantEventsRequest) Lists events for a specified participant that occurred during a specified stage session.default ListParticipantEventsPublisher
listParticipantEventsPaginator
(Consumer<ListParticipantEventsRequest.Builder> listParticipantEventsRequest) This is a variant oflistParticipantEvents(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantEventsRequest)
operation.default ListParticipantEventsPublisher
listParticipantEventsPaginator
(ListParticipantEventsRequest listParticipantEventsRequest) This is a variant oflistParticipantEvents(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantEventsRequest)
operation.listParticipants
(Consumer<ListParticipantsRequest.Builder> listParticipantsRequest) Lists all participants in a specified stage session.listParticipants
(ListParticipantsRequest listParticipantsRequest) Lists all participants in a specified stage session.default ListParticipantsPublisher
listParticipantsPaginator
(Consumer<ListParticipantsRequest.Builder> listParticipantsRequest) This is a variant oflistParticipants(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantsRequest)
operation.default ListParticipantsPublisher
listParticipantsPaginator
(ListParticipantsRequest listParticipantsRequest) This is a variant oflistParticipants(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantsRequest)
operation.default CompletableFuture
<ListStagesResponse> listStages
(Consumer<ListStagesRequest.Builder> listStagesRequest) Gets summary information about all stages in your account, in the AWS region where the API request is processed.default CompletableFuture
<ListStagesResponse> listStages
(ListStagesRequest listStagesRequest) Gets summary information about all stages in your account, in the AWS region where the API request is processed.listStageSessions
(Consumer<ListStageSessionsRequest.Builder> listStageSessionsRequest) Gets all sessions for a specified stage.listStageSessions
(ListStageSessionsRequest listStageSessionsRequest) Gets all sessions for a specified stage.default ListStageSessionsPublisher
listStageSessionsPaginator
(Consumer<ListStageSessionsRequest.Builder> listStageSessionsRequest) This is a variant oflistStageSessions(software.amazon.awssdk.services.ivsrealtime.model.ListStageSessionsRequest)
operation.default ListStageSessionsPublisher
listStageSessionsPaginator
(ListStageSessionsRequest listStageSessionsRequest) This is a variant oflistStageSessions(software.amazon.awssdk.services.ivsrealtime.model.ListStageSessionsRequest)
operation.default ListStagesPublisher
listStagesPaginator
(Consumer<ListStagesRequest.Builder> listStagesRequest) This is a variant oflistStages(software.amazon.awssdk.services.ivsrealtime.model.ListStagesRequest)
operation.default ListStagesPublisher
listStagesPaginator
(ListStagesRequest listStagesRequest) This is a variant oflistStages(software.amazon.awssdk.services.ivsrealtime.model.ListStagesRequest)
operation.listStorageConfigurations
(Consumer<ListStorageConfigurationsRequest.Builder> listStorageConfigurationsRequest) Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.listStorageConfigurations
(ListStorageConfigurationsRequest listStorageConfigurationsRequest) Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.listStorageConfigurationsPaginator
(Consumer<ListStorageConfigurationsRequest.Builder> listStorageConfigurationsRequest) This is a variant oflistStorageConfigurations(software.amazon.awssdk.services.ivsrealtime.model.ListStorageConfigurationsRequest)
operation.listStorageConfigurationsPaginator
(ListStorageConfigurationsRequest listStorageConfigurationsRequest) This is a variant oflistStorageConfigurations(software.amazon.awssdk.services.ivsrealtime.model.ListStorageConfigurationsRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Gets information about AWS tags for the specified ARN.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Gets information about AWS tags for the specified ARN.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartComposition
(Consumer<StartCompositionRequest.Builder> startCompositionRequest) Starts a Composition from a stage based on the configuration provided in the request.startComposition
(StartCompositionRequest startCompositionRequest) Starts a Composition from a stage based on the configuration provided in the request.default CompletableFuture
<StopCompositionResponse> stopComposition
(Consumer<StopCompositionRequest.Builder> stopCompositionRequest) Stops and deletes a Composition resource.default CompletableFuture
<StopCompositionResponse> stopComposition
(StopCompositionRequest stopCompositionRequest) Stops and deletes a Composition resource.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds or updates tags for the AWS resource with the specified ARN.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Adds or updates tags for the AWS resource with the specified ARN.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from the resource with the specified ARN.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes tags from the resource with the specified ARN.default CompletableFuture
<UpdateStageResponse> updateStage
(Consumer<UpdateStageRequest.Builder> updateStageRequest) Updates a stage’s configuration.default CompletableFuture
<UpdateStageResponse> updateStage
(UpdateStageRequest updateStageRequest) Updates a stage’s configuration.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createEncoderConfiguration
default CompletableFuture<CreateEncoderConfigurationResponse> createEncoderConfiguration(CreateEncoderConfigurationRequest createEncoderConfigurationRequest) Creates an EncoderConfiguration object.
- Parameters:
createEncoderConfigurationRequest
-- Returns:
- A Java Future containing the result of the CreateEncoderConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- AccessDeniedException
- InternalServerException
- ServiceQuotaExceededException
- ConflictException
- PendingVerificationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createEncoderConfiguration
default CompletableFuture<CreateEncoderConfigurationResponse> createEncoderConfiguration(Consumer<CreateEncoderConfigurationRequest.Builder> createEncoderConfigurationRequest) Creates an EncoderConfiguration object.
This is a convenience which creates an instance of the
CreateEncoderConfigurationRequest.Builder
avoiding the need to create one manually viaCreateEncoderConfigurationRequest.builder()
- Parameters:
createEncoderConfigurationRequest
- AConsumer
that will call methods onCreateEncoderConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateEncoderConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- AccessDeniedException
- InternalServerException
- ServiceQuotaExceededException
- ConflictException
- PendingVerificationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createParticipantToken
default CompletableFuture<CreateParticipantTokenResponse> createParticipantToken(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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- AccessDeniedException
- ServiceQuotaExceededException
- PendingVerificationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createParticipantToken
default CompletableFuture<CreateParticipantTokenResponse> createParticipantToken(Consumer<CreateParticipantTokenRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateParticipantTokenRequest.Builder
avoiding the need to create one manually viaCreateParticipantTokenRequest.builder()
- Parameters:
createParticipantTokenRequest
- AConsumer
that will call methods onCreateParticipantTokenRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateParticipantToken operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- AccessDeniedException
- ServiceQuotaExceededException
- PendingVerificationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createStage
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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException
- AccessDeniedException
- ServiceQuotaExceededException
- PendingVerificationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createStage
default CompletableFuture<CreateStageResponse> createStage(Consumer<CreateStageRequest.Builder> createStageRequest) Creates a new stage (and optionally participant tokens).
This is a convenience which creates an instance of the
CreateStageRequest.Builder
avoiding the need to create one manually viaCreateStageRequest.builder()
- Parameters:
createStageRequest
- AConsumer
that will call methods onCreateStageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateStage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException
- AccessDeniedException
- ServiceQuotaExceededException
- PendingVerificationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createStorageConfiguration
default CompletableFuture<CreateStorageConfigurationResponse> createStorageConfiguration(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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- AccessDeniedException
- InternalServerException
- ServiceQuotaExceededException
- ConflictException
- PendingVerificationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createStorageConfiguration
default CompletableFuture<CreateStorageConfigurationResponse> createStorageConfiguration(Consumer<CreateStorageConfigurationRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateStorageConfigurationRequest.Builder
avoiding the need to create one manually viaCreateStorageConfigurationRequest.builder()
- Parameters:
createStorageConfigurationRequest
- AConsumer
that will call methods onCreateStorageConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateStorageConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- AccessDeniedException
- InternalServerException
- ServiceQuotaExceededException
- ConflictException
- PendingVerificationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEncoderConfiguration
default CompletableFuture<DeleteEncoderConfigurationResponse> deleteEncoderConfiguration(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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- AccessDeniedException
- InternalServerException
- ServiceQuotaExceededException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEncoderConfiguration
default CompletableFuture<DeleteEncoderConfigurationResponse> deleteEncoderConfiguration(Consumer<DeleteEncoderConfigurationRequest.Builder> deleteEncoderConfigurationRequest) Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.
This is a convenience which creates an instance of the
DeleteEncoderConfigurationRequest.Builder
avoiding the need to create one manually viaDeleteEncoderConfigurationRequest.builder()
- Parameters:
deleteEncoderConfigurationRequest
- AConsumer
that will call methods onDeleteEncoderConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteEncoderConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- AccessDeniedException
- InternalServerException
- ServiceQuotaExceededException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteStage
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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- AccessDeniedException
- ConflictException
- PendingVerificationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteStage
default CompletableFuture<DeleteStageResponse> deleteStage(Consumer<DeleteStageRequest.Builder> deleteStageRequest) Shuts down and deletes the specified stage (disconnecting all participants).
This is a convenience which creates an instance of the
DeleteStageRequest.Builder
avoiding the need to create one manually viaDeleteStageRequest.builder()
- Parameters:
deleteStageRequest
- AConsumer
that will call methods onDeleteStageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteStage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- AccessDeniedException
- ConflictException
- PendingVerificationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteStorageConfiguration
default CompletableFuture<DeleteStorageConfigurationResponse> deleteStorageConfiguration(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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- AccessDeniedException
- InternalServerException
- ServiceQuotaExceededException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteStorageConfiguration
default CompletableFuture<DeleteStorageConfigurationResponse> deleteStorageConfiguration(Consumer<DeleteStorageConfigurationRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteStorageConfigurationRequest.Builder
avoiding the need to create one manually viaDeleteStorageConfigurationRequest.builder()
- Parameters:
deleteStorageConfigurationRequest
- AConsumer
that will call methods onDeleteStorageConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteStorageConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- AccessDeniedException
- InternalServerException
- ServiceQuotaExceededException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disconnectParticipant
default CompletableFuture<DisconnectParticipantResponse> disconnectParticipant(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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- AccessDeniedException
- PendingVerificationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disconnectParticipant
default CompletableFuture<DisconnectParticipantResponse> disconnectParticipant(Consumer<DisconnectParticipantRequest.Builder> disconnectParticipantRequest) Disconnects a specified participant and revokes the participant permanently from a specified stage.
This is a convenience which creates an instance of the
DisconnectParticipantRequest.Builder
avoiding the need to create one manually viaDisconnectParticipantRequest.builder()
- Parameters:
disconnectParticipantRequest
- AConsumer
that will call methods onDisconnectParticipantRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisconnectParticipant operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- AccessDeniedException
- PendingVerificationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getComposition
default CompletableFuture<GetCompositionResponse> getComposition(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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- AccessDeniedException
- InternalServerException
- ServiceQuotaExceededException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getComposition
default CompletableFuture<GetCompositionResponse> getComposition(Consumer<GetCompositionRequest.Builder> getCompositionRequest) Get information about the specified Composition resource.
This is a convenience which creates an instance of the
GetCompositionRequest.Builder
avoiding the need to create one manually viaGetCompositionRequest.builder()
- Parameters:
getCompositionRequest
- AConsumer
that will call methods onGetCompositionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetComposition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- AccessDeniedException
- InternalServerException
- ServiceQuotaExceededException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEncoderConfiguration
default CompletableFuture<GetEncoderConfigurationResponse> getEncoderConfiguration(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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- AccessDeniedException
- InternalServerException
- ServiceQuotaExceededException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEncoderConfiguration
default CompletableFuture<GetEncoderConfigurationResponse> getEncoderConfiguration(Consumer<GetEncoderConfigurationRequest.Builder> getEncoderConfigurationRequest) Gets information about the specified EncoderConfiguration resource.
This is a convenience which creates an instance of the
GetEncoderConfigurationRequest.Builder
avoiding the need to create one manually viaGetEncoderConfigurationRequest.builder()
- Parameters:
getEncoderConfigurationRequest
- AConsumer
that will call methods onGetEncoderConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetEncoderConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- AccessDeniedException
- InternalServerException
- ServiceQuotaExceededException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getParticipant
default CompletableFuture<GetParticipantResponse> getParticipant(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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- AccessDeniedException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getParticipant
default CompletableFuture<GetParticipantResponse> getParticipant(Consumer<GetParticipantRequest.Builder> getParticipantRequest) Gets information about the specified participant token.
This is a convenience which creates an instance of the
GetParticipantRequest.Builder
avoiding the need to create one manually viaGetParticipantRequest.builder()
- Parameters:
getParticipantRequest
- AConsumer
that will call methods onGetParticipantRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetParticipant operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- AccessDeniedException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getStage
Gets information for the specified stage.
- Parameters:
getStageRequest
-- Returns:
- A Java Future containing the result of the GetStage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- AccessDeniedException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getStage
default CompletableFuture<GetStageResponse> getStage(Consumer<GetStageRequest.Builder> getStageRequest) Gets information for the specified stage.
This is a convenience which creates an instance of the
GetStageRequest.Builder
avoiding the need to create one manually viaGetStageRequest.builder()
- Parameters:
getStageRequest
- AConsumer
that will call methods onGetStageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetStage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- AccessDeniedException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getStageSession
default CompletableFuture<GetStageSessionResponse> getStageSession(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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- AccessDeniedException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getStageSession
default CompletableFuture<GetStageSessionResponse> getStageSession(Consumer<GetStageSessionRequest.Builder> getStageSessionRequest) Gets information for the specified stage session.
This is a convenience which creates an instance of the
GetStageSessionRequest.Builder
avoiding the need to create one manually viaGetStageSessionRequest.builder()
- Parameters:
getStageSessionRequest
- AConsumer
that will call methods onGetStageSessionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetStageSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- AccessDeniedException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getStorageConfiguration
default CompletableFuture<GetStorageConfigurationResponse> getStorageConfiguration(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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- AccessDeniedException
- InternalServerException
- ServiceQuotaExceededException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getStorageConfiguration
default CompletableFuture<GetStorageConfigurationResponse> getStorageConfiguration(Consumer<GetStorageConfigurationRequest.Builder> getStorageConfigurationRequest) Gets the storage configuration for the specified ARN.
This is a convenience which creates an instance of the
GetStorageConfigurationRequest.Builder
avoiding the need to create one manually viaGetStorageConfigurationRequest.builder()
- Parameters:
getStorageConfigurationRequest
- AConsumer
that will call methods onGetStorageConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetStorageConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- AccessDeniedException
- InternalServerException
- ServiceQuotaExceededException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCompositions
default CompletableFuture<ListCompositionsResponse> listCompositions(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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException
- AccessDeniedException
- InternalServerException
- ServiceQuotaExceededException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCompositions
default CompletableFuture<ListCompositionsResponse> listCompositions(Consumer<ListCompositionsRequest.Builder> listCompositionsRequest) Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.
This is a convenience which creates an instance of the
ListCompositionsRequest.Builder
avoiding the need to create one manually viaListCompositionsRequest.builder()
- Parameters:
listCompositionsRequest
- AConsumer
that will call methods onListCompositionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListCompositions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException
- AccessDeniedException
- InternalServerException
- ServiceQuotaExceededException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCompositionsPaginator
default ListCompositionsPublisher listCompositionsPaginator(ListCompositionsRequest listCompositionsRequest) This is a variant of
listCompositions(software.amazon.awssdk.services.ivsrealtime.model.ListCompositionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ivsrealtime.paginators.ListCompositionsPublisher publisher = client.listCompositionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ivsrealtime.paginators.ListCompositionsPublisher publisher = client.listCompositionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivsrealtime.model.ListCompositionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ivsrealtime.model.ListCompositionsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCompositions(software.amazon.awssdk.services.ivsrealtime.model.ListCompositionsRequest)
operation.- Parameters:
listCompositionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException
- AccessDeniedException
- InternalServerException
- ServiceQuotaExceededException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCompositionsPaginator
default ListCompositionsPublisher listCompositionsPaginator(Consumer<ListCompositionsRequest.Builder> listCompositionsRequest) This is a variant of
listCompositions(software.amazon.awssdk.services.ivsrealtime.model.ListCompositionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ivsrealtime.paginators.ListCompositionsPublisher publisher = client.listCompositionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ivsrealtime.paginators.ListCompositionsPublisher publisher = client.listCompositionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivsrealtime.model.ListCompositionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ivsrealtime.model.ListCompositionsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCompositions(software.amazon.awssdk.services.ivsrealtime.model.ListCompositionsRequest)
operation.
This is a convenience which creates an instance of the
ListCompositionsRequest.Builder
avoiding the need to create one manually viaListCompositionsRequest.builder()
- Parameters:
listCompositionsRequest
- AConsumer
that will call methods onListCompositionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException
- AccessDeniedException
- InternalServerException
- ServiceQuotaExceededException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEncoderConfigurations
default CompletableFuture<ListEncoderConfigurationsResponse> listEncoderConfigurations(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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException
- AccessDeniedException
- InternalServerException
- ServiceQuotaExceededException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEncoderConfigurations
default CompletableFuture<ListEncoderConfigurationsResponse> listEncoderConfigurations(Consumer<ListEncoderConfigurationsRequest.Builder> listEncoderConfigurationsRequest) Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.
This is a convenience which creates an instance of the
ListEncoderConfigurationsRequest.Builder
avoiding the need to create one manually viaListEncoderConfigurationsRequest.builder()
- Parameters:
listEncoderConfigurationsRequest
- AConsumer
that will call methods onListEncoderConfigurationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListEncoderConfigurations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException
- AccessDeniedException
- InternalServerException
- ServiceQuotaExceededException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEncoderConfigurationsPaginator
default ListEncoderConfigurationsPublisher listEncoderConfigurationsPaginator(ListEncoderConfigurationsRequest listEncoderConfigurationsRequest) This is a variant of
listEncoderConfigurations(software.amazon.awssdk.services.ivsrealtime.model.ListEncoderConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ivsrealtime.paginators.ListEncoderConfigurationsPublisher publisher = client.listEncoderConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ivsrealtime.paginators.ListEncoderConfigurationsPublisher publisher = client.listEncoderConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivsrealtime.model.ListEncoderConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ivsrealtime.model.ListEncoderConfigurationsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEncoderConfigurations(software.amazon.awssdk.services.ivsrealtime.model.ListEncoderConfigurationsRequest)
operation.- Parameters:
listEncoderConfigurationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException
- AccessDeniedException
- InternalServerException
- ServiceQuotaExceededException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEncoderConfigurationsPaginator
default ListEncoderConfigurationsPublisher listEncoderConfigurationsPaginator(Consumer<ListEncoderConfigurationsRequest.Builder> listEncoderConfigurationsRequest) This is a variant of
listEncoderConfigurations(software.amazon.awssdk.services.ivsrealtime.model.ListEncoderConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ivsrealtime.paginators.ListEncoderConfigurationsPublisher publisher = client.listEncoderConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ivsrealtime.paginators.ListEncoderConfigurationsPublisher publisher = client.listEncoderConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivsrealtime.model.ListEncoderConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ivsrealtime.model.ListEncoderConfigurationsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEncoderConfigurations(software.amazon.awssdk.services.ivsrealtime.model.ListEncoderConfigurationsRequest)
operation.
This is a convenience which creates an instance of the
ListEncoderConfigurationsRequest.Builder
avoiding the need to create one manually viaListEncoderConfigurationsRequest.builder()
- Parameters:
listEncoderConfigurationsRequest
- AConsumer
that will call methods onListEncoderConfigurationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException
- AccessDeniedException
- InternalServerException
- ServiceQuotaExceededException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listParticipantEvents
default CompletableFuture<ListParticipantEventsResponse> listParticipantEvents(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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException
- AccessDeniedException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listParticipantEvents
default CompletableFuture<ListParticipantEventsResponse> listParticipantEvents(Consumer<ListParticipantEventsRequest.Builder> listParticipantEventsRequest) Lists events for a specified participant that occurred during a specified stage session.
This is a convenience which creates an instance of the
ListParticipantEventsRequest.Builder
avoiding the need to create one manually viaListParticipantEventsRequest.builder()
- Parameters:
listParticipantEventsRequest
- AConsumer
that will call methods onListParticipantEventsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListParticipantEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException
- AccessDeniedException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listParticipantEventsPaginator
default ListParticipantEventsPublisher listParticipantEventsPaginator(ListParticipantEventsRequest listParticipantEventsRequest) This is a variant of
listParticipantEvents(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ivsrealtime.paginators.ListParticipantEventsPublisher publisher = client.listParticipantEventsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ivsrealtime.paginators.ListParticipantEventsPublisher publisher = client.listParticipantEventsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivsrealtime.model.ListParticipantEventsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantEventsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listParticipantEvents(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantEventsRequest)
operation.- Parameters:
listParticipantEventsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException
- AccessDeniedException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listParticipantEventsPaginator
default ListParticipantEventsPublisher listParticipantEventsPaginator(Consumer<ListParticipantEventsRequest.Builder> listParticipantEventsRequest) This is a variant of
listParticipantEvents(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ivsrealtime.paginators.ListParticipantEventsPublisher publisher = client.listParticipantEventsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ivsrealtime.paginators.ListParticipantEventsPublisher publisher = client.listParticipantEventsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivsrealtime.model.ListParticipantEventsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantEventsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listParticipantEvents(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantEventsRequest)
operation.
This is a convenience which creates an instance of the
ListParticipantEventsRequest.Builder
avoiding the need to create one manually viaListParticipantEventsRequest.builder()
- Parameters:
listParticipantEventsRequest
- AConsumer
that will call methods onListParticipantEventsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException
- AccessDeniedException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listParticipants
default CompletableFuture<ListParticipantsResponse> listParticipants(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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException
- AccessDeniedException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listParticipants
default CompletableFuture<ListParticipantsResponse> listParticipants(Consumer<ListParticipantsRequest.Builder> listParticipantsRequest) Lists all participants in a specified stage session.
This is a convenience which creates an instance of the
ListParticipantsRequest.Builder
avoiding the need to create one manually viaListParticipantsRequest.builder()
- Parameters:
listParticipantsRequest
- AConsumer
that will call methods onListParticipantsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListParticipants operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException
- AccessDeniedException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listParticipantsPaginator
default ListParticipantsPublisher listParticipantsPaginator(ListParticipantsRequest listParticipantsRequest) This is a variant of
listParticipants(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ivsrealtime.paginators.ListParticipantsPublisher publisher = client.listParticipantsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ivsrealtime.paginators.ListParticipantsPublisher publisher = client.listParticipantsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivsrealtime.model.ListParticipantsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listParticipants(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantsRequest)
operation.- Parameters:
listParticipantsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException
- AccessDeniedException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listParticipantsPaginator
default ListParticipantsPublisher listParticipantsPaginator(Consumer<ListParticipantsRequest.Builder> listParticipantsRequest) This is a variant of
listParticipants(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ivsrealtime.paginators.ListParticipantsPublisher publisher = client.listParticipantsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ivsrealtime.paginators.ListParticipantsPublisher publisher = client.listParticipantsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivsrealtime.model.ListParticipantsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listParticipants(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantsRequest)
operation.
This is a convenience which creates an instance of the
ListParticipantsRequest.Builder
avoiding the need to create one manually viaListParticipantsRequest.builder()
- Parameters:
listParticipantsRequest
- AConsumer
that will call methods onListParticipantsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException
- AccessDeniedException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStageSessions
default CompletableFuture<ListStageSessionsResponse> listStageSessions(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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException
- AccessDeniedException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStageSessions
default CompletableFuture<ListStageSessionsResponse> listStageSessions(Consumer<ListStageSessionsRequest.Builder> listStageSessionsRequest) Gets all sessions for a specified stage.
This is a convenience which creates an instance of the
ListStageSessionsRequest.Builder
avoiding the need to create one manually viaListStageSessionsRequest.builder()
- Parameters:
listStageSessionsRequest
- AConsumer
that will call methods onListStageSessionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListStageSessions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException
- AccessDeniedException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStageSessionsPaginator
default ListStageSessionsPublisher listStageSessionsPaginator(ListStageSessionsRequest listStageSessionsRequest) This is a variant of
listStageSessions(software.amazon.awssdk.services.ivsrealtime.model.ListStageSessionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ivsrealtime.paginators.ListStageSessionsPublisher publisher = client.listStageSessionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ivsrealtime.paginators.ListStageSessionsPublisher publisher = client.listStageSessionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivsrealtime.model.ListStageSessionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ivsrealtime.model.ListStageSessionsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStageSessions(software.amazon.awssdk.services.ivsrealtime.model.ListStageSessionsRequest)
operation.- Parameters:
listStageSessionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException
- AccessDeniedException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStageSessionsPaginator
default ListStageSessionsPublisher listStageSessionsPaginator(Consumer<ListStageSessionsRequest.Builder> listStageSessionsRequest) This is a variant of
listStageSessions(software.amazon.awssdk.services.ivsrealtime.model.ListStageSessionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ivsrealtime.paginators.ListStageSessionsPublisher publisher = client.listStageSessionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ivsrealtime.paginators.ListStageSessionsPublisher publisher = client.listStageSessionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivsrealtime.model.ListStageSessionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ivsrealtime.model.ListStageSessionsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStageSessions(software.amazon.awssdk.services.ivsrealtime.model.ListStageSessionsRequest)
operation.
This is a convenience which creates an instance of the
ListStageSessionsRequest.Builder
avoiding the need to create one manually viaListStageSessionsRequest.builder()
- Parameters:
listStageSessionsRequest
- AConsumer
that will call methods onListStageSessionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException
- AccessDeniedException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStages
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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException
- AccessDeniedException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStages
default CompletableFuture<ListStagesResponse> listStages(Consumer<ListStagesRequest.Builder> listStagesRequest) Gets summary information about all stages in your account, in the AWS region where the API request is processed.
This is a convenience which creates an instance of the
ListStagesRequest.Builder
avoiding the need to create one manually viaListStagesRequest.builder()
- Parameters:
listStagesRequest
- AConsumer
that will call methods onListStagesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListStages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException
- AccessDeniedException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStagesPaginator
This is a variant of
listStages(software.amazon.awssdk.services.ivsrealtime.model.ListStagesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ivsrealtime.paginators.ListStagesPublisher publisher = client.listStagesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ivsrealtime.paginators.ListStagesPublisher publisher = client.listStagesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivsrealtime.model.ListStagesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ivsrealtime.model.ListStagesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStages(software.amazon.awssdk.services.ivsrealtime.model.ListStagesRequest)
operation.- Parameters:
listStagesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException
- AccessDeniedException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStagesPaginator
default ListStagesPublisher listStagesPaginator(Consumer<ListStagesRequest.Builder> listStagesRequest) This is a variant of
listStages(software.amazon.awssdk.services.ivsrealtime.model.ListStagesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ivsrealtime.paginators.ListStagesPublisher publisher = client.listStagesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ivsrealtime.paginators.ListStagesPublisher publisher = client.listStagesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivsrealtime.model.ListStagesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ivsrealtime.model.ListStagesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStages(software.amazon.awssdk.services.ivsrealtime.model.ListStagesRequest)
operation.
This is a convenience which creates an instance of the
ListStagesRequest.Builder
avoiding the need to create one manually viaListStagesRequest.builder()
- Parameters:
listStagesRequest
- AConsumer
that will call methods onListStagesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException
- AccessDeniedException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStorageConfigurations
default CompletableFuture<ListStorageConfigurationsResponse> listStorageConfigurations(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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException
- AccessDeniedException
- InternalServerException
- ServiceQuotaExceededException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStorageConfigurations
default CompletableFuture<ListStorageConfigurationsResponse> listStorageConfigurations(Consumer<ListStorageConfigurationsRequest.Builder> listStorageConfigurationsRequest) Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.
This is a convenience which creates an instance of the
ListStorageConfigurationsRequest.Builder
avoiding the need to create one manually viaListStorageConfigurationsRequest.builder()
- Parameters:
listStorageConfigurationsRequest
- AConsumer
that will call methods onListStorageConfigurationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListStorageConfigurations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException
- AccessDeniedException
- InternalServerException
- ServiceQuotaExceededException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStorageConfigurationsPaginator
default ListStorageConfigurationsPublisher listStorageConfigurationsPaginator(ListStorageConfigurationsRequest listStorageConfigurationsRequest) This is a variant of
listStorageConfigurations(software.amazon.awssdk.services.ivsrealtime.model.ListStorageConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ivsrealtime.paginators.ListStorageConfigurationsPublisher publisher = client.listStorageConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ivsrealtime.paginators.ListStorageConfigurationsPublisher publisher = client.listStorageConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivsrealtime.model.ListStorageConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ivsrealtime.model.ListStorageConfigurationsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStorageConfigurations(software.amazon.awssdk.services.ivsrealtime.model.ListStorageConfigurationsRequest)
operation.- Parameters:
listStorageConfigurationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException
- AccessDeniedException
- InternalServerException
- ServiceQuotaExceededException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStorageConfigurationsPaginator
default ListStorageConfigurationsPublisher listStorageConfigurationsPaginator(Consumer<ListStorageConfigurationsRequest.Builder> listStorageConfigurationsRequest) This is a variant of
listStorageConfigurations(software.amazon.awssdk.services.ivsrealtime.model.ListStorageConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ivsrealtime.paginators.ListStorageConfigurationsPublisher publisher = client.listStorageConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ivsrealtime.paginators.ListStorageConfigurationsPublisher publisher = client.listStorageConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivsrealtime.model.ListStorageConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ivsrealtime.model.ListStorageConfigurationsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStorageConfigurations(software.amazon.awssdk.services.ivsrealtime.model.ListStorageConfigurationsRequest)
operation.
This is a convenience which creates an instance of the
ListStorageConfigurationsRequest.Builder
avoiding the need to create one manually viaListStorageConfigurationsRequest.builder()
- Parameters:
listStorageConfigurationsRequest
- AConsumer
that will call methods onListStorageConfigurationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException
- AccessDeniedException
- InternalServerException
- ServiceQuotaExceededException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- InternalServerException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Gets information about AWS tags for the specified ARN.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- InternalServerException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startComposition
default CompletableFuture<StartCompositionResponse> startComposition(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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- AccessDeniedException
- InternalServerException
- ServiceQuotaExceededException
- ConflictException
- PendingVerificationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
startComposition
default CompletableFuture<StartCompositionResponse> startComposition(Consumer<StartCompositionRequest.Builder> 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.
This is a convenience which creates an instance of the
StartCompositionRequest.Builder
avoiding the need to create one manually viaStartCompositionRequest.builder()
- Parameters:
startCompositionRequest
- AConsumer
that will call methods onStartCompositionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartComposition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- AccessDeniedException
- InternalServerException
- ServiceQuotaExceededException
- ConflictException
- PendingVerificationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
stopComposition
default CompletableFuture<StopCompositionResponse> stopComposition(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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- AccessDeniedException
- InternalServerException
- ServiceQuotaExceededException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopComposition
default CompletableFuture<StopCompositionResponse> stopComposition(Consumer<StopCompositionRequest.Builder> stopCompositionRequest) Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.
This is a convenience which creates an instance of the
StopCompositionRequest.Builder
avoiding the need to create one manually viaStopCompositionRequest.builder()
- Parameters:
stopCompositionRequest
- AConsumer
that will call methods onStopCompositionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopComposition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- AccessDeniedException
- InternalServerException
- ServiceQuotaExceededException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- InternalServerException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds or updates tags for the AWS resource with the specified ARN.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- InternalServerException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- InternalServerException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from the resource with the specified ARN.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- InternalServerException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateStage
Updates a stage’s configuration.
- Parameters:
updateStageRequest
-- Returns:
- A Java Future containing the result of the UpdateStage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- AccessDeniedException
- ServiceQuotaExceededException
- ConflictException
- PendingVerificationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateStage
default CompletableFuture<UpdateStageResponse> updateStage(Consumer<UpdateStageRequest.Builder> updateStageRequest) Updates a stage’s configuration.
This is a convenience which creates an instance of the
UpdateStageRequest.Builder
avoiding the need to create one manually viaUpdateStageRequest.builder()
- Parameters:
updateStageRequest
- AConsumer
that will call methods onUpdateStageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateStage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException
- ValidationException
- AccessDeniedException
- ServiceQuotaExceededException
- ConflictException
- PendingVerificationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsRealTimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aIvsRealTimeAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aIvsRealTimeAsyncClient
.
-