@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface IvsRealTimeClient extends AwsClient
builder() method.
Introduction
The Amazon Interactive Video Service (IVS) stage 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:
The IVS stage API sometimes is referred to as the IVS RealTime API.
A participant token is an authorization token used to publish/subscribe to 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):
Stage — A stage is a virtual space where multiple participants can exchange audio and 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 stage 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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and 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() |
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.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.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.
createParticipantTokenRequest - ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionServiceQuotaExceededExceptionPendingVerificationExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
createParticipantTokenRequest - A Consumer that will call methods on CreateParticipantTokenRequest.Builder to create a
request.ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionServiceQuotaExceededExceptionPendingVerificationExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateStageResponse createStage(CreateStageRequest createStageRequest) throws ValidationException, AccessDeniedException, ServiceQuotaExceededException, PendingVerificationException, AwsServiceException, SdkClientException, IvsRealTimeException
Creates a new stage (and optionally participant tokens).
createStageRequest - ValidationExceptionAccessDeniedExceptionServiceQuotaExceededExceptionPendingVerificationExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
createStageRequest - A Consumer that will call methods on CreateStageRequest.Builder to create a request.ValidationExceptionAccessDeniedExceptionServiceQuotaExceededExceptionPendingVerificationExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteStageResponse deleteStage(DeleteStageRequest deleteStageRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, ConflictException, PendingVerificationException, AwsServiceException, SdkClientException, IvsRealTimeException
Shuts down and deletes the specified stage (disconnecting all participants).
deleteStageRequest - ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionConflictExceptionPendingVerificationExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
deleteStageRequest - A Consumer that will call methods on DeleteStageRequest.Builder to create a request.ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionConflictExceptionPendingVerificationExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
disconnectParticipantRequest - ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionPendingVerificationExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
disconnectParticipantRequest - A Consumer that will call methods on DisconnectParticipantRequest.Builder to create a
request.ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionPendingVerificationExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetParticipantResponse getParticipant(GetParticipantRequest getParticipantRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, IvsRealTimeException
Gets information about the specified participant token.
getParticipantRequest - ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
getParticipantRequest - A Consumer that will call methods on GetParticipantRequest.Builder to create a request.ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetStageResponse getStage(GetStageRequest getStageRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, IvsRealTimeException
Gets information for the specified stage.
getStageRequest - ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
getStageRequest - A Consumer that will call methods on GetStageRequest.Builder to create a request.ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetStageSessionResponse getStageSession(GetStageSessionRequest getStageSessionRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, IvsRealTimeException
Gets information for the specified stage session.
getStageSessionRequest - ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
getStageSessionRequest - A Consumer that will call methods on GetStageSessionRequest.Builder to create a request.ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListParticipantEventsResponse listParticipantEvents(ListParticipantEventsRequest listParticipantEventsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, IvsRealTimeException
Lists events for a specified participant that occurred during a specified stage session.
listParticipantEventsRequest - ValidationExceptionAccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
listParticipantEventsRequest - A Consumer that will call methods on ListParticipantEventsRequest.Builder to create a
request.ValidationExceptionAccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listParticipantEventsRequest - ValidationExceptionAccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
listParticipantEventsRequest - A Consumer that will call methods on ListParticipantEventsRequest.Builder to create a
request.ValidationExceptionAccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListParticipantsResponse listParticipants(ListParticipantsRequest listParticipantsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, IvsRealTimeException
Lists all participants in a specified stage session.
listParticipantsRequest - ValidationExceptionAccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
listParticipantsRequest - A Consumer that will call methods on ListParticipantsRequest.Builder to create a request.ValidationExceptionAccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listParticipantsRequest - ValidationExceptionAccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
listParticipantsRequest - A Consumer that will call methods on ListParticipantsRequest.Builder to create a request.ValidationExceptionAccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStageSessionsResponse listStageSessions(ListStageSessionsRequest listStageSessionsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, IvsRealTimeException
Gets all sessions for a specified stage.
listStageSessionsRequest - ValidationExceptionAccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
listStageSessionsRequest - A Consumer that will call methods on ListStageSessionsRequest.Builder to create a request.ValidationExceptionAccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listStageSessionsRequest - ValidationExceptionAccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
listStageSessionsRequest - A Consumer that will call methods on ListStageSessionsRequest.Builder to create a request.ValidationExceptionAccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listStagesRequest - ValidationExceptionAccessDeniedExceptionConflictExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
listStagesRequest - A Consumer that will call methods on ListStagesRequest.Builder to create a request.ValidationExceptionAccessDeniedExceptionConflictExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listStagesRequest - ValidationExceptionAccessDeniedExceptionConflictExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
listStagesRequest - A Consumer that will call methods on ListStagesRequest.Builder to create a request.ValidationExceptionAccessDeniedExceptionConflictExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, IvsRealTimeException
Gets information about AWS tags for the specified ARN.
listTagsForResourceRequest - ResourceNotFoundExceptionValidationExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.ResourceNotFoundExceptionValidationExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, IvsRealTimeException
Adds or updates tags for the AWS resource with the specified ARN.
tagResourceRequest - ResourceNotFoundExceptionValidationExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.ResourceNotFoundExceptionValidationExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, IvsRealTimeException
Removes tags from the resource with the specified ARN.
untagResourceRequest - ResourceNotFoundExceptionValidationExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.ResourceNotFoundExceptionValidationExceptionInternalServerExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateStageResponse updateStage(UpdateStageRequest updateStageRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, ServiceQuotaExceededException, PendingVerificationException, AwsServiceException, SdkClientException, IvsRealTimeException
Updates a stage’s configuration.
updateStageRequest - ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionServiceQuotaExceededExceptionPendingVerificationExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
updateStageRequest - A Consumer that will call methods on UpdateStageRequest.Builder to create a request.ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionServiceQuotaExceededExceptionPendingVerificationExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.IvsRealTimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic IvsRealTimeClient create()
IvsRealTimeClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static IvsRealTimeClientBuilder builder()
IvsRealTimeClient.static ServiceMetadata serviceMetadata()
default IvsRealTimeServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.