software.amazon.awssdk.services.ivschat

Interface IvschatClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
 @ThreadSafe
public interface IvschatClient
extends SdkClient

Service client for accessing ivschat. This can be created using the static builder() method.

Introduction

The Amazon IVS Chat control-plane API enables you to create and manage Amazon IVS Chat resources. You also need to integrate with the Amazon IVS Chat Messaging API, to enable users to interact with chat rooms in real time.

The API is an AWS regional service. For a list of supported regions and Amazon IVS Chat HTTPS service endpoints, see the Amazon IVS Chat information on the Amazon IVS page in the AWS General Reference.

Notes on terminology:

• You create service applications using the Amazon IVS Chat API. We refer to these as applications.

• You create front-end client applications (browser and Android/iOS apps) using the Amazon IVS Chat Messaging API. We refer to these as clients.

Resources

The following resource is part of Amazon IVS Chat:

• Room — The central Amazon IVS Chat resource through which clients connect to and exchange chat messages. See the Room endpoints for more information.

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 Chat 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 Chat API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Room.

At most 50 tags can be applied to a resource.

API Access Security

Your Amazon IVS Chat applications (service applications and clients) must be authenticated and authorized to access Amazon IVS Chat resources. Note the differences between these concepts:

• Authentication is about verifying identity. Requests to the Amazon IVS Chat API must be signed to verify your identity.

• Authorization is about granting permissions. Your IAM roles need to have permissions for Amazon IVS Chat API requests.

Users (viewers) connect to a room using secure access tokens that you create using the CreateChatToken endpoint through the AWS SDK. You call CreateChatToken for every user’s chat session, passing identity and authorization information about the user.

Signing API Requests

HTTP API requests must be signed with an AWS SigV4 signature using your AWS security credentials. The AWS Command Line Interface (CLI) and the AWS SDKs take care of signing the underlying API calls for you. However, if your application calls the Amazon IVS Chat HTTP API directly, it’s your responsibility to sign the requests.

You generate a signature using valid AWS credentials for an IAM role that has permission to perform the requested action. For example, DeleteMessage requests must be made using an IAM role that has the ivschat:DeleteMessage permission.

For more information:

• Authentication and generating signatures — See Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon Web Services General Reference.

• Managing Amazon IVS permissions — See Identity and Access Management on the Security page of the Amazon IVS User Guide.

Amazon Resource Names (ARNs)

ARNs uniquely identify AWS resources. An ARN is required when you need to specify a resource unambiguously across all of AWS, such as in IAM policies and API calls. For more information, see Amazon Resource Names in the AWS General Reference.

Messaging Endpoints

• DeleteMessage — Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from view and delete it from the client’s chat history. This event’s EventName is aws:DELETE_MESSAGE. This replicates the DeleteMessage WebSocket operation in the Amazon IVS Chat Messaging API.

• DisconnectUser — Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.

• SendEvent — Sends an event to a room. Use this within your application’s business logic to send events to clients of a room; e.g., to notify clients to change the way the chat UI is rendered.

Chat Token Endpoint

• CreateChatToken — Creates an encrypted token that is used to establish an individual WebSocket connection to a room. The token is valid for one minute, and a connection (session) established with the token is valid for the specified duration.

Room Endpoints

• CreateRoom — Creates a room that allows clients to connect and pass messages.

• DeleteRoom — Deletes the specified room.

• GetRoom — Gets the specified room.

• ListRooms — Gets summary information about all your rooms in the AWS region where the API request is processed.

• UpdateRoom — Updates a room’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.

All the above are HTTP operations. There is a separate messaging API for managing Chat resources; see the Amazon IVS Chat Messaging API Reference.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
static IvschatClientBuilder	builder() Create a builder that can be used to configure and create a IvschatClient.
static IvschatClient	create() Create a IvschatClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateChatTokenResponse	createChatToken(Consumer<CreateChatTokenRequest.Builder> createChatTokenRequest) Creates an encrypted token that is used to establish an individual WebSocket connection to a room.
default CreateChatTokenResponse	createChatToken(CreateChatTokenRequest createChatTokenRequest) Creates an encrypted token that is used to establish an individual WebSocket connection to a room.
default CreateRoomResponse	createRoom(Consumer<CreateRoomRequest.Builder> createRoomRequest) Creates a room that allows clients to connect and pass messages.
default CreateRoomResponse	createRoom(CreateRoomRequest createRoomRequest) Creates a room that allows clients to connect and pass messages.
default DeleteMessageResponse	deleteMessage(Consumer<DeleteMessageRequest.Builder> deleteMessageRequest) Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from view and delete it from the client’s chat history.
default DeleteMessageResponse	deleteMessage(DeleteMessageRequest deleteMessageRequest) Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from view and delete it from the client’s chat history.
default DeleteRoomResponse	deleteRoom(Consumer<DeleteRoomRequest.Builder> deleteRoomRequest) Deletes the specified room.
default DeleteRoomResponse	deleteRoom(DeleteRoomRequest deleteRoomRequest) Deletes the specified room.
default DisconnectUserResponse	disconnectUser(Consumer<DisconnectUserRequest.Builder> disconnectUserRequest) Disconnects all connections using a specified user ID from a room.
default DisconnectUserResponse	disconnectUser(DisconnectUserRequest disconnectUserRequest) Disconnects all connections using a specified user ID from a room.
default GetRoomResponse	getRoom(Consumer<GetRoomRequest.Builder> getRoomRequest) Gets the specified room.
default GetRoomResponse	getRoom(GetRoomRequest getRoomRequest) Gets the specified room.
default ListRoomsResponse	listRooms(Consumer<ListRoomsRequest.Builder> listRoomsRequest) Gets summary information about all your rooms in the AWS region where the API request is processed.
default ListRoomsResponse	listRooms(ListRoomsRequest listRoomsRequest) Gets summary information about all your rooms in the AWS region where the API request is processed.
default ListRoomsIterable	listRoomsPaginator(Consumer<ListRoomsRequest.Builder> listRoomsRequest) Gets summary information about all your rooms in the AWS region where the API request is processed.
default ListRoomsIterable	listRoomsPaginator(ListRoomsRequest listRoomsRequest) Gets summary information about all your rooms 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 SendEventResponse	sendEvent(Consumer<SendEventRequest.Builder> sendEventRequest) Sends an event to a room.
default SendEventResponse	sendEvent(SendEventRequest sendEventRequest) Sends an event to a room.
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 UpdateRoomResponse	updateRoom(Consumer<UpdateRoomRequest.Builder> updateRoomRequest) Updates a room’s configuration.
default UpdateRoomResponse	updateRoom(UpdateRoomRequest updateRoomRequest) Updates a room’s configuration.

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

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 Detail

create

static IvschatClient create()

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

builder

static IvschatClientBuilder builder()

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

createChatToken

default CreateChatTokenResponse createChatToken(CreateChatTokenRequest createChatTokenRequest)
                                         throws AccessDeniedException,
                                                ResourceNotFoundException,
                                                PendingVerificationException,
                                                ValidationException,
                                                AwsServiceException,
                                                SdkClientException,
                                                IvschatException

Creates an encrypted token that is used to establish an individual WebSocket connection to a room. The token is valid for one minute, and a connection (session) established with the token is valid for the specified duration.

Encryption keys are owned by Amazon IVS Chat and never used directly by your application.

Parameters:

createChatTokenRequest -

Returns:

Result of the CreateChatToken operation returned by the service.

Throws:

AccessDeniedException

ResourceNotFoundException

PendingVerificationException

ValidationException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IvschatException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createChatToken

default CreateChatTokenResponse createChatToken(Consumer<CreateChatTokenRequest.Builder> createChatTokenRequest)
                                         throws AccessDeniedException,
                                                ResourceNotFoundException,
                                                PendingVerificationException,
                                                ValidationException,
                                                AwsServiceException,
                                                SdkClientException,
                                                IvschatException

Creates an encrypted token that is used to establish an individual WebSocket connection to a room. The token is valid for one minute, and a connection (session) established with the token is valid for the specified duration.

Encryption keys are owned by Amazon IVS Chat and never used directly by your application.

This is a convenience which creates an instance of the CreateChatTokenRequest.Builder avoiding the need to create one manually via CreateChatTokenRequest.builder()

Parameters:

createChatTokenRequest - A Consumer that will call methods on CreateChatTokenRequest.Builder to create a request.

Returns:

Result of the CreateChatToken operation returned by the service.

Throws:

AccessDeniedException

ResourceNotFoundException

PendingVerificationException

ValidationException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IvschatException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createRoom

default CreateRoomResponse createRoom(CreateRoomRequest createRoomRequest)
                               throws ConflictException,
                                      AccessDeniedException,
                                      ResourceNotFoundException,
                                      ServiceQuotaExceededException,
                                      PendingVerificationException,
                                      ValidationException,
                                      AwsServiceException,
                                      SdkClientException,
                                      IvschatException

Creates a room that allows clients to connect and pass messages.

Parameters:

createRoomRequest -

Returns:

Result of the CreateRoom operation returned by the service.

Throws:

ConflictException

AccessDeniedException

ResourceNotFoundException

ServiceQuotaExceededException

PendingVerificationException

ValidationException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IvschatException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createRoom

default CreateRoomResponse createRoom(Consumer<CreateRoomRequest.Builder> createRoomRequest)
                               throws ConflictException,
                                      AccessDeniedException,
                                      ResourceNotFoundException,
                                      ServiceQuotaExceededException,
                                      PendingVerificationException,
                                      ValidationException,
                                      AwsServiceException,
                                      SdkClientException,
                                      IvschatException

Creates a room that allows clients to connect and pass messages.

This is a convenience which creates an instance of the CreateRoomRequest.Builder avoiding the need to create one manually via CreateRoomRequest.builder()

Parameters:

createRoomRequest - A Consumer that will call methods on CreateRoomRequest.Builder to create a request.

Returns:

Result of the CreateRoom operation returned by the service.

Throws:

ConflictException

AccessDeniedException

ResourceNotFoundException

ServiceQuotaExceededException

PendingVerificationException

ValidationException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IvschatException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteMessage

default DeleteMessageResponse deleteMessage(DeleteMessageRequest deleteMessageRequest)
                                     throws ThrottlingException,
                                            AccessDeniedException,
                                            ResourceNotFoundException,
                                            ValidationException,
                                            AwsServiceException,
                                            SdkClientException,
                                            IvschatException

Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from view and delete it from the client’s chat history. This event’s EventName is aws:DELETE_MESSAGE. This replicates the DeleteMessage WebSocket operation in the Amazon IVS Chat Messaging API.

Parameters:

deleteMessageRequest -

Returns:

Result of the DeleteMessage operation returned by the service.

Throws:

ThrottlingException

AccessDeniedException

ResourceNotFoundException

ValidationException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IvschatException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteMessage

default DeleteMessageResponse deleteMessage(Consumer<DeleteMessageRequest.Builder> deleteMessageRequest)
                                     throws ThrottlingException,
                                            AccessDeniedException,
                                            ResourceNotFoundException,
                                            ValidationException,
                                            AwsServiceException,
                                            SdkClientException,
                                            IvschatException

Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from view and delete it from the client’s chat history. This event’s EventName is aws:DELETE_MESSAGE. This replicates the DeleteMessage WebSocket operation in the Amazon IVS Chat Messaging API.

This is a convenience which creates an instance of the DeleteMessageRequest.Builder avoiding the need to create one manually via DeleteMessageRequest.builder()

Parameters:

deleteMessageRequest - A Consumer that will call methods on DeleteMessageRequest.Builder to create a request.

Returns:

Result of the DeleteMessage operation returned by the service.

Throws:

ThrottlingException

AccessDeniedException

ResourceNotFoundException

ValidationException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IvschatException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteRoom

default DeleteRoomResponse deleteRoom(DeleteRoomRequest deleteRoomRequest)
                               throws AccessDeniedException,
                                      ResourceNotFoundException,
                                      PendingVerificationException,
                                      ValidationException,
                                      AwsServiceException,
                                      SdkClientException,
                                      IvschatException

Deletes the specified room.

Parameters:

deleteRoomRequest -

Returns:

Result of the DeleteRoom operation returned by the service.

Throws:

AccessDeniedException

ResourceNotFoundException

PendingVerificationException

ValidationException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IvschatException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteRoom

default DeleteRoomResponse deleteRoom(Consumer<DeleteRoomRequest.Builder> deleteRoomRequest)
                               throws AccessDeniedException,
                                      ResourceNotFoundException,
                                      PendingVerificationException,
                                      ValidationException,
                                      AwsServiceException,
                                      SdkClientException,
                                      IvschatException

Deletes the specified room.

This is a convenience which creates an instance of the DeleteRoomRequest.Builder avoiding the need to create one manually via DeleteRoomRequest.builder()

Parameters:

deleteRoomRequest - A Consumer that will call methods on DeleteRoomRequest.Builder to create a request.

Returns:

Result of the DeleteRoom operation returned by the service.

Throws:

AccessDeniedException

ResourceNotFoundException

PendingVerificationException

ValidationException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IvschatException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

disconnectUser

default DisconnectUserResponse disconnectUser(DisconnectUserRequest disconnectUserRequest)
                                       throws ThrottlingException,
                                              AccessDeniedException,
                                              ResourceNotFoundException,
                                              ValidationException,
                                              AwsServiceException,
                                              SdkClientException,
                                              IvschatException

Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.

Parameters:

disconnectUserRequest -

Returns:

Result of the DisconnectUser operation returned by the service.

Throws:

ThrottlingException

AccessDeniedException

ResourceNotFoundException

ValidationException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IvschatException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

disconnectUser

default DisconnectUserResponse disconnectUser(Consumer<DisconnectUserRequest.Builder> disconnectUserRequest)
                                       throws ThrottlingException,
                                              AccessDeniedException,
                                              ResourceNotFoundException,
                                              ValidationException,
                                              AwsServiceException,
                                              SdkClientException,
                                              IvschatException

Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.

This is a convenience which creates an instance of the DisconnectUserRequest.Builder avoiding the need to create one manually via DisconnectUserRequest.builder()

Parameters:

disconnectUserRequest - A Consumer that will call methods on DisconnectUserRequest.Builder to create a request.

Returns:

Result of the DisconnectUser operation returned by the service.

Throws:

ThrottlingException

AccessDeniedException

ResourceNotFoundException

ValidationException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IvschatException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getRoom

default GetRoomResponse getRoom(GetRoomRequest getRoomRequest)
                         throws AccessDeniedException,
                                ResourceNotFoundException,
                                ValidationException,
                                AwsServiceException,
                                SdkClientException,
                                IvschatException

Gets the specified room.

Parameters:

getRoomRequest -

Returns:

Result of the GetRoom operation returned by the service.

Throws:

AccessDeniedException

ResourceNotFoundException

ValidationException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IvschatException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getRoom

default GetRoomResponse getRoom(Consumer<GetRoomRequest.Builder> getRoomRequest)
                         throws AccessDeniedException,
                                ResourceNotFoundException,
                                ValidationException,
                                AwsServiceException,
                                SdkClientException,
                                IvschatException

Gets the specified room.

This is a convenience which creates an instance of the GetRoomRequest.Builder avoiding the need to create one manually via GetRoomRequest.builder()

Parameters:

getRoomRequest - A Consumer that will call methods on GetRoomRequest.Builder to create a request.

Returns:

Result of the GetRoom operation returned by the service.

Throws:

AccessDeniedException

ResourceNotFoundException

ValidationException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IvschatException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listRooms

default ListRoomsResponse listRooms(ListRoomsRequest listRoomsRequest)
                             throws AccessDeniedException,
                                    ResourceNotFoundException,
                                    ValidationException,
                                    AwsServiceException,
                                    SdkClientException,
                                    IvschatException

Gets summary information about all your rooms in the AWS region where the API request is processed. Results are sorted in descending order of updateTime.

Parameters:

listRoomsRequest -

Returns:

Result of the ListRooms operation returned by the service.

Throws:

AccessDeniedException

ResourceNotFoundException

ValidationException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IvschatException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listRooms

default ListRoomsResponse listRooms(Consumer<ListRoomsRequest.Builder> listRoomsRequest)
                             throws AccessDeniedException,
                                    ResourceNotFoundException,
                                    ValidationException,
                                    AwsServiceException,
                                    SdkClientException,
                                    IvschatException

Gets summary information about all your rooms in the AWS region where the API request is processed. Results are sorted in descending order of updateTime.

This is a convenience which creates an instance of the ListRoomsRequest.Builder avoiding the need to create one manually via ListRoomsRequest.builder()

Parameters:

listRoomsRequest - A Consumer that will call methods on ListRoomsRequest.Builder to create a request.

Returns:

Result of the ListRooms operation returned by the service.

Throws:

AccessDeniedException

ResourceNotFoundException

ValidationException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IvschatException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listRoomsPaginator

default ListRoomsIterable listRoomsPaginator(ListRoomsRequest listRoomsRequest)
                                      throws AccessDeniedException,
                                             ResourceNotFoundException,
                                             ValidationException,
                                             AwsServiceException,
                                             SdkClientException,
                                             IvschatException

Gets summary information about all your rooms in the AWS region where the API request is processed. Results are sorted in descending order of updateTime.

This is a variant of listRooms(software.amazon.awssdk.services.ivschat.model.ListRoomsRequest) 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.ivschat.paginators.ListRoomsIterable responses = client.listRoomsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ivschat.paginators.ListRoomsIterable responses = client.listRoomsPaginator(request);
     for (software.amazon.awssdk.services.ivschat.model.ListRoomsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ivschat.paginators.ListRoomsIterable responses = client.listRoomsPaginator(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 listRooms(software.amazon.awssdk.services.ivschat.model.ListRoomsRequest) operation.

Parameters:

listRoomsRequest -

Returns:

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

Throws:

AccessDeniedException

ResourceNotFoundException

ValidationException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IvschatException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listRoomsPaginator

default ListRoomsIterable listRoomsPaginator(Consumer<ListRoomsRequest.Builder> listRoomsRequest)
                                      throws AccessDeniedException,
                                             ResourceNotFoundException,
                                             ValidationException,
                                             AwsServiceException,
                                             SdkClientException,
                                             IvschatException

Gets summary information about all your rooms in the AWS region where the API request is processed. Results are sorted in descending order of updateTime.

This is a variant of listRooms(software.amazon.awssdk.services.ivschat.model.ListRoomsRequest) 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.ivschat.paginators.ListRoomsIterable responses = client.listRoomsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ivschat.paginators.ListRoomsIterable responses = client.listRoomsPaginator(request);
     for (software.amazon.awssdk.services.ivschat.model.ListRoomsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ivschat.paginators.ListRoomsIterable responses = client.listRoomsPaginator(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 listRooms(software.amazon.awssdk.services.ivschat.model.ListRoomsRequest) operation.

This is a convenience which creates an instance of the ListRoomsRequest.Builder avoiding the need to create one manually via ListRoomsRequest.builder()

Parameters:

listRoomsRequest - A Consumer that will call methods on ListRoomsRequest.Builder to create a request.

Returns:

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

Throws:

AccessDeniedException

ResourceNotFoundException

ValidationException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IvschatException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
                                                        InternalServerException,
                                                        ValidationException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        IvschatException

Gets information about AWS tags for the specified ARN.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ResourceNotFoundException

InternalServerException

ValidationException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IvschatException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
                                                        InternalServerException,
                                                        ValidationException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        IvschatException

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.

Throws:

ResourceNotFoundException

InternalServerException

ValidationException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IvschatException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

sendEvent

default SendEventResponse sendEvent(SendEventRequest sendEventRequest)
                             throws ThrottlingException,
                                    AccessDeniedException,
                                    ResourceNotFoundException,
                                    ValidationException,
                                    AwsServiceException,
                                    SdkClientException,
                                    IvschatException

Sends an event to a room. Use this within your application’s business logic to send events to clients of a room; e.g., to notify clients to change the way the chat UI is rendered.

Parameters:

sendEventRequest -

Returns:

Result of the SendEvent operation returned by the service.

Throws:

ThrottlingException

AccessDeniedException

ResourceNotFoundException

ValidationException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IvschatException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

sendEvent

default SendEventResponse sendEvent(Consumer<SendEventRequest.Builder> sendEventRequest)
                             throws ThrottlingException,
                                    AccessDeniedException,
                                    ResourceNotFoundException,
                                    ValidationException,
                                    AwsServiceException,
                                    SdkClientException,
                                    IvschatException

Sends an event to a room. Use this within your application’s business logic to send events to clients of a room; e.g., to notify clients to change the way the chat UI is rendered.

This is a convenience which creates an instance of the SendEventRequest.Builder avoiding the need to create one manually via SendEventRequest.builder()

Parameters:

sendEventRequest - A Consumer that will call methods on SendEventRequest.Builder to create a request.

Returns:

Result of the SendEvent operation returned by the service.

Throws:

ThrottlingException

AccessDeniedException

ResourceNotFoundException

ValidationException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IvschatException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ResourceNotFoundException,
                                        InternalServerException,
                                        ValidationException,
                                        AwsServiceException,
                                        SdkClientException,
                                        IvschatException

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

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

ResourceNotFoundException

InternalServerException

ValidationException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IvschatException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ResourceNotFoundException,
                                        InternalServerException,
                                        ValidationException,
                                        AwsServiceException,
                                        SdkClientException,
                                        IvschatException

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.

Throws:

ResourceNotFoundException

InternalServerException

ValidationException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IvschatException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ResourceNotFoundException,
                                            InternalServerException,
                                            ValidationException,
                                            AwsServiceException,
                                            SdkClientException,
                                            IvschatException

Removes tags from the resource with the specified ARN.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ResourceNotFoundException

InternalServerException

ValidationException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IvschatException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ResourceNotFoundException,
                                            InternalServerException,
                                            ValidationException,
                                            AwsServiceException,
                                            SdkClientException,
                                            IvschatException

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.

Throws:

ResourceNotFoundException

InternalServerException

ValidationException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IvschatException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateRoom

default UpdateRoomResponse updateRoom(UpdateRoomRequest updateRoomRequest)
                               throws AccessDeniedException,
                                      ResourceNotFoundException,
                                      PendingVerificationException,
                                      ValidationException,
                                      AwsServiceException,
                                      SdkClientException,
                                      IvschatException

Updates a room’s configuration.

Parameters:

updateRoomRequest -

Returns:

Result of the UpdateRoom operation returned by the service.

Throws:

AccessDeniedException

ResourceNotFoundException

PendingVerificationException

ValidationException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IvschatException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateRoom

default UpdateRoomResponse updateRoom(Consumer<UpdateRoomRequest.Builder> updateRoomRequest)
                               throws AccessDeniedException,
                                      ResourceNotFoundException,
                                      PendingVerificationException,
                                      ValidationException,
                                      AwsServiceException,
                                      SdkClientException,
                                      IvschatException

Updates a room’s configuration.

This is a convenience which creates an instance of the UpdateRoomRequest.Builder avoiding the need to create one manually via UpdateRoomRequest.builder()

Parameters:

updateRoomRequest - A Consumer that will call methods on UpdateRoomRequest.Builder to create a request.

Returns:

Result of the UpdateRoom operation returned by the service.

Throws:

AccessDeniedException

ResourceNotFoundException

PendingVerificationException

ValidationException

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IvschatException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()