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 staticbuilder()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 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:natureto 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:DeleteMessagepermission.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
EventNameisaws: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 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.
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.
Logging Configuration Endpoints
-
CreateLoggingConfiguration — Creates a logging configuration that allows clients to store and record sent messages.
-
DeleteLoggingConfiguration — Deletes the specified logging configuration.
-
GetLoggingConfiguration — Gets the specified logging configuration.
-
ListLoggingConfigurations — Gets summary information about all your logging configurations in the AWS region where the API request is processed.
-
UpdateLoggingConfiguration — Updates a specified logging 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 Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static IvschatAsyncClientBuilderbuilder()Create a builder that can be used to configure and create aIvschatAsyncClient.static IvschatAsyncClientcreate()Create aIvschatAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.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.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.default CompletableFuture<CreateLoggingConfigurationResponse>createLoggingConfiguration(Consumer<CreateLoggingConfigurationRequest.Builder> createLoggingConfigurationRequest)Creates a logging configuration that allows clients to store and record sent messages.default CompletableFuture<CreateLoggingConfigurationResponse>createLoggingConfiguration(CreateLoggingConfigurationRequest createLoggingConfigurationRequest)Creates a logging configuration that allows clients to store and record sent messages.default CompletableFuture<CreateRoomResponse>createRoom(Consumer<CreateRoomRequest.Builder> createRoomRequest)Creates a room that allows clients to connect and pass messages.default CompletableFuture<CreateRoomResponse>createRoom(CreateRoomRequest createRoomRequest)Creates a room that allows clients to connect and pass messages.default CompletableFuture<DeleteLoggingConfigurationResponse>deleteLoggingConfiguration(Consumer<DeleteLoggingConfigurationRequest.Builder> deleteLoggingConfigurationRequest)Deletes the specified logging configuration.default CompletableFuture<DeleteLoggingConfigurationResponse>deleteLoggingConfiguration(DeleteLoggingConfigurationRequest deleteLoggingConfigurationRequest)Deletes the specified logging configuration.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.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.default CompletableFuture<DeleteRoomResponse>deleteRoom(Consumer<DeleteRoomRequest.Builder> deleteRoomRequest)Deletes the specified room.default CompletableFuture<DeleteRoomResponse>deleteRoom(DeleteRoomRequest deleteRoomRequest)Deletes the specified room.default CompletableFuture<DisconnectUserResponse>disconnectUser(Consumer<DisconnectUserRequest.Builder> disconnectUserRequest)Disconnects all connections using a specified user ID from a room.default CompletableFuture<DisconnectUserResponse>disconnectUser(DisconnectUserRequest disconnectUserRequest)Disconnects all connections using a specified user ID from a room.default CompletableFuture<GetLoggingConfigurationResponse>getLoggingConfiguration(Consumer<GetLoggingConfigurationRequest.Builder> getLoggingConfigurationRequest)Gets the specified logging configuration.default CompletableFuture<GetLoggingConfigurationResponse>getLoggingConfiguration(GetLoggingConfigurationRequest getLoggingConfigurationRequest)Gets the specified logging configuration.default CompletableFuture<GetRoomResponse>getRoom(Consumer<GetRoomRequest.Builder> getRoomRequest)Gets the specified room.default CompletableFuture<GetRoomResponse>getRoom(GetRoomRequest getRoomRequest)Gets the specified room.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.default CompletableFuture<ListLoggingConfigurationsResponse>listLoggingConfigurations(ListLoggingConfigurationsRequest listLoggingConfigurationsRequest)Gets summary information about all your logging configurations in the AWS region where the API request is processed.default ListLoggingConfigurationsPublisherlistLoggingConfigurationsPaginator(Consumer<ListLoggingConfigurationsRequest.Builder> listLoggingConfigurationsRequest)This is a variant oflistLoggingConfigurations(software.amazon.awssdk.services.ivschat.model.ListLoggingConfigurationsRequest)operation.default ListLoggingConfigurationsPublisherlistLoggingConfigurationsPaginator(ListLoggingConfigurationsRequest listLoggingConfigurationsRequest)This is a variant oflistLoggingConfigurations(software.amazon.awssdk.services.ivschat.model.ListLoggingConfigurationsRequest)operation.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.default CompletableFuture<ListRoomsResponse>listRooms(ListRoomsRequest listRoomsRequest)Gets summary information about all your rooms in the AWS region where the API request is processed.default ListRoomsPublisherlistRoomsPaginator(Consumer<ListRoomsRequest.Builder> listRoomsRequest)This is a variant oflistRooms(software.amazon.awssdk.services.ivschat.model.ListRoomsRequest)operation.default ListRoomsPublisherlistRoomsPaginator(ListRoomsRequest listRoomsRequest)This is a variant oflistRooms(software.amazon.awssdk.services.ivschat.model.ListRoomsRequest)operation.default CompletableFuture<ListTagsForResourceResponse>listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)Gets information about AWS tags for the specified ARN.default CompletableFuture<ListTagsForResourceResponse>listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)Gets information about AWS tags for the specified ARN.default CompletableFuture<SendEventResponse>sendEvent(Consumer<SendEventRequest.Builder> sendEventRequest)Sends an event to a room.default CompletableFuture<SendEventResponse>sendEvent(SendEventRequest sendEventRequest)Sends an event to a room.default IvschatServiceClientConfigurationserviceClientConfiguration()default CompletableFuture<TagResourceResponse>tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)Adds or updates tags for the AWS resource with the specified ARN.default CompletableFuture<TagResourceResponse>tagResource(TagResourceRequest tagResourceRequest)Adds or updates tags for the AWS resource with the specified ARN.default CompletableFuture<UntagResourceResponse>untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)Removes tags from the resource with the specified ARN.default CompletableFuture<UntagResourceResponse>untagResource(UntagResourceRequest untagResourceRequest)Removes tags from the resource with the specified ARN.default CompletableFuture<UpdateLoggingConfigurationResponse>updateLoggingConfiguration(Consumer<UpdateLoggingConfigurationRequest.Builder> updateLoggingConfigurationRequest)Updates a specified logging configuration.default CompletableFuture<UpdateLoggingConfigurationResponse>updateLoggingConfiguration(UpdateLoggingConfigurationRequest updateLoggingConfigurationRequest)Updates a specified logging configuration.default CompletableFuture<UpdateRoomResponse>updateRoom(Consumer<UpdateRoomRequest.Builder> updateRoomRequest)Updates a room’s configuration.default CompletableFuture<UpdateRoomResponse>updateRoom(UpdateRoomRequest updateRoomRequest)Updates a room’s configuration.-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
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 theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
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
capabilitiesfield to permit an end user to send messages or moderate a room.The
attributesfield 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.- 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:
- AWS API Documentation
-
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
capabilitiesfield to permit an end user to send messages or moderate a room.The
attributesfield 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.Builderavoiding the need to create one manually viaCreateChatTokenRequest.builder()- Parameters:
createChatTokenRequest- AConsumerthat will call methods onCreateChatTokenRequest.Builderto 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.- 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:
- AWS API Documentation
-
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.- 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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateLoggingConfigurationRequest.builder()- Parameters:
createLoggingConfigurationRequest- AConsumerthat will call methods onCreateLoggingConfigurationRequest.Builderto 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.- 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:
- AWS API Documentation
-
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.- 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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateRoomRequest.builder()- Parameters:
createRoomRequest- AConsumerthat will call methods onCreateRoomRequest.Builderto 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.- 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:
- AWS API Documentation
-
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.- 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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteLoggingConfigurationRequest.builder()- Parameters:
deleteLoggingConfigurationRequest- AConsumerthat will call methods onDeleteLoggingConfigurationRequest.Builderto 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.- 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:
- AWS API Documentation
-
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
EventNameisaws: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.- 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:
- AWS API Documentation
-
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
EventNameisaws: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.Builderavoiding the need to create one manually viaDeleteMessageRequest.builder()- Parameters:
deleteMessageRequest- AConsumerthat will call methods onDeleteMessageRequest.Builderto 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.- 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:
- AWS API Documentation
-
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.- 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:
- AWS API Documentation
-
deleteRoom
default CompletableFuture<DeleteRoomResponse> deleteRoom(Consumer<DeleteRoomRequest.Builder> deleteRoomRequest)
Deletes the specified room.
This is a convenience which creates an instance of the
DeleteRoomRequest.Builderavoiding the need to create one manually viaDeleteRoomRequest.builder()- Parameters:
deleteRoomRequest- AConsumerthat will call methods onDeleteRoomRequest.Builderto 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.- 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:
- AWS API Documentation
-
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.- 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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDisconnectUserRequest.builder()- Parameters:
disconnectUserRequest- AConsumerthat will call methods onDisconnectUserRequest.Builderto 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.- 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:
- AWS API Documentation
-
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.- 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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetLoggingConfigurationRequest.builder()- Parameters:
getLoggingConfigurationRequest- AConsumerthat will call methods onGetLoggingConfigurationRequest.Builderto 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.- 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:
- AWS API Documentation
-
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.- 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:
- AWS API Documentation
-
getRoom
default CompletableFuture<GetRoomResponse> getRoom(Consumer<GetRoomRequest.Builder> getRoomRequest)
Gets the specified room.
This is a convenience which creates an instance of the
GetRoomRequest.Builderavoiding the need to create one manually viaGetRoomRequest.builder()- Parameters:
getRoomRequest- AConsumerthat will call methods onGetRoomRequest.Builderto 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.- 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:
- AWS API Documentation
-
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.- 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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListLoggingConfigurationsRequest.builder()- Parameters:
listLoggingConfigurationsRequest- AConsumerthat will call methods onListLoggingConfigurationsRequest.Builderto 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.- 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:
- AWS API Documentation
-
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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.ivschat.paginators.ListLoggingConfigurationsPublisher publisher = client.listLoggingConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.- 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:
- AWS API Documentation
-
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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.ivschat.paginators.ListLoggingConfigurationsPublisher publisher = client.listLoggingConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.Builderavoiding the need to create one manually viaListLoggingConfigurationsRequest.builder()- Parameters:
listLoggingConfigurationsRequest- AConsumerthat will call methods onListLoggingConfigurationsRequest.Builderto 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.- 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:
- AWS API Documentation
-
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.- 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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListRoomsRequest.builder()- Parameters:
listRoomsRequest- AConsumerthat will call methods onListRoomsRequest.Builderto 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.- 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:
- AWS API Documentation
-
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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.ivschat.paginators.ListRoomsPublisher publisher = client.listRoomsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.- 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:
- AWS API Documentation
-
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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.ivschat.paginators.ListRoomsPublisher publisher = client.listRoomsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.Builderavoiding the need to create one manually viaListRoomsRequest.builder()- Parameters:
listRoomsRequest- AConsumerthat will call methods onListRoomsRequest.Builderto 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.- 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:
- AWS API Documentation
-
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.- 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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto 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.- 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:
- AWS API Documentation
-
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.- 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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaSendEventRequest.builder()- Parameters:
sendEventRequest- AConsumerthat will call methods onSendEventRequest.Builderto 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.- 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:
- AWS API Documentation
-
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.- 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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto 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.- 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:
- AWS API Documentation
-
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.- 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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto 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.- 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:
- AWS API Documentation
-
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.- 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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaUpdateLoggingConfigurationRequest.builder()- Parameters:
updateLoggingConfigurationRequest- AConsumerthat will call methods onUpdateLoggingConfigurationRequest.Builderto 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.- 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:
- AWS API Documentation
-
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.- 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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaUpdateRoomRequest.builder()- Parameters:
updateRoomRequest- AConsumerthat will call methods onUpdateRoomRequest.Builderto 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.- 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:
- AWS API Documentation
-
serviceClientConfiguration
default IvschatServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
create
static IvschatAsyncClient create()
Create aIvschatAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static IvschatAsyncClientBuilder builder()
Create a builder that can be used to configure and create aIvschatAsyncClient.
-
-