Interface IvschatClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Introduction
The Amazon IVS Chat control-plane API enables you to create and manage Amazon IVS Chat resources. You also need to integrate with the Amazon IVS Chat Messaging API, to enable users to interact with chat rooms in real time.
The API is an AWS regional service. For a list of supported regions and Amazon IVS Chat HTTPS service endpoints, see the Amazon IVS Chat information on the Amazon IVS page in the AWS General Reference.
Notes on terminology:
-
You create service applications using the Amazon IVS Chat API. We refer to these as applications.
-
You create front-end client applications (browser and Android/iOS apps) using the Amazon IVS Chat Messaging API. We refer to these as clients.
Key Concepts
-
LoggingConfiguration — A configuration that allows customers to store and record sent messages in a chat room.
-
Room — The central Amazon IVS Chat resource through which clients connect to and exchange chat messages.
Tagging
A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value,
both set by you. For example, you might set a tag as topic:nature
to label a particular video category.
See Tagging AWS Resources for more
information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has
no service-specific constraints beyond what is documented there.
Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).
The Amazon IVS Chat API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Room.
At most 50 tags can be applied to a resource.
API Access Security
Your Amazon IVS Chat applications (service applications and clients) must be authenticated and authorized to access Amazon IVS Chat resources. Note the differences between these concepts:
-
Authentication is about verifying identity. Requests to the Amazon IVS Chat API must be signed to verify your identity.
-
Authorization is about granting permissions. Your IAM roles need to have permissions for Amazon IVS Chat API requests.
Users (viewers) connect to a room using secure access tokens that you create using the CreateChatToken endpoint through the AWS SDK. You call CreateChatToken for every user’s chat session, passing identity and authorization information about the user.
Signing API Requests
HTTP API requests must be signed with an AWS SigV4 signature using your AWS security credentials. The AWS Command Line Interface (CLI) and the AWS SDKs take care of signing the underlying API calls for you. However, if your application calls the Amazon IVS Chat HTTP API directly, it’s your responsibility to sign the requests.
You generate a signature using valid AWS credentials for an IAM role that has permission to perform the requested
action. For example, DeleteMessage requests must be made using an IAM role that has the
ivschat:DeleteMessage
permission.
For more information:
-
Authentication and generating signatures — See Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon Web Services General Reference.
-
Managing Amazon IVS permissions — See Identity and Access Management on the Security page of the Amazon IVS User Guide.
Amazon Resource Names (ARNs)
ARNs uniquely identify AWS resources. An ARN is required when you need to specify a resource unambiguously across all of AWS, such as in IAM policies and API calls. For more information, see Amazon Resource Names in the AWS General Reference.
Messaging Endpoints
-
DeleteMessage — Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from view and delete it from the client’s chat history. This event’s
EventName
isaws: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
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic IvschatClientBuilder
builder()
Create a builder that can be used to configure and create aIvschatClient
.static IvschatClient
create()
Create aIvschatClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default 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 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.createLoggingConfiguration
(Consumer<CreateLoggingConfigurationRequest.Builder> createLoggingConfigurationRequest) Creates a logging configuration that allows clients to store and record sent messages.createLoggingConfiguration
(CreateLoggingConfigurationRequest createLoggingConfigurationRequest) Creates a logging configuration that allows clients to store and record sent messages.default CreateRoomResponse
createRoom
(Consumer<CreateRoomRequest.Builder> createRoomRequest) Creates a room that allows clients to connect and pass messages.default CreateRoomResponse
createRoom
(CreateRoomRequest createRoomRequest) Creates a room that allows clients to connect and pass messages.deleteLoggingConfiguration
(Consumer<DeleteLoggingConfigurationRequest.Builder> deleteLoggingConfigurationRequest) Deletes the specified logging configuration.deleteLoggingConfiguration
(DeleteLoggingConfigurationRequest deleteLoggingConfigurationRequest) Deletes the specified logging configuration.default DeleteMessageResponse
deleteMessage
(Consumer<DeleteMessageRequest.Builder> deleteMessageRequest) Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from view and delete it from the client’s chat history.default DeleteMessageResponse
deleteMessage
(DeleteMessageRequest deleteMessageRequest) Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from view and delete it from the client’s chat history.default DeleteRoomResponse
deleteRoom
(Consumer<DeleteRoomRequest.Builder> deleteRoomRequest) Deletes the specified room.default DeleteRoomResponse
deleteRoom
(DeleteRoomRequest deleteRoomRequest) Deletes the specified room.default DisconnectUserResponse
disconnectUser
(Consumer<DisconnectUserRequest.Builder> disconnectUserRequest) Disconnects all connections using a specified user ID from a room.default DisconnectUserResponse
disconnectUser
(DisconnectUserRequest disconnectUserRequest) Disconnects all connections using a specified user ID from a room.default GetLoggingConfigurationResponse
getLoggingConfiguration
(Consumer<GetLoggingConfigurationRequest.Builder> getLoggingConfigurationRequest) Gets the specified logging configuration.default GetLoggingConfigurationResponse
getLoggingConfiguration
(GetLoggingConfigurationRequest getLoggingConfigurationRequest) Gets the specified logging configuration.default GetRoomResponse
getRoom
(Consumer<GetRoomRequest.Builder> getRoomRequest) Gets the specified room.default GetRoomResponse
getRoom
(GetRoomRequest getRoomRequest) Gets the specified room.listLoggingConfigurations
(Consumer<ListLoggingConfigurationsRequest.Builder> listLoggingConfigurationsRequest) Gets summary information about all your logging configurations in the AWS region where the API request is processed.listLoggingConfigurations
(ListLoggingConfigurationsRequest listLoggingConfigurationsRequest) Gets summary information about all your logging configurations in the AWS region where the API request is processed.listLoggingConfigurationsPaginator
(Consumer<ListLoggingConfigurationsRequest.Builder> listLoggingConfigurationsRequest) This is a variant oflistLoggingConfigurations(software.amazon.awssdk.services.ivschat.model.ListLoggingConfigurationsRequest)
operation.listLoggingConfigurationsPaginator
(ListLoggingConfigurationsRequest listLoggingConfigurationsRequest) This is a variant oflistLoggingConfigurations(software.amazon.awssdk.services.ivschat.model.ListLoggingConfigurationsRequest)
operation.default ListRoomsResponse
listRooms
(Consumer<ListRoomsRequest.Builder> listRoomsRequest) Gets summary information about all your rooms in the AWS region where the API request is processed.default ListRoomsResponse
listRooms
(ListRoomsRequest listRoomsRequest) Gets summary information about all your rooms in the AWS region where the API request is processed.default ListRoomsIterable
listRoomsPaginator
(Consumer<ListRoomsRequest.Builder> listRoomsRequest) This is a variant oflistRooms(software.amazon.awssdk.services.ivschat.model.ListRoomsRequest)
operation.default ListRoomsIterable
listRoomsPaginator
(ListRoomsRequest listRoomsRequest) This is a variant oflistRooms(software.amazon.awssdk.services.ivschat.model.ListRoomsRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Gets information about AWS tags for the specified ARN.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Gets information about AWS tags for the specified ARN.default SendEventResponse
sendEvent
(Consumer<SendEventRequest.Builder> sendEventRequest) Sends an event to a room.default SendEventResponse
sendEvent
(SendEventRequest sendEventRequest) Sends an event to a room.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds or updates tags for the AWS resource with the specified ARN.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Adds or updates tags for the AWS resource with the specified ARN.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from the resource with the specified ARN.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes tags from the resource with the specified ARN.updateLoggingConfiguration
(Consumer<UpdateLoggingConfigurationRequest.Builder> updateLoggingConfigurationRequest) Updates a specified logging configuration.updateLoggingConfiguration
(UpdateLoggingConfigurationRequest updateLoggingConfigurationRequest) Updates a specified logging configuration.default UpdateRoomResponse
updateRoom
(Consumer<UpdateRoomRequest.Builder> updateRoomRequest) Updates a room’s configuration.default UpdateRoomResponse
updateRoom
(UpdateRoomRequest updateRoomRequest) Updates a room’s configuration.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createChatToken
default CreateChatTokenResponse createChatToken(CreateChatTokenRequest createChatTokenRequest) throws AccessDeniedException, ResourceNotFoundException, PendingVerificationException, ValidationException, AwsServiceException, SdkClientException, IvschatException 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:
- Result of the CreateChatToken operation returned by the service.
- See Also:
-
createChatToken
default CreateChatTokenResponse createChatToken(Consumer<CreateChatTokenRequest.Builder> createChatTokenRequest) throws AccessDeniedException, ResourceNotFoundException, PendingVerificationException, ValidationException, AwsServiceException, SdkClientException, IvschatException 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 viaCreateChatTokenRequest.builder()
- Parameters:
createChatTokenRequest
- AConsumer
that will call methods onCreateChatTokenRequest.Builder
to create a request.- Returns:
- Result of the CreateChatToken operation returned by the service.
- See Also:
-
createLoggingConfiguration
default CreateLoggingConfigurationResponse createLoggingConfiguration(CreateLoggingConfigurationRequest createLoggingConfigurationRequest) throws ConflictException, AccessDeniedException, ResourceNotFoundException, ServiceQuotaExceededException, PendingVerificationException, ValidationException, AwsServiceException, SdkClientException, IvschatException Creates a logging configuration that allows clients to store and record sent messages.
- Parameters:
createLoggingConfigurationRequest
-- Returns:
- Result of the CreateLoggingConfiguration operation returned by the service.
- See Also:
-
createLoggingConfiguration
default CreateLoggingConfigurationResponse createLoggingConfiguration(Consumer<CreateLoggingConfigurationRequest.Builder> createLoggingConfigurationRequest) throws ConflictException, AccessDeniedException, ResourceNotFoundException, ServiceQuotaExceededException, PendingVerificationException, ValidationException, AwsServiceException, SdkClientException, IvschatException 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 viaCreateLoggingConfigurationRequest.builder()
- Parameters:
createLoggingConfigurationRequest
- AConsumer
that will call methods onCreateLoggingConfigurationRequest.Builder
to create a request.- Returns:
- Result of the CreateLoggingConfiguration operation returned by the service.
- See Also:
-
createRoom
default CreateRoomResponse createRoom(CreateRoomRequest createRoomRequest) throws ConflictException, AccessDeniedException, ResourceNotFoundException, ServiceQuotaExceededException, PendingVerificationException, ValidationException, AwsServiceException, SdkClientException, IvschatException Creates a room that allows clients to connect and pass messages.
- Parameters:
createRoomRequest
-- Returns:
- Result of the CreateRoom operation returned by the service.
- See Also:
-
createRoom
default CreateRoomResponse createRoom(Consumer<CreateRoomRequest.Builder> createRoomRequest) throws ConflictException, AccessDeniedException, ResourceNotFoundException, ServiceQuotaExceededException, PendingVerificationException, ValidationException, AwsServiceException, SdkClientException, IvschatException Creates a room that allows clients to connect and pass messages.
This is a convenience which creates an instance of the
CreateRoomRequest.Builder
avoiding the need to create one manually viaCreateRoomRequest.builder()
- Parameters:
createRoomRequest
- AConsumer
that will call methods onCreateRoomRequest.Builder
to create a request.- Returns:
- Result of the CreateRoom operation returned by the service.
- See Also:
-
deleteLoggingConfiguration
default DeleteLoggingConfigurationResponse deleteLoggingConfiguration(DeleteLoggingConfigurationRequest deleteLoggingConfigurationRequest) throws ConflictException, AccessDeniedException, ResourceNotFoundException, PendingVerificationException, ValidationException, AwsServiceException, SdkClientException, IvschatException Deletes the specified logging configuration.
- Parameters:
deleteLoggingConfigurationRequest
-- Returns:
- Result of the DeleteLoggingConfiguration operation returned by the service.
- See Also:
-
deleteLoggingConfiguration
default DeleteLoggingConfigurationResponse deleteLoggingConfiguration(Consumer<DeleteLoggingConfigurationRequest.Builder> deleteLoggingConfigurationRequest) throws ConflictException, AccessDeniedException, ResourceNotFoundException, PendingVerificationException, ValidationException, AwsServiceException, SdkClientException, IvschatException Deletes the specified logging configuration.
This is a convenience which creates an instance of the
DeleteLoggingConfigurationRequest.Builder
avoiding the need to create one manually viaDeleteLoggingConfigurationRequest.builder()
- Parameters:
deleteLoggingConfigurationRequest
- AConsumer
that will call methods onDeleteLoggingConfigurationRequest.Builder
to create a request.- Returns:
- Result of the DeleteLoggingConfiguration operation returned by the service.
- See Also:
-
deleteMessage
default DeleteMessageResponse deleteMessage(DeleteMessageRequest deleteMessageRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, PendingVerificationException, ValidationException, AwsServiceException, SdkClientException, IvschatException Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from view and delete it from the client’s chat history. This event’s
EventName
isaws:DELETE_MESSAGE
. This replicates the DeleteMessage WebSocket operation in the Amazon IVS Chat Messaging API.- Parameters:
deleteMessageRequest
-- Returns:
- Result of the DeleteMessage operation returned by the service.
- See Also:
-
deleteMessage
default DeleteMessageResponse deleteMessage(Consumer<DeleteMessageRequest.Builder> deleteMessageRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, PendingVerificationException, ValidationException, AwsServiceException, SdkClientException, IvschatException Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from view and delete it from the client’s chat history. This event’s
EventName
isaws: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 viaDeleteMessageRequest.builder()
- Parameters:
deleteMessageRequest
- AConsumer
that will call methods onDeleteMessageRequest.Builder
to create a request.- Returns:
- Result of the DeleteMessage operation returned by the service.
- See Also:
-
deleteRoom
default DeleteRoomResponse deleteRoom(DeleteRoomRequest deleteRoomRequest) throws AccessDeniedException, ResourceNotFoundException, PendingVerificationException, ValidationException, AwsServiceException, SdkClientException, IvschatException Deletes the specified room.
- Parameters:
deleteRoomRequest
-- Returns:
- Result of the DeleteRoom operation returned by the service.
- See Also:
-
deleteRoom
default DeleteRoomResponse deleteRoom(Consumer<DeleteRoomRequest.Builder> deleteRoomRequest) throws AccessDeniedException, ResourceNotFoundException, PendingVerificationException, ValidationException, AwsServiceException, SdkClientException, IvschatException Deletes the specified room.
This is a convenience which creates an instance of the
DeleteRoomRequest.Builder
avoiding the need to create one manually viaDeleteRoomRequest.builder()
- Parameters:
deleteRoomRequest
- AConsumer
that will call methods onDeleteRoomRequest.Builder
to create a request.- Returns:
- Result of the DeleteRoom operation returned by the service.
- See Also:
-
disconnectUser
default DisconnectUserResponse disconnectUser(DisconnectUserRequest disconnectUserRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, PendingVerificationException, ValidationException, AwsServiceException, SdkClientException, IvschatException Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.
- Parameters:
disconnectUserRequest
-- Returns:
- Result of the DisconnectUser operation returned by the service.
- See Also:
-
disconnectUser
default DisconnectUserResponse disconnectUser(Consumer<DisconnectUserRequest.Builder> disconnectUserRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, PendingVerificationException, ValidationException, AwsServiceException, SdkClientException, IvschatException Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.
This is a convenience which creates an instance of the
DisconnectUserRequest.Builder
avoiding the need to create one manually viaDisconnectUserRequest.builder()
- Parameters:
disconnectUserRequest
- AConsumer
that will call methods onDisconnectUserRequest.Builder
to create a request.- Returns:
- Result of the DisconnectUser operation returned by the service.
- See Also:
-
getLoggingConfiguration
default GetLoggingConfigurationResponse getLoggingConfiguration(GetLoggingConfigurationRequest getLoggingConfigurationRequest) throws AccessDeniedException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, IvschatException Gets the specified logging configuration.
- Parameters:
getLoggingConfigurationRequest
-- Returns:
- Result of the GetLoggingConfiguration operation returned by the service.
- See Also:
-
getLoggingConfiguration
default GetLoggingConfigurationResponse getLoggingConfiguration(Consumer<GetLoggingConfigurationRequest.Builder> getLoggingConfigurationRequest) throws AccessDeniedException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, IvschatException Gets the specified logging configuration.
This is a convenience which creates an instance of the
GetLoggingConfigurationRequest.Builder
avoiding the need to create one manually viaGetLoggingConfigurationRequest.builder()
- Parameters:
getLoggingConfigurationRequest
- AConsumer
that will call methods onGetLoggingConfigurationRequest.Builder
to create a request.- Returns:
- Result of the GetLoggingConfiguration operation returned by the service.
- See Also:
-
getRoom
default GetRoomResponse getRoom(GetRoomRequest getRoomRequest) throws AccessDeniedException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, IvschatException Gets the specified room.
- Parameters:
getRoomRequest
-- Returns:
- Result of the GetRoom operation returned by the service.
- See Also:
-
getRoom
default GetRoomResponse getRoom(Consumer<GetRoomRequest.Builder> getRoomRequest) throws AccessDeniedException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, IvschatException Gets the specified room.
This is a convenience which creates an instance of the
GetRoomRequest.Builder
avoiding the need to create one manually viaGetRoomRequest.builder()
- Parameters:
getRoomRequest
- AConsumer
that will call methods onGetRoomRequest.Builder
to create a request.- Returns:
- Result of the GetRoom operation returned by the service.
- See Also:
-
listLoggingConfigurations
default ListLoggingConfigurationsResponse listLoggingConfigurations(ListLoggingConfigurationsRequest listLoggingConfigurationsRequest) throws AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, IvschatException Gets summary information about all your logging configurations in the AWS region where the API request is processed.
- Parameters:
listLoggingConfigurationsRequest
-- Returns:
- Result of the ListLoggingConfigurations operation returned by the service.
- See Also:
-
listLoggingConfigurations
default ListLoggingConfigurationsResponse listLoggingConfigurations(Consumer<ListLoggingConfigurationsRequest.Builder> listLoggingConfigurationsRequest) throws AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, IvschatException 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 viaListLoggingConfigurationsRequest.builder()
- Parameters:
listLoggingConfigurationsRequest
- AConsumer
that will call methods onListLoggingConfigurationsRequest.Builder
to create a request.- Returns:
- Result of the ListLoggingConfigurations operation returned by the service.
- See Also:
-
listLoggingConfigurationsPaginator
default ListLoggingConfigurationsIterable listLoggingConfigurationsPaginator(ListLoggingConfigurationsRequest listLoggingConfigurationsRequest) throws AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, IvschatException This is a variant of
listLoggingConfigurations(software.amazon.awssdk.services.ivschat.model.ListLoggingConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ivschat.paginators.ListLoggingConfigurationsIterable responses = client.listLoggingConfigurationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ivschat.paginators.ListLoggingConfigurationsIterable responses = client .listLoggingConfigurationsPaginator(request); for (software.amazon.awssdk.services.ivschat.model.ListLoggingConfigurationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ivschat.paginators.ListLoggingConfigurationsIterable responses = client.listLoggingConfigurationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLoggingConfigurations(software.amazon.awssdk.services.ivschat.model.ListLoggingConfigurationsRequest)
operation.- Parameters:
listLoggingConfigurationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listLoggingConfigurationsPaginator
default ListLoggingConfigurationsIterable listLoggingConfigurationsPaginator(Consumer<ListLoggingConfigurationsRequest.Builder> listLoggingConfigurationsRequest) throws AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, IvschatException This is a variant of
listLoggingConfigurations(software.amazon.awssdk.services.ivschat.model.ListLoggingConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ivschat.paginators.ListLoggingConfigurationsIterable responses = client.listLoggingConfigurationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ivschat.paginators.ListLoggingConfigurationsIterable responses = client .listLoggingConfigurationsPaginator(request); for (software.amazon.awssdk.services.ivschat.model.ListLoggingConfigurationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ivschat.paginators.ListLoggingConfigurationsIterable responses = client.listLoggingConfigurationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 viaListLoggingConfigurationsRequest.builder()
- Parameters:
listLoggingConfigurationsRequest
- AConsumer
that will call methods onListLoggingConfigurationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRooms
default ListRoomsResponse listRooms(ListRoomsRequest listRoomsRequest) throws AccessDeniedException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, IvschatException Gets summary information about all your rooms in the AWS region where the API request is processed. Results are sorted in descending order of
updateTime
.- Parameters:
listRoomsRequest
-- Returns:
- Result of the ListRooms operation returned by the service.
- See Also:
-
listRooms
default ListRoomsResponse listRooms(Consumer<ListRoomsRequest.Builder> listRoomsRequest) throws AccessDeniedException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, IvschatException Gets summary information about all your rooms in the AWS region where the API request is processed. Results are sorted in descending order of
updateTime
.
This is a convenience which creates an instance of the
ListRoomsRequest.Builder
avoiding the need to create one manually viaListRoomsRequest.builder()
- Parameters:
listRoomsRequest
- AConsumer
that will call methods onListRoomsRequest.Builder
to create a request.- Returns:
- Result of the ListRooms operation returned by the service.
- See Also:
-
listRoomsPaginator
default ListRoomsIterable listRoomsPaginator(ListRoomsRequest listRoomsRequest) throws AccessDeniedException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, IvschatException This is a variant of
listRooms(software.amazon.awssdk.services.ivschat.model.ListRoomsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ivschat.paginators.ListRoomsIterable responses = client.listRoomsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ivschat.paginators.ListRoomsIterable responses = client.listRoomsPaginator(request); for (software.amazon.awssdk.services.ivschat.model.ListRoomsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ivschat.paginators.ListRoomsIterable responses = client.listRoomsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRooms(software.amazon.awssdk.services.ivschat.model.ListRoomsRequest)
operation.- Parameters:
listRoomsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRoomsPaginator
default ListRoomsIterable listRoomsPaginator(Consumer<ListRoomsRequest.Builder> listRoomsRequest) throws AccessDeniedException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, IvschatException This is a variant of
listRooms(software.amazon.awssdk.services.ivschat.model.ListRoomsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ivschat.paginators.ListRoomsIterable responses = client.listRoomsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ivschat.paginators.ListRoomsIterable responses = client.listRoomsPaginator(request); for (software.amazon.awssdk.services.ivschat.model.ListRoomsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ivschat.paginators.ListRoomsIterable responses = client.listRoomsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRooms(software.amazon.awssdk.services.ivschat.model.ListRoomsRequest)
operation.
This is a convenience which creates an instance of the
ListRoomsRequest.Builder
avoiding the need to create one manually viaListRoomsRequest.builder()
- Parameters:
listRoomsRequest
- AConsumer
that will call methods onListRoomsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IvschatException Gets information about AWS tags for the specified ARN.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IvschatException Gets information about AWS tags for the specified ARN.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
sendEvent
default SendEventResponse sendEvent(SendEventRequest sendEventRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, PendingVerificationException, ValidationException, AwsServiceException, SdkClientException, IvschatException Sends an event to a room. Use this within your application’s business logic to send events to clients of a room; e.g., to notify clients to change the way the chat UI is rendered.
- Parameters:
sendEventRequest
-- Returns:
- Result of the SendEvent operation returned by the service.
- See Also:
-
sendEvent
default SendEventResponse sendEvent(Consumer<SendEventRequest.Builder> sendEventRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, PendingVerificationException, ValidationException, AwsServiceException, SdkClientException, IvschatException Sends an event to a room. Use this within your application’s business logic to send events to clients of a room; e.g., to notify clients to change the way the chat UI is rendered.
This is a convenience which creates an instance of the
SendEventRequest.Builder
avoiding the need to create one manually viaSendEventRequest.builder()
- Parameters:
sendEventRequest
- AConsumer
that will call methods onSendEventRequest.Builder
to create a request.- Returns:
- Result of the SendEvent operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IvschatException Adds or updates tags for the AWS resource with the specified ARN.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IvschatException Adds or updates tags for the AWS resource with the specified ARN.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IvschatException Removes tags from the resource with the specified ARN.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IvschatException Removes tags from the resource with the specified ARN.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateLoggingConfiguration
default UpdateLoggingConfigurationResponse updateLoggingConfiguration(UpdateLoggingConfigurationRequest updateLoggingConfigurationRequest) throws ConflictException, AccessDeniedException, ResourceNotFoundException, PendingVerificationException, ValidationException, AwsServiceException, SdkClientException, IvschatException Updates a specified logging configuration.
- Parameters:
updateLoggingConfigurationRequest
-- Returns:
- Result of the UpdateLoggingConfiguration operation returned by the service.
- See Also:
-
updateLoggingConfiguration
default UpdateLoggingConfigurationResponse updateLoggingConfiguration(Consumer<UpdateLoggingConfigurationRequest.Builder> updateLoggingConfigurationRequest) throws ConflictException, AccessDeniedException, ResourceNotFoundException, PendingVerificationException, ValidationException, AwsServiceException, SdkClientException, IvschatException Updates a specified logging configuration.
This is a convenience which creates an instance of the
UpdateLoggingConfigurationRequest.Builder
avoiding the need to create one manually viaUpdateLoggingConfigurationRequest.builder()
- Parameters:
updateLoggingConfigurationRequest
- AConsumer
that will call methods onUpdateLoggingConfigurationRequest.Builder
to create a request.- Returns:
- Result of the UpdateLoggingConfiguration operation returned by the service.
- See Also:
-
updateRoom
default UpdateRoomResponse updateRoom(UpdateRoomRequest updateRoomRequest) throws AccessDeniedException, ResourceNotFoundException, PendingVerificationException, ValidationException, AwsServiceException, SdkClientException, IvschatException Updates a room’s configuration.
- Parameters:
updateRoomRequest
-- Returns:
- Result of the UpdateRoom operation returned by the service.
- See Also:
-
updateRoom
default UpdateRoomResponse updateRoom(Consumer<UpdateRoomRequest.Builder> updateRoomRequest) throws AccessDeniedException, ResourceNotFoundException, PendingVerificationException, ValidationException, AwsServiceException, SdkClientException, IvschatException Updates a room’s configuration.
This is a convenience which creates an instance of the
UpdateRoomRequest.Builder
avoiding the need to create one manually viaUpdateRoomRequest.builder()
- Parameters:
updateRoomRequest
- AConsumer
that will call methods onUpdateRoomRequest.Builder
to create a request.- Returns:
- Result of the UpdateRoom operation returned by the service.
- See Also:
-
create
Create aIvschatClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aIvschatClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-