Package software.amazon.awssdk.services.ivsrealtime

Interface IvsRealTimeClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface IvsRealTimeClient
extends AwsClient

Service client for accessing ivsrealtime. This can be created using the static 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.

Resources

The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS Real-Time Streaming):

• Stage — A stage is a virtual space where participants can exchange video in real time.

Tagging

A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature to label a particular video category. See Tagging AWS Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS stages has no service-specific constraints beyond what is documented there.

Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).

The Amazon IVS real-time API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Stage.

At most 50 tags can be applied to a resource.

Stages Endpoints

• CreateParticipantToken — Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire.

• CreateStage — Creates a new stage (and optionally participant tokens).

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

• DisconnectParticipant — Disconnects a specified participant and revokes the participant permanently from a specified stage.

• GetParticipant — Gets information about the specified participant token.

• GetStage — Gets information for the specified stage.

• GetStageSession — Gets information for the specified stage session.

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

• ListParticipants — Lists all participants in a specified stage session.

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

• ListStageSessions — Gets all sessions for a specified stage.

• UpdateStage — Updates a stage’s configuration.

Tags Endpoints

• ListTagsForResource — Gets information about AWS tags for the specified ARN.

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

• UntagResource — Removes tags from the resource with the specified ARN.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static IvsRealTimeClientBuilder	builder()	Create a builder that can be used to configure and create a IvsRealTimeClient.
static IvsRealTimeClient	create()	Create a IvsRealTimeClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
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).
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).
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 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 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)	Lists events for a specified participant that occurred during a specified stage session.
default ListParticipantEventsIterable	listParticipantEventsPaginator(ListParticipantEventsRequest listParticipantEventsRequest)	Lists events for a specified participant that occurred during a specified stage session.
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)	Lists all participants in a specified stage session.
default ListParticipantsIterable	listParticipantsPaginator(ListParticipantsRequest listParticipantsRequest)	Lists all participants in a specified stage session.
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)	Gets all sessions for a specified stage.
default ListStageSessionsIterable	listStageSessionsPaginator(ListStageSessionsRequest listStageSessionsRequest)	Gets all sessions for a specified stage.
default ListStagesIterable	listStagesPaginator(Consumer<ListStagesRequest.Builder> listStagesRequest)	Gets summary information about all stages in your account, in the AWS region where the API request is processed.
default ListStagesIterable	listStagesPaginator(ListStagesRequest listStagesRequest)	Gets summary information about all stages in your account, in the AWS region where the API request is processed.
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.
default IvsRealTimeServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
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

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

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:

• AWS API Documentation

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 via CreateParticipantTokenRequest.builder()

Parameters:

createParticipantTokenRequest - A Consumer that will call methods on CreateParticipantTokenRequest.Builder to create a request.

Returns:

Result of the CreateParticipantToken operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via CreateStageRequest.builder()

Parameters:

createStageRequest - A Consumer that will call methods on CreateStageRequest.Builder to create a request.

Returns:

Result of the CreateStage operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via DeleteStageRequest.builder()

Parameters:

deleteStageRequest - A Consumer that will call methods on DeleteStageRequest.Builder to create a request.

Returns:

Result of the DeleteStage operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via DisconnectParticipantRequest.builder()

Parameters:

disconnectParticipantRequest - A Consumer that will call methods on DisconnectParticipantRequest.Builder to create a request.

Returns:

Result of the DisconnectParticipant operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via GetParticipantRequest.builder()

Parameters:

getParticipantRequest - A Consumer that will call methods on GetParticipantRequest.Builder to create a request.

Returns:

Result of the GetParticipant operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via GetStageRequest.builder()

Parameters:

getStageRequest - A Consumer that will call methods on GetStageRequest.Builder to create a request.

Returns:

Result of the GetStage operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via GetStageSessionRequest.builder()

Parameters:

getStageSessionRequest - A Consumer that will call methods on GetStageSessionRequest.Builder to create a request.

Returns:

Result of the GetStageSession operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via ListParticipantEventsRequest.builder()

Parameters:

listParticipantEventsRequest - A Consumer that will call methods on ListParticipantEventsRequest.Builder to create a request.

Returns:

Result of the ListParticipantEvents operation returned by the service.

See Also:

• AWS API Documentation

listParticipantEventsPaginator

default ListParticipantEventsIterable listParticipantEventsPaginator(ListParticipantEventsRequest listParticipantEventsRequest)
                                                              throws ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
IvsRealTimeException

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

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 Stream

 
 software.amazon.awssdk.services.ivsrealtime.paginators.ListParticipantEventsIterable responses = client.listParticipantEventsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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:

• AWS API Documentation

listParticipantEventsPaginator

default ListParticipantEventsIterable listParticipantEventsPaginator(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 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 Stream

 
 software.amazon.awssdk.services.ivsrealtime.paginators.ListParticipantEventsIterable responses = client.listParticipantEventsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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 via ListParticipantEventsRequest.builder()

Parameters:

listParticipantEventsRequest - A Consumer that will call methods on ListParticipantEventsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via ListParticipantsRequest.builder()

Parameters:

listParticipantsRequest - A Consumer that will call methods on ListParticipantsRequest.Builder to create a request.

Returns:

Result of the ListParticipants operation returned by the service.

See Also:

• AWS API Documentation

listParticipantsPaginator

default ListParticipantsIterable listParticipantsPaginator(ListParticipantsRequest listParticipantsRequest)
                                                    throws ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
IvsRealTimeException

Lists all participants in a specified stage session.

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 Stream

 
 software.amazon.awssdk.services.ivsrealtime.paginators.ListParticipantsIterable responses = client.listParticipantsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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:

• AWS API Documentation

listParticipantsPaginator

default ListParticipantsIterable listParticipantsPaginator(Consumer<ListParticipantsRequest.Builder> listParticipantsRequest)
                                                    throws ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
IvsRealTimeException

Lists all participants in a specified stage session.

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 Stream

 
 software.amazon.awssdk.services.ivsrealtime.paginators.ListParticipantsIterable responses = client.listParticipantsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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 via ListParticipantsRequest.builder()

Parameters:

listParticipantsRequest - A Consumer that will call methods on ListParticipantsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via ListStageSessionsRequest.builder()

Parameters:

listStageSessionsRequest - A Consumer that will call methods on ListStageSessionsRequest.Builder to create a request.

Returns:

Result of the ListStageSessions operation returned by the service.

See Also:

• AWS API Documentation

listStageSessionsPaginator

default ListStageSessionsIterable listStageSessionsPaginator(ListStageSessionsRequest listStageSessionsRequest)
                                                      throws ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
IvsRealTimeException

Gets all sessions for a specified stage.

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 Stream

 
 software.amazon.awssdk.services.ivsrealtime.paginators.ListStageSessionsIterable responses = client.listStageSessionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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:

• AWS API Documentation

listStageSessionsPaginator

default ListStageSessionsIterable listStageSessionsPaginator(Consumer<ListStageSessionsRequest.Builder> listStageSessionsRequest)
                                                      throws ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
IvsRealTimeException

Gets all sessions for a specified stage.

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 Stream

 
 software.amazon.awssdk.services.ivsrealtime.paginators.ListStageSessionsIterable responses = client.listStageSessionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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 via ListStageSessionsRequest.builder()

Parameters:

listStageSessionsRequest - A Consumer that will call methods on ListStageSessionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via ListStagesRequest.builder()

Parameters:

listStagesRequest - A Consumer that will call methods on ListStagesRequest.Builder to create a request.

Returns:

Result of the ListStages operation returned by the service.

See Also:

• AWS API Documentation

listStagesPaginator

default ListStagesIterable listStagesPaginator(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.

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 Stream

 
 software.amazon.awssdk.services.ivsrealtime.paginators.ListStagesIterable responses = client.listStagesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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:

• AWS API Documentation

listStagesPaginator

default ListStagesIterable listStagesPaginator(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 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 Stream

 
 software.amazon.awssdk.services.ivsrealtime.paginators.ListStagesIterable responses = client.listStagesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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 via ListStagesRequest.builder()

Parameters:

listStagesRequest - A Consumer that will call methods on ListStagesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateStage

default UpdateStageResponse updateStage(UpdateStageRequest updateStageRequest)
                                 throws ResourceNotFoundException,
ValidationException,
AccessDeniedException,
ServiceQuotaExceededException,
PendingVerificationException,
AwsServiceException,
SdkClientException,
IvsRealTimeException

Updates a stage’s configuration.

Parameters:

updateStageRequest -

Returns:

Result of the UpdateStage operation returned by the service.

See Also:

• AWS API Documentation

updateStage

default UpdateStageResponse updateStage(Consumer<UpdateStageRequest.Builder> updateStageRequest)
                                 throws ResourceNotFoundException,
ValidationException,
AccessDeniedException,
ServiceQuotaExceededException,
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 via UpdateStageRequest.builder()

Parameters:

updateStageRequest - A Consumer that will call methods on UpdateStageRequest.Builder to create a request.

Returns:

Result of the UpdateStage operation returned by the service.

See Also:

• AWS API Documentation

create

static IvsRealTimeClient create()

Create a IvsRealTimeClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static IvsRealTimeClientBuilder builder()

Create a builder that can be used to configure and create a IvsRealTimeClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default IvsRealTimeServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration