Interface IvschatAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface IvschatAsyncClient extends AwsClient
Service client for accessing ivschat asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

Introduction

The Amazon 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.

This document describes HTTP operations. There is a separate messaging API for managing Chat resources; see the Amazon IVS Chat Messaging API 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 resources are part of Amazon IVS Chat:

  • LoggingConfiguration — A configuration that allows customers to store and record sent messages in a chat room. See the Logging Configuration endpoints for more information.

  • 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 Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, 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 operations: 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 operation 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:

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.

  • Field Details

  • Method Details

    • createChatToken

      default CompletableFuture<CreateChatTokenResponse> createChatToken(CreateChatTokenRequest createChatTokenRequest)

      Creates an encrypted token that is used by a chat participant to establish an individual WebSocket chat connection to a room. When the token is used to connect to chat, the connection is valid for the session duration specified in the request. The token becomes invalid at the token-expiration timestamp included in the response.

      Use the capabilities field to permit an end user to send messages or moderate a room.

      The attributes field securely attaches structured data to the chat session; the data is included within each message sent by the end user and received by other participants in the room. Common use cases for attributes include passing end-user profile data like an icon, display name, colors, badges, and other display features.

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

      Parameters:
      createChatTokenRequest -
      Returns:
      A Java Future containing the result of the CreateChatToken operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createChatToken

      default CompletableFuture<CreateChatTokenResponse> createChatToken(Consumer<CreateChatTokenRequest.Builder> createChatTokenRequest)

      Creates an encrypted token that is used by a chat participant to establish an individual WebSocket chat connection to a room. When the token is used to connect to chat, the connection is valid for the session duration specified in the request. The token becomes invalid at the token-expiration timestamp included in the response.

      Use the capabilities field to permit an end user to send messages or moderate a room.

      The attributes field securely attaches structured data to the chat session; the data is included within each message sent by the end user and received by other participants in the room. Common use cases for attributes include passing end-user profile data like an icon, display name, colors, badges, and other display features.

      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:
      A Java Future containing the result of the CreateChatToken operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createLoggingConfiguration

      default CompletableFuture<CreateLoggingConfigurationResponse> createLoggingConfiguration(CreateLoggingConfigurationRequest createLoggingConfigurationRequest)

      Creates a logging configuration that allows clients to store and record sent messages.

      Parameters:
      createLoggingConfigurationRequest -
      Returns:
      A Java Future containing the result of the CreateLoggingConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createLoggingConfiguration

      default CompletableFuture<CreateLoggingConfigurationResponse> createLoggingConfiguration(Consumer<CreateLoggingConfigurationRequest.Builder> createLoggingConfigurationRequest)

      Creates a logging configuration that allows clients to store and record sent messages.


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

      Parameters:
      createLoggingConfigurationRequest - A Consumer that will call methods on CreateLoggingConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateLoggingConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createRoom

      default CompletableFuture<CreateRoomResponse> createRoom(CreateRoomRequest createRoomRequest)

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

      Parameters:
      createRoomRequest -
      Returns:
      A Java Future containing the result of the CreateRoom operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createRoom

      default CompletableFuture<CreateRoomResponse> createRoom(Consumer<CreateRoomRequest.Builder> createRoomRequest)

      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:
      A Java Future containing the result of the CreateRoom operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteLoggingConfiguration

      default CompletableFuture<DeleteLoggingConfigurationResponse> deleteLoggingConfiguration(DeleteLoggingConfigurationRequest deleteLoggingConfigurationRequest)

      Deletes the specified logging configuration.

      Parameters:
      deleteLoggingConfigurationRequest -
      Returns:
      A Java Future containing the result of the DeleteLoggingConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException
      • 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.
      See Also:

    • deleteLoggingConfiguration

      default CompletableFuture<DeleteLoggingConfigurationResponse> deleteLoggingConfiguration(Consumer<DeleteLoggingConfigurationRequest.Builder> deleteLoggingConfigurationRequest)

      Deletes the specified logging configuration.


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

      Parameters:
      deleteLoggingConfigurationRequest - A Consumer that will call methods on DeleteLoggingConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteLoggingConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException
      • 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.
      See Also:

    • deleteMessage

      default CompletableFuture<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. This event’s EventName is aws:DELETE_MESSAGE. This replicates the DeleteMessage WebSocket operation in the Amazon IVS Chat Messaging API.

      Parameters:
      deleteMessageRequest -
      Returns:
      A Java Future containing the result of the DeleteMessage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException
      • 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.
      See Also:

    • deleteMessage

      default CompletableFuture<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. 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:
      A Java Future containing the result of the DeleteMessage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException
      • 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.
      See Also:

    • deleteRoom

      default CompletableFuture<DeleteRoomResponse> deleteRoom(DeleteRoomRequest deleteRoomRequest)

      Deletes the specified room.

      Parameters:
      deleteRoomRequest -
      Returns:
      A Java Future containing the result of the DeleteRoom operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteRoom

      default CompletableFuture<DeleteRoomResponse> deleteRoom(Consumer<DeleteRoomRequest.Builder> deleteRoomRequest)

      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:
      A Java Future containing the result of the DeleteRoom operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • disconnectUser

      default CompletableFuture<DisconnectUserResponse> disconnectUser(DisconnectUserRequest disconnectUserRequest)

      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:
      A Java Future containing the result of the DisconnectUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException
      • 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.
      See Also:

    • disconnectUser

      default CompletableFuture<DisconnectUserResponse> disconnectUser(Consumer<DisconnectUserRequest.Builder> disconnectUserRequest)

      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:
      A Java Future containing the result of the DisconnectUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException
      • 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.
      See Also:

    • getLoggingConfiguration

      default CompletableFuture<GetLoggingConfigurationResponse> getLoggingConfiguration(GetLoggingConfigurationRequest getLoggingConfigurationRequest)

      Gets the specified logging configuration.

      Parameters:
      getLoggingConfigurationRequest -
      Returns:
      A Java Future containing the result of the GetLoggingConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getLoggingConfiguration

      default CompletableFuture<GetLoggingConfigurationResponse> getLoggingConfiguration(Consumer<GetLoggingConfigurationRequest.Builder> getLoggingConfigurationRequest)

      Gets the specified logging configuration.


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

      Parameters:
      getLoggingConfigurationRequest - A Consumer that will call methods on GetLoggingConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetLoggingConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getRoom

      default CompletableFuture<GetRoomResponse> getRoom(GetRoomRequest getRoomRequest)

      Gets the specified room.

      Parameters:
      getRoomRequest -
      Returns:
      A Java Future containing the result of the GetRoom operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getRoom

      default CompletableFuture<GetRoomResponse> getRoom(Consumer<GetRoomRequest.Builder> getRoomRequest)

      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:
      A Java Future containing the result of the GetRoom operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listLoggingConfigurations

      default CompletableFuture<ListLoggingConfigurationsResponse> listLoggingConfigurations(ListLoggingConfigurationsRequest listLoggingConfigurationsRequest)

      Gets summary information about all your logging configurations in the AWS region where the API request is processed.

      Parameters:
      listLoggingConfigurationsRequest -
      Returns:
      A Java Future containing the result of the ListLoggingConfigurations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException
      • 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.
      See Also:

    • listLoggingConfigurations

      default CompletableFuture<ListLoggingConfigurationsResponse> listLoggingConfigurations(Consumer<ListLoggingConfigurationsRequest.Builder> listLoggingConfigurationsRequest)

      Gets summary information about all your logging configurations in the AWS region where the API request is processed.


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

      Parameters:
      listLoggingConfigurationsRequest - A Consumer that will call methods on ListLoggingConfigurationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListLoggingConfigurations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException
      • 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.
      See Also:

    • listLoggingConfigurationsPaginator

      default ListLoggingConfigurationsPublisher listLoggingConfigurationsPaginator(ListLoggingConfigurationsRequest listLoggingConfigurationsRequest)

      This is a variant of listLoggingConfigurations(software.amazon.awssdk.services.ivschat.model.ListLoggingConfigurationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ivschat.paginators.ListLoggingConfigurationsPublisher publisher = client.listLoggingConfigurationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ivschat.paginators.ListLoggingConfigurationsPublisher publisher = client.listLoggingConfigurationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivschat.model.ListLoggingConfigurationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ivschat.model.ListLoggingConfigurationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listLoggingConfigurations(software.amazon.awssdk.services.ivschat.model.ListLoggingConfigurationsRequest) operation.

      Parameters:
      listLoggingConfigurationsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException
      • 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.
      See Also:

    • listLoggingConfigurationsPaginator

      default ListLoggingConfigurationsPublisher listLoggingConfigurationsPaginator(Consumer<ListLoggingConfigurationsRequest.Builder> listLoggingConfigurationsRequest)

      This is a variant of listLoggingConfigurations(software.amazon.awssdk.services.ivschat.model.ListLoggingConfigurationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ivschat.paginators.ListLoggingConfigurationsPublisher publisher = client.listLoggingConfigurationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ivschat.paginators.ListLoggingConfigurationsPublisher publisher = client.listLoggingConfigurationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivschat.model.ListLoggingConfigurationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ivschat.model.ListLoggingConfigurationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listLoggingConfigurations(software.amazon.awssdk.services.ivschat.model.ListLoggingConfigurationsRequest) operation.


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

      Parameters:
      listLoggingConfigurationsRequest - A Consumer that will call methods on ListLoggingConfigurationsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException
      • 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.
      See Also:

    • listRooms

      default CompletableFuture<ListRoomsResponse> listRooms(ListRoomsRequest listRoomsRequest)

      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:
      A Java Future containing the result of the ListRooms operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listRooms

      default CompletableFuture<ListRoomsResponse> listRooms(Consumer<ListRoomsRequest.Builder> listRoomsRequest)

      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:
      A Java Future containing the result of the ListRooms operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listRoomsPaginator

      default ListRoomsPublisher listRoomsPaginator(ListRoomsRequest listRoomsRequest)

      This is a variant of listRooms(software.amazon.awssdk.services.ivschat.model.ListRoomsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ivschat.paginators.ListRoomsPublisher publisher = client.listRoomsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ivschat.paginators.ListRoomsPublisher publisher = client.listRoomsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivschat.model.ListRoomsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ivschat.model.ListRoomsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listRoomsPaginator

      default ListRoomsPublisher listRoomsPaginator(Consumer<ListRoomsRequest.Builder> listRoomsRequest)

      This is a variant of listRooms(software.amazon.awssdk.services.ivschat.model.ListRoomsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ivschat.paginators.ListRoomsPublisher publisher = client.listRoomsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ivschat.paginators.ListRoomsPublisher publisher = client.listRoomsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivschat.model.ListRoomsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ivschat.model.ListRoomsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Gets information about AWS tags for the specified ARN.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      Gets information about AWS tags for the specified ARN.


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

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • sendEvent

      default CompletableFuture<SendEventResponse> sendEvent(SendEventRequest sendEventRequest)

      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:
      A Java Future containing the result of the SendEvent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException
      • 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.
      See Also:

    • sendEvent

      default CompletableFuture<SendEventResponse> sendEvent(Consumer<SendEventRequest.Builder> sendEventRequest)

      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:
      A Java Future containing the result of the SendEvent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException
      • 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.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

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

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

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


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

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes tags from the resource with the specified ARN.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      Removes tags from the resource with the specified ARN.


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

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateLoggingConfiguration

      default CompletableFuture<UpdateLoggingConfigurationResponse> updateLoggingConfiguration(UpdateLoggingConfigurationRequest updateLoggingConfigurationRequest)

      Updates a specified logging configuration.

      Parameters:
      updateLoggingConfigurationRequest -
      Returns:
      A Java Future containing the result of the UpdateLoggingConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException
      • 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.
      See Also:

    • updateLoggingConfiguration

      default CompletableFuture<UpdateLoggingConfigurationResponse> updateLoggingConfiguration(Consumer<UpdateLoggingConfigurationRequest.Builder> updateLoggingConfigurationRequest)

      Updates a specified logging configuration.


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

      Parameters:
      updateLoggingConfigurationRequest - A Consumer that will call methods on UpdateLoggingConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateLoggingConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException
      • 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.
      See Also:

    • updateRoom

      default CompletableFuture<UpdateRoomResponse> updateRoom(UpdateRoomRequest updateRoomRequest)

      Updates a room’s configuration.

      Parameters:
      updateRoomRequest -
      Returns:
      A Java Future containing the result of the UpdateRoom operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateRoom

      default CompletableFuture<UpdateRoomResponse> updateRoom(Consumer<UpdateRoomRequest.Builder> updateRoomRequest)

      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:
      A Java Future containing the result of the UpdateRoom operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • serviceClientConfiguration

      default IvschatServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static IvschatAsyncClient create()
      Create a IvschatAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static IvschatAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a IvschatAsyncClient.