Interface IvsRealTimeClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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 TypeMethodDescriptionstatic IvsRealTimeClientBuilder
builder()
Create a builder that can be used to configure and create aIvsRealTimeClient
.static IvsRealTimeClient
create()
Create aIvsRealTimeClient
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.default CreateParticipantTokenResponse
createParticipantToken
(Consumer<CreateParticipantTokenRequest.Builder> createParticipantTokenRequest) Creates an additional token for a specified stage.default CreateParticipantTokenResponse
createParticipantToken
(CreateParticipantTokenRequest createParticipantTokenRequest) Creates an additional token for a specified stage.default CreateStageResponse
createStage
(Consumer<CreateStageRequest.Builder> createStageRequest) Creates a new stage (and optionally participant tokens).default 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 DeleteStageResponse
deleteStage
(Consumer<DeleteStageRequest.Builder> deleteStageRequest) Shuts down and deletes the specified stage (disconnecting all participants).default 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.default DisconnectParticipantResponse
disconnectParticipant
(Consumer<DisconnectParticipantRequest.Builder> disconnectParticipantRequest) Disconnects a specified participant and revokes the participant permanently from a specified stage.default DisconnectParticipantResponse
disconnectParticipant
(DisconnectParticipantRequest disconnectParticipantRequest) Disconnects a specified participant and revokes the participant permanently from a specified stage.default GetCompositionResponse
getComposition
(Consumer<GetCompositionRequest.Builder> getCompositionRequest) Get information about the specified Composition resource.default GetCompositionResponse
getComposition
(GetCompositionRequest getCompositionRequest) Get information about the specified Composition resource.default GetEncoderConfigurationResponse
getEncoderConfiguration
(Consumer<GetEncoderConfigurationRequest.Builder> getEncoderConfigurationRequest) Gets information about the specified EncoderConfiguration resource.default GetEncoderConfigurationResponse
getEncoderConfiguration
(GetEncoderConfigurationRequest getEncoderConfigurationRequest) Gets information about the specified EncoderConfiguration resource.default GetParticipantResponse
getParticipant
(Consumer<GetParticipantRequest.Builder> getParticipantRequest) Gets information about the specified participant token.default GetParticipantResponse
getParticipant
(GetParticipantRequest getParticipantRequest) Gets information about the specified participant token.default GetStageResponse
getStage
(Consumer<GetStageRequest.Builder> getStageRequest) Gets information for the specified stage.default GetStageResponse
getStage
(GetStageRequest getStageRequest) Gets information for the specified stage.default GetStageSessionResponse
getStageSession
(Consumer<GetStageSessionRequest.Builder> getStageSessionRequest) Gets information for the specified stage session.default GetStageSessionResponse
getStageSession
(GetStageSessionRequest getStageSessionRequest) Gets information for the specified stage session.default GetStorageConfigurationResponse
getStorageConfiguration
(Consumer<GetStorageConfigurationRequest.Builder> getStorageConfigurationRequest) Gets the storage configuration for the specified ARN.default GetStorageConfigurationResponse
getStorageConfiguration
(GetStorageConfigurationRequest getStorageConfigurationRequest) Gets the storage configuration for the specified ARN.default 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.default ListCompositionsResponse
listCompositions
(ListCompositionsRequest listCompositionsRequest) Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.default ListCompositionsIterable
listCompositionsPaginator
(Consumer<ListCompositionsRequest.Builder> listCompositionsRequest) This is a variant oflistCompositions(software.amazon.awssdk.services.ivsrealtime.model.ListCompositionsRequest)
operation.default ListCompositionsIterable
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.default ListParticipantEventsResponse
listParticipantEvents
(Consumer<ListParticipantEventsRequest.Builder> listParticipantEventsRequest) Lists events for a specified participant that occurred during a specified stage session.default ListParticipantEventsResponse
listParticipantEvents
(ListParticipantEventsRequest listParticipantEventsRequest) Lists events for a specified participant that occurred during a specified stage session.default ListParticipantEventsIterable
listParticipantEventsPaginator
(Consumer<ListParticipantEventsRequest.Builder> listParticipantEventsRequest) This is a variant oflistParticipantEvents(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantEventsRequest)
operation.default ListParticipantEventsIterable
listParticipantEventsPaginator
(ListParticipantEventsRequest listParticipantEventsRequest) This is a variant oflistParticipantEvents(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantEventsRequest)
operation.default ListParticipantsResponse
listParticipants
(Consumer<ListParticipantsRequest.Builder> listParticipantsRequest) Lists all participants in a specified stage session.default ListParticipantsResponse
listParticipants
(ListParticipantsRequest listParticipantsRequest) Lists all participants in a specified stage session.default ListParticipantsIterable
listParticipantsPaginator
(Consumer<ListParticipantsRequest.Builder> listParticipantsRequest) This is a variant oflistParticipants(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantsRequest)
operation.default ListParticipantsIterable
listParticipantsPaginator
(ListParticipantsRequest listParticipantsRequest) This is a variant oflistParticipants(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantsRequest)
operation.default 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 ListStagesResponse
listStages
(ListStagesRequest listStagesRequest) Gets summary information about all stages in your account, in the AWS region where the API request is processed.default ListStageSessionsResponse
listStageSessions
(Consumer<ListStageSessionsRequest.Builder> listStageSessionsRequest) Gets all sessions for a specified stage.default ListStageSessionsResponse
listStageSessions
(ListStageSessionsRequest listStageSessionsRequest) Gets all sessions for a specified stage.default ListStageSessionsIterable
listStageSessionsPaginator
(Consumer<ListStageSessionsRequest.Builder> listStageSessionsRequest) This is a variant oflistStageSessions(software.amazon.awssdk.services.ivsrealtime.model.ListStageSessionsRequest)
operation.default ListStageSessionsIterable
listStageSessionsPaginator
(ListStageSessionsRequest listStageSessionsRequest) This is a variant oflistStageSessions(software.amazon.awssdk.services.ivsrealtime.model.ListStageSessionsRequest)
operation.default ListStagesIterable
listStagesPaginator
(Consumer<ListStagesRequest.Builder> listStagesRequest) This is a variant oflistStages(software.amazon.awssdk.services.ivsrealtime.model.ListStagesRequest)
operation.default ListStagesIterable
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.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Gets information about AWS tags for the specified ARN.default ListTagsForResourceResponse
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., ClientOverrideConfigurationstatic ServiceMetadata
default StartCompositionResponse
startComposition
(Consumer<StartCompositionRequest.Builder> startCompositionRequest) Starts a Composition from a stage based on the configuration provided in the request.default StartCompositionResponse
startComposition
(StartCompositionRequest startCompositionRequest) Starts a Composition from a stage based on the configuration provided in the request.default StopCompositionResponse
stopComposition
(Consumer<StopCompositionRequest.Builder> stopCompositionRequest) Stops and deletes a Composition resource.default StopCompositionResponse
stopComposition
(StopCompositionRequest stopCompositionRequest) Stops and deletes a Composition resource.default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds or updates tags for the AWS resource with the specified ARN.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Adds or updates tags for the AWS resource with the specified ARN.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from the resource with the specified ARN.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes tags from the resource with the specified ARN.default UpdateStageResponse
updateStage
(Consumer<UpdateStageRequest.Builder> updateStageRequest) Updates a stage’s configuration.default 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 CreateEncoderConfigurationResponse createEncoderConfiguration(CreateEncoderConfigurationRequest createEncoderConfigurationRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, ConflictException, PendingVerificationException, AwsServiceException, SdkClientException, IvsRealTimeException Creates an EncoderConfiguration object.
- Parameters:
createEncoderConfigurationRequest
-- Returns:
- Result of the CreateEncoderConfiguration operation returned by the service.
- See Also:
-
createEncoderConfiguration
default CreateEncoderConfigurationResponse createEncoderConfiguration(Consumer<CreateEncoderConfigurationRequest.Builder> createEncoderConfigurationRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, ConflictException, PendingVerificationException, AwsServiceException, SdkClientException, IvsRealTimeException 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:
- Result of the CreateEncoderConfiguration operation returned by the service.
- See Also:
-
createParticipantToken
default CreateParticipantTokenResponse createParticipantToken(CreateParticipantTokenRequest createParticipantTokenRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, PendingVerificationException, AwsServiceException, SdkClientException, IvsRealTimeException 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:
- Result of the CreateParticipantToken operation returned by the service.
- See Also:
-
createParticipantToken
default CreateParticipantTokenResponse createParticipantToken(Consumer<CreateParticipantTokenRequest.Builder> createParticipantTokenRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, PendingVerificationException, AwsServiceException, SdkClientException, IvsRealTimeException 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:
- Result of the CreateParticipantToken operation returned by the service.
- See Also:
-
createStage
default CreateStageResponse createStage(CreateStageRequest createStageRequest) throws ValidationException, AccessDeniedException, ServiceQuotaExceededException, PendingVerificationException, AwsServiceException, SdkClientException, IvsRealTimeException Creates a new stage (and optionally participant tokens).
- Parameters:
createStageRequest
-- Returns:
- Result of the CreateStage operation returned by the service.
- See Also:
-
createStage
default CreateStageResponse createStage(Consumer<CreateStageRequest.Builder> createStageRequest) throws ValidationException, AccessDeniedException, ServiceQuotaExceededException, PendingVerificationException, AwsServiceException, SdkClientException, IvsRealTimeException 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:
- Result of the CreateStage operation returned by the service.
- See Also:
-
createStorageConfiguration
default CreateStorageConfigurationResponse createStorageConfiguration(CreateStorageConfigurationRequest createStorageConfigurationRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, ConflictException, PendingVerificationException, AwsServiceException, SdkClientException, IvsRealTimeException 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:
- Result of the CreateStorageConfiguration operation returned by the service.
- See Also:
-
createStorageConfiguration
default CreateStorageConfigurationResponse createStorageConfiguration(Consumer<CreateStorageConfigurationRequest.Builder> createStorageConfigurationRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, ConflictException, PendingVerificationException, AwsServiceException, SdkClientException, IvsRealTimeException 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:
- Result of the CreateStorageConfiguration operation returned by the service.
- See Also:
-
deleteEncoderConfiguration
default DeleteEncoderConfigurationResponse deleteEncoderConfiguration(DeleteEncoderConfigurationRequest deleteEncoderConfigurationRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, ConflictException, AwsServiceException, SdkClientException, IvsRealTimeException Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.
- Parameters:
deleteEncoderConfigurationRequest
-- Returns:
- Result of the DeleteEncoderConfiguration operation returned by the service.
- See Also:
-
deleteEncoderConfiguration
default DeleteEncoderConfigurationResponse deleteEncoderConfiguration(Consumer<DeleteEncoderConfigurationRequest.Builder> deleteEncoderConfigurationRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, ConflictException, AwsServiceException, SdkClientException, IvsRealTimeException 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:
- Result of the DeleteEncoderConfiguration operation returned by the service.
- See Also:
-
deleteStage
default DeleteStageResponse deleteStage(DeleteStageRequest deleteStageRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, ConflictException, PendingVerificationException, AwsServiceException, SdkClientException, IvsRealTimeException Shuts down and deletes the specified stage (disconnecting all participants).
- Parameters:
deleteStageRequest
-- Returns:
- Result of the DeleteStage operation returned by the service.
- See Also:
-
deleteStage
default DeleteStageResponse deleteStage(Consumer<DeleteStageRequest.Builder> deleteStageRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, ConflictException, PendingVerificationException, AwsServiceException, SdkClientException, IvsRealTimeException 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:
- Result of the DeleteStage operation returned by the service.
- See Also:
-
deleteStorageConfiguration
default DeleteStorageConfigurationResponse deleteStorageConfiguration(DeleteStorageConfigurationRequest deleteStorageConfigurationRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, ConflictException, AwsServiceException, SdkClientException, IvsRealTimeException 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:
- Result of the DeleteStorageConfiguration operation returned by the service.
- See Also:
-
deleteStorageConfiguration
default DeleteStorageConfigurationResponse deleteStorageConfiguration(Consumer<DeleteStorageConfigurationRequest.Builder> deleteStorageConfigurationRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, ConflictException, AwsServiceException, SdkClientException, IvsRealTimeException 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:
- Result of the DeleteStorageConfiguration operation returned by the service.
- See Also:
-
disconnectParticipant
default DisconnectParticipantResponse disconnectParticipant(DisconnectParticipantRequest disconnectParticipantRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, PendingVerificationException, AwsServiceException, SdkClientException, IvsRealTimeException Disconnects a specified participant and revokes the participant permanently from a specified stage.
- Parameters:
disconnectParticipantRequest
-- Returns:
- Result of the DisconnectParticipant operation returned by the service.
- See Also:
-
disconnectParticipant
default DisconnectParticipantResponse disconnectParticipant(Consumer<DisconnectParticipantRequest.Builder> disconnectParticipantRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, PendingVerificationException, AwsServiceException, SdkClientException, IvsRealTimeException 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:
- Result of the DisconnectParticipant operation returned by the service.
- See Also:
-
getComposition
default GetCompositionResponse getComposition(GetCompositionRequest getCompositionRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, ConflictException, AwsServiceException, SdkClientException, IvsRealTimeException Get information about the specified Composition resource.
- Parameters:
getCompositionRequest
-- Returns:
- Result of the GetComposition operation returned by the service.
- See Also:
-
getComposition
default GetCompositionResponse getComposition(Consumer<GetCompositionRequest.Builder> getCompositionRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, ConflictException, AwsServiceException, SdkClientException, IvsRealTimeException 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:
- Result of the GetComposition operation returned by the service.
- See Also:
-
getEncoderConfiguration
default GetEncoderConfigurationResponse getEncoderConfiguration(GetEncoderConfigurationRequest getEncoderConfigurationRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, ConflictException, AwsServiceException, SdkClientException, IvsRealTimeException Gets information about the specified EncoderConfiguration resource.
- Parameters:
getEncoderConfigurationRequest
-- Returns:
- Result of the GetEncoderConfiguration operation returned by the service.
- See Also:
-
getEncoderConfiguration
default GetEncoderConfigurationResponse getEncoderConfiguration(Consumer<GetEncoderConfigurationRequest.Builder> getEncoderConfigurationRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, ConflictException, AwsServiceException, SdkClientException, IvsRealTimeException 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:
- Result of the GetEncoderConfiguration operation returned by the service.
- See Also:
-
getParticipant
default GetParticipantResponse getParticipant(GetParticipantRequest getParticipantRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, IvsRealTimeException Gets information about the specified participant token.
- Parameters:
getParticipantRequest
-- Returns:
- Result of the GetParticipant operation returned by the service.
- See Also:
-
getParticipant
default GetParticipantResponse getParticipant(Consumer<GetParticipantRequest.Builder> getParticipantRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, IvsRealTimeException 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:
- Result of the GetParticipant operation returned by the service.
- See Also:
-
getStage
default GetStageResponse getStage(GetStageRequest getStageRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, IvsRealTimeException Gets information for the specified stage.
- Parameters:
getStageRequest
-- Returns:
- Result of the GetStage operation returned by the service.
- See Also:
-
getStage
default GetStageResponse getStage(Consumer<GetStageRequest.Builder> getStageRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, IvsRealTimeException 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:
- Result of the GetStage operation returned by the service.
- See Also:
-
getStageSession
default GetStageSessionResponse getStageSession(GetStageSessionRequest getStageSessionRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, IvsRealTimeException Gets information for the specified stage session.
- Parameters:
getStageSessionRequest
-- Returns:
- Result of the GetStageSession operation returned by the service.
- See Also:
-
getStageSession
default GetStageSessionResponse getStageSession(Consumer<GetStageSessionRequest.Builder> getStageSessionRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, IvsRealTimeException 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:
- Result of the GetStageSession operation returned by the service.
- See Also:
-
getStorageConfiguration
default GetStorageConfigurationResponse getStorageConfiguration(GetStorageConfigurationRequest getStorageConfigurationRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, ConflictException, AwsServiceException, SdkClientException, IvsRealTimeException Gets the storage configuration for the specified ARN.
- Parameters:
getStorageConfigurationRequest
-- Returns:
- Result of the GetStorageConfiguration operation returned by the service.
- See Also:
-
getStorageConfiguration
default GetStorageConfigurationResponse getStorageConfiguration(Consumer<GetStorageConfigurationRequest.Builder> getStorageConfigurationRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, ConflictException, AwsServiceException, SdkClientException, IvsRealTimeException 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:
- Result of the GetStorageConfiguration operation returned by the service.
- See Also:
-
listCompositions
default ListCompositionsResponse listCompositions(ListCompositionsRequest listCompositionsRequest) throws ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, ConflictException, AwsServiceException, SdkClientException, IvsRealTimeException Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.
- Parameters:
listCompositionsRequest
-- Returns:
- Result of the ListCompositions operation returned by the service.
- See Also:
-
listCompositions
default ListCompositionsResponse listCompositions(Consumer<ListCompositionsRequest.Builder> listCompositionsRequest) throws ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, ConflictException, AwsServiceException, SdkClientException, IvsRealTimeException 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:
- Result of the ListCompositions operation returned by the service.
- See Also:
-
listCompositionsPaginator
default ListCompositionsIterable listCompositionsPaginator(ListCompositionsRequest listCompositionsRequest) throws ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, ConflictException, AwsServiceException, SdkClientException, IvsRealTimeException This is a variant of
listCompositions(software.amazon.awssdk.services.ivsrealtime.model.ListCompositionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ivsrealtime.paginators.ListCompositionsIterable responses = client.listCompositionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ivsrealtime.paginators.ListCompositionsIterable responses = client .listCompositionsPaginator(request); for (software.amazon.awssdk.services.ivsrealtime.model.ListCompositionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ivsrealtime.paginators.ListCompositionsIterable responses = client.listCompositionsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listCompositionsPaginator
default ListCompositionsIterable listCompositionsPaginator(Consumer<ListCompositionsRequest.Builder> listCompositionsRequest) throws ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, ConflictException, AwsServiceException, SdkClientException, IvsRealTimeException This is a variant of
listCompositions(software.amazon.awssdk.services.ivsrealtime.model.ListCompositionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ivsrealtime.paginators.ListCompositionsIterable responses = client.listCompositionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ivsrealtime.paginators.ListCompositionsIterable responses = client .listCompositionsPaginator(request); for (software.amazon.awssdk.services.ivsrealtime.model.ListCompositionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ivsrealtime.paginators.ListCompositionsIterable responses = client.listCompositionsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listEncoderConfigurations
default ListEncoderConfigurationsResponse listEncoderConfigurations(ListEncoderConfigurationsRequest listEncoderConfigurationsRequest) throws ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, ConflictException, AwsServiceException, SdkClientException, IvsRealTimeException Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.
- Parameters:
listEncoderConfigurationsRequest
-- Returns:
- Result of the ListEncoderConfigurations operation returned by the service.
- See Also:
-
listEncoderConfigurations
default ListEncoderConfigurationsResponse listEncoderConfigurations(Consumer<ListEncoderConfigurationsRequest.Builder> listEncoderConfigurationsRequest) throws ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, ConflictException, AwsServiceException, SdkClientException, IvsRealTimeException 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:
- Result of the ListEncoderConfigurations operation returned by the service.
- See Also:
-
listEncoderConfigurationsPaginator
default ListEncoderConfigurationsIterable listEncoderConfigurationsPaginator(ListEncoderConfigurationsRequest listEncoderConfigurationsRequest) throws ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, ConflictException, AwsServiceException, SdkClientException, IvsRealTimeException This is a variant of
listEncoderConfigurations(software.amazon.awssdk.services.ivsrealtime.model.ListEncoderConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ivsrealtime.paginators.ListEncoderConfigurationsIterable responses = client.listEncoderConfigurationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ivsrealtime.paginators.ListEncoderConfigurationsIterable responses = client .listEncoderConfigurationsPaginator(request); for (software.amazon.awssdk.services.ivsrealtime.model.ListEncoderConfigurationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ivsrealtime.paginators.ListEncoderConfigurationsIterable responses = client.listEncoderConfigurationsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listEncoderConfigurationsPaginator
default ListEncoderConfigurationsIterable listEncoderConfigurationsPaginator(Consumer<ListEncoderConfigurationsRequest.Builder> listEncoderConfigurationsRequest) throws ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, ConflictException, AwsServiceException, SdkClientException, IvsRealTimeException This is a variant of
listEncoderConfigurations(software.amazon.awssdk.services.ivsrealtime.model.ListEncoderConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ivsrealtime.paginators.ListEncoderConfigurationsIterable responses = client.listEncoderConfigurationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ivsrealtime.paginators.ListEncoderConfigurationsIterable responses = client .listEncoderConfigurationsPaginator(request); for (software.amazon.awssdk.services.ivsrealtime.model.ListEncoderConfigurationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ivsrealtime.paginators.ListEncoderConfigurationsIterable responses = client.listEncoderConfigurationsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listParticipantEvents
default ListParticipantEventsResponse listParticipantEvents(ListParticipantEventsRequest listParticipantEventsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, IvsRealTimeException Lists events for a specified participant that occurred during a specified stage session.
- Parameters:
listParticipantEventsRequest
-- Returns:
- Result of the ListParticipantEvents operation returned by the service.
- See Also:
-
listParticipantEvents
default ListParticipantEventsResponse listParticipantEvents(Consumer<ListParticipantEventsRequest.Builder> listParticipantEventsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, IvsRealTimeException 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:
- Result of the ListParticipantEvents operation returned by the service.
- See Also:
-
listParticipantEventsPaginator
default ListParticipantEventsIterable listParticipantEventsPaginator(ListParticipantEventsRequest listParticipantEventsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, IvsRealTimeException This is a variant of
listParticipantEvents(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ivsrealtime.paginators.ListParticipantEventsIterable responses = client.listParticipantEventsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ivsrealtime.paginators.ListParticipantEventsIterable responses = client .listParticipantEventsPaginator(request); for (software.amazon.awssdk.services.ivsrealtime.model.ListParticipantEventsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ivsrealtime.paginators.ListParticipantEventsIterable responses = client.listParticipantEventsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listParticipantEventsPaginator
default ListParticipantEventsIterable listParticipantEventsPaginator(Consumer<ListParticipantEventsRequest.Builder> listParticipantEventsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, IvsRealTimeException This is a variant of
listParticipantEvents(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ivsrealtime.paginators.ListParticipantEventsIterable responses = client.listParticipantEventsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ivsrealtime.paginators.ListParticipantEventsIterable responses = client .listParticipantEventsPaginator(request); for (software.amazon.awssdk.services.ivsrealtime.model.ListParticipantEventsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ivsrealtime.paginators.ListParticipantEventsIterable responses = client.listParticipantEventsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listParticipants
default ListParticipantsResponse listParticipants(ListParticipantsRequest listParticipantsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, IvsRealTimeException Lists all participants in a specified stage session.
- Parameters:
listParticipantsRequest
-- Returns:
- Result of the ListParticipants operation returned by the service.
- See Also:
-
listParticipants
default ListParticipantsResponse listParticipants(Consumer<ListParticipantsRequest.Builder> listParticipantsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, IvsRealTimeException 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:
- Result of the ListParticipants operation returned by the service.
- See Also:
-
listParticipantsPaginator
default ListParticipantsIterable listParticipantsPaginator(ListParticipantsRequest listParticipantsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, IvsRealTimeException This is a variant of
listParticipants(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ivsrealtime.paginators.ListParticipantsIterable responses = client.listParticipantsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ivsrealtime.paginators.ListParticipantsIterable responses = client .listParticipantsPaginator(request); for (software.amazon.awssdk.services.ivsrealtime.model.ListParticipantsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ivsrealtime.paginators.ListParticipantsIterable responses = client.listParticipantsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listParticipantsPaginator
default ListParticipantsIterable listParticipantsPaginator(Consumer<ListParticipantsRequest.Builder> listParticipantsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, IvsRealTimeException This is a variant of
listParticipants(software.amazon.awssdk.services.ivsrealtime.model.ListParticipantsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ivsrealtime.paginators.ListParticipantsIterable responses = client.listParticipantsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ivsrealtime.paginators.ListParticipantsIterable responses = client .listParticipantsPaginator(request); for (software.amazon.awssdk.services.ivsrealtime.model.ListParticipantsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ivsrealtime.paginators.ListParticipantsIterable responses = client.listParticipantsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listStageSessions
default ListStageSessionsResponse listStageSessions(ListStageSessionsRequest listStageSessionsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, IvsRealTimeException Gets all sessions for a specified stage.
- Parameters:
listStageSessionsRequest
-- Returns:
- Result of the ListStageSessions operation returned by the service.
- See Also:
-
listStageSessions
default ListStageSessionsResponse listStageSessions(Consumer<ListStageSessionsRequest.Builder> listStageSessionsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, IvsRealTimeException 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:
- Result of the ListStageSessions operation returned by the service.
- See Also:
-
listStageSessionsPaginator
default ListStageSessionsIterable listStageSessionsPaginator(ListStageSessionsRequest listStageSessionsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, IvsRealTimeException This is a variant of
listStageSessions(software.amazon.awssdk.services.ivsrealtime.model.ListStageSessionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ivsrealtime.paginators.ListStageSessionsIterable responses = client.listStageSessionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ivsrealtime.paginators.ListStageSessionsIterable responses = client .listStageSessionsPaginator(request); for (software.amazon.awssdk.services.ivsrealtime.model.ListStageSessionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ivsrealtime.paginators.ListStageSessionsIterable responses = client.listStageSessionsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listStageSessionsPaginator
default ListStageSessionsIterable listStageSessionsPaginator(Consumer<ListStageSessionsRequest.Builder> listStageSessionsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, IvsRealTimeException This is a variant of
listStageSessions(software.amazon.awssdk.services.ivsrealtime.model.ListStageSessionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ivsrealtime.paginators.ListStageSessionsIterable responses = client.listStageSessionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ivsrealtime.paginators.ListStageSessionsIterable responses = client .listStageSessionsPaginator(request); for (software.amazon.awssdk.services.ivsrealtime.model.ListStageSessionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ivsrealtime.paginators.ListStageSessionsIterable responses = client.listStageSessionsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listStages
default ListStagesResponse listStages(ListStagesRequest listStagesRequest) throws ValidationException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, IvsRealTimeException Gets summary information about all stages in your account, in the AWS region where the API request is processed.
- Parameters:
listStagesRequest
-- Returns:
- Result of the ListStages operation returned by the service.
- See Also:
-
listStages
default ListStagesResponse listStages(Consumer<ListStagesRequest.Builder> listStagesRequest) throws ValidationException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, IvsRealTimeException 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:
- Result of the ListStages operation returned by the service.
- See Also:
-
listStagesPaginator
default ListStagesIterable listStagesPaginator(ListStagesRequest listStagesRequest) throws ValidationException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, IvsRealTimeException This is a variant of
listStages(software.amazon.awssdk.services.ivsrealtime.model.ListStagesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ivsrealtime.paginators.ListStagesIterable responses = client.listStagesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ivsrealtime.paginators.ListStagesIterable responses = client.listStagesPaginator(request); for (software.amazon.awssdk.services.ivsrealtime.model.ListStagesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ivsrealtime.paginators.ListStagesIterable responses = client.listStagesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listStagesPaginator
default ListStagesIterable listStagesPaginator(Consumer<ListStagesRequest.Builder> listStagesRequest) throws ValidationException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, IvsRealTimeException This is a variant of
listStages(software.amazon.awssdk.services.ivsrealtime.model.ListStagesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ivsrealtime.paginators.ListStagesIterable responses = client.listStagesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ivsrealtime.paginators.ListStagesIterable responses = client.listStagesPaginator(request); for (software.amazon.awssdk.services.ivsrealtime.model.ListStagesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ivsrealtime.paginators.ListStagesIterable responses = client.listStagesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listStorageConfigurations
default ListStorageConfigurationsResponse listStorageConfigurations(ListStorageConfigurationsRequest listStorageConfigurationsRequest) throws ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, ConflictException, AwsServiceException, SdkClientException, IvsRealTimeException Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.
- Parameters:
listStorageConfigurationsRequest
-- Returns:
- Result of the ListStorageConfigurations operation returned by the service.
- See Also:
-
listStorageConfigurations
default ListStorageConfigurationsResponse listStorageConfigurations(Consumer<ListStorageConfigurationsRequest.Builder> listStorageConfigurationsRequest) throws ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, ConflictException, AwsServiceException, SdkClientException, IvsRealTimeException 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:
- Result of the ListStorageConfigurations operation returned by the service.
- See Also:
-
listStorageConfigurationsPaginator
default ListStorageConfigurationsIterable listStorageConfigurationsPaginator(ListStorageConfigurationsRequest listStorageConfigurationsRequest) throws ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, ConflictException, AwsServiceException, SdkClientException, IvsRealTimeException This is a variant of
listStorageConfigurations(software.amazon.awssdk.services.ivsrealtime.model.ListStorageConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ivsrealtime.paginators.ListStorageConfigurationsIterable responses = client.listStorageConfigurationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ivsrealtime.paginators.ListStorageConfigurationsIterable responses = client .listStorageConfigurationsPaginator(request); for (software.amazon.awssdk.services.ivsrealtime.model.ListStorageConfigurationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ivsrealtime.paginators.ListStorageConfigurationsIterable responses = client.listStorageConfigurationsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listStorageConfigurationsPaginator
default ListStorageConfigurationsIterable listStorageConfigurationsPaginator(Consumer<ListStorageConfigurationsRequest.Builder> listStorageConfigurationsRequest) throws ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, ConflictException, AwsServiceException, SdkClientException, IvsRealTimeException This is a variant of
listStorageConfigurations(software.amazon.awssdk.services.ivsrealtime.model.ListStorageConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ivsrealtime.paginators.ListStorageConfigurationsIterable responses = client.listStorageConfigurationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ivsrealtime.paginators.ListStorageConfigurationsIterable responses = client .listStorageConfigurationsPaginator(request); for (software.amazon.awssdk.services.ivsrealtime.model.ListStorageConfigurationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ivsrealtime.paginators.ListStorageConfigurationsIterable responses = client.listStorageConfigurationsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, IvsRealTimeException Gets information about AWS tags for the specified ARN.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, IvsRealTimeException 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:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
startComposition
default StartCompositionResponse startComposition(StartCompositionRequest startCompositionRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, ConflictException, PendingVerificationException, AwsServiceException, SdkClientException, IvsRealTimeException 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:
- Result of the StartComposition operation returned by the service.
- See Also:
-
-
startComposition
default StartCompositionResponse startComposition(Consumer<StartCompositionRequest.Builder> startCompositionRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, ConflictException, PendingVerificationException, AwsServiceException, SdkClientException, IvsRealTimeException 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:
- Result of the StartComposition operation returned by the service.
- See Also:
-
-
stopComposition
default StopCompositionResponse stopComposition(StopCompositionRequest stopCompositionRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, ConflictException, AwsServiceException, SdkClientException, IvsRealTimeException Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.
- Parameters:
stopCompositionRequest
-- Returns:
- Result of the StopComposition operation returned by the service.
- See Also:
-
stopComposition
default StopCompositionResponse stopComposition(Consumer<StopCompositionRequest.Builder> stopCompositionRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, InternalServerException, ServiceQuotaExceededException, ConflictException, AwsServiceException, SdkClientException, IvsRealTimeException 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:
- Result of the StopComposition operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, IvsRealTimeException Adds or updates tags for the AWS resource with the specified ARN.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, IvsRealTimeException 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:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, IvsRealTimeException Removes tags from the resource with the specified ARN.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, IvsRealTimeException 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:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateStage
default UpdateStageResponse updateStage(UpdateStageRequest updateStageRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, ConflictException, PendingVerificationException, AwsServiceException, SdkClientException, IvsRealTimeException Updates a stage’s configuration.
- Parameters:
updateStageRequest
-- Returns:
- Result of the UpdateStage operation returned by the service.
- See Also:
-
updateStage
default UpdateStageResponse updateStage(Consumer<UpdateStageRequest.Builder> updateStageRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, ConflictException, PendingVerificationException, AwsServiceException, SdkClientException, IvsRealTimeException 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:
- Result of the UpdateStage operation returned by the service.
- See Also:
-
create
Create aIvsRealTimeClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aIvsRealTimeClient
. -
serviceMetadata
-
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
-