com.amazonaws.services.ivschat

Class AmazonivschatClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.ivschat.AmazonivschatClient

All Implemented Interfaces:

Amazonivschat

Direct Known Subclasses:

AmazonivschatAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonivschatClient
extends AmazonWebServiceClient
implements Amazonivschat

Client for accessing ivschat. All service calls made using this client are blocking, and will not return until the service call completes.

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:nature to label a particular video category. See Tagging AWS Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no service-specific constraints beyond what is documented there.

Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).

The Amazon IVS Chat API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Room.

At most 50 tags can be applied to a resource.

API Access Security

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

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

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

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

Signing API Requests

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

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

For more information:

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

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

Amazon Resource Names (ARNs)

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

Messaging Endpoints

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

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

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

Chat Token Endpoint

• CreateChatToken — Creates an encrypted token that is used 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 inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.ivschat.Amazonivschat

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonivschatClientBuilder	builder()
CreateChatTokenResult	createChatToken(CreateChatTokenRequest request) Creates an encrypted token that is used by a chat participant to establish an individual WebSocket chat connection to a room.
CreateLoggingConfigurationResult	createLoggingConfiguration(CreateLoggingConfigurationRequest request) Creates a logging configuration that allows clients to store and record sent messages.
CreateRoomResult	createRoom(CreateRoomRequest request) Creates a room that allows clients to connect and pass messages.
DeleteLoggingConfigurationResult	deleteLoggingConfiguration(DeleteLoggingConfigurationRequest request) Deletes the specified logging configuration.
DeleteMessageResult	deleteMessage(DeleteMessageRequest request) 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.
DeleteRoomResult	deleteRoom(DeleteRoomRequest request) Deletes the specified room.
DisconnectUserResult	disconnectUser(DisconnectUserRequest request) Disconnects all connections using a specified user ID from a room.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetLoggingConfigurationResult	getLoggingConfiguration(GetLoggingConfigurationRequest request) Gets the specified logging configuration.
GetRoomResult	getRoom(GetRoomRequest request) Gets the specified room.
ListLoggingConfigurationsResult	listLoggingConfigurations(ListLoggingConfigurationsRequest request) Gets summary information about all your logging configurations in the AWS region where the API request is processed.
ListRoomsResult	listRooms(ListRoomsRequest request) Gets summary information about all your rooms in the AWS region where the API request is processed.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Gets information about AWS tags for the specified ARN.
SendEventResult	sendEvent(SendEventRequest request) Sends an event to a room.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Adds or updates tags for the AWS resource with the specified ARN.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes tags from the resource with the specified ARN.
UpdateLoggingConfigurationResult	updateLoggingConfiguration(UpdateLoggingConfigurationRequest request) Updates a specified logging configuration.
UpdateRoomResult	updateRoom(UpdateRoomRequest request) Updates a room’s configuration.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AmazonivschatClientBuilder builder()

createChatToken

public CreateChatTokenResult createChatToken(CreateChatTokenRequest request)

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.

Specified by:

createChatToken in interface Amazonivschat

Parameters:

createChatTokenRequest -

Returns:

Result of the CreateChatToken operation returned by the service.

Throws:

AccessDeniedException

ResourceNotFoundException

PendingVerificationException

ValidationException

See Also:

AWS API Documentation

createLoggingConfiguration

public CreateLoggingConfigurationResult createLoggingConfiguration(CreateLoggingConfigurationRequest request)

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

Specified by:

createLoggingConfiguration in interface Amazonivschat

Parameters:

createLoggingConfigurationRequest -

Returns:

Result of the CreateLoggingConfiguration operation returned by the service.

Throws:

ConflictException

AccessDeniedException

ResourceNotFoundException

ServiceQuotaExceededException

PendingVerificationException

ValidationException

See Also:

AWS API Documentation

createRoom

public CreateRoomResult createRoom(CreateRoomRequest request)

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

Specified by:

createRoom in interface Amazonivschat

Parameters:

createRoomRequest -

Returns:

Result of the CreateRoom operation returned by the service.

Throws:

ConflictException

AccessDeniedException

ResourceNotFoundException

ServiceQuotaExceededException

PendingVerificationException

ValidationException

See Also:

AWS API Documentation

deleteLoggingConfiguration

public DeleteLoggingConfigurationResult deleteLoggingConfiguration(DeleteLoggingConfigurationRequest request)

Deletes the specified logging configuration.

Specified by:

deleteLoggingConfiguration in interface Amazonivschat

Parameters:

deleteLoggingConfigurationRequest -

Returns:

Result of the DeleteLoggingConfiguration operation returned by the service.

Throws:

ConflictException

AccessDeniedException

ResourceNotFoundException

PendingVerificationException

ValidationException

See Also:

AWS API Documentation

deleteMessage

public DeleteMessageResult deleteMessage(DeleteMessageRequest request)

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

Specified by:

deleteMessage in interface Amazonivschat

Parameters:

deleteMessageRequest -

Returns:

Result of the DeleteMessage operation returned by the service.

Throws:

ThrottlingException

AccessDeniedException

ResourceNotFoundException

PendingVerificationException

ValidationException

See Also:

AWS API Documentation

deleteRoom

public DeleteRoomResult deleteRoom(DeleteRoomRequest request)

Deletes the specified room.

Specified by:

deleteRoom in interface Amazonivschat

Parameters:

deleteRoomRequest -

Returns:

Result of the DeleteRoom operation returned by the service.

Throws:

AccessDeniedException

ResourceNotFoundException

PendingVerificationException

ValidationException

See Also:

AWS API Documentation

disconnectUser

public DisconnectUserResult disconnectUser(DisconnectUserRequest request)

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

Specified by:

disconnectUser in interface Amazonivschat

Parameters:

disconnectUserRequest -

Returns:

Result of the DisconnectUser operation returned by the service.

Throws:

ThrottlingException

AccessDeniedException

ResourceNotFoundException

PendingVerificationException

ValidationException

See Also:

AWS API Documentation

getLoggingConfiguration

public GetLoggingConfigurationResult getLoggingConfiguration(GetLoggingConfigurationRequest request)

Gets the specified logging configuration.

Specified by:

getLoggingConfiguration in interface Amazonivschat

Parameters:

getLoggingConfigurationRequest -

Returns:

Result of the GetLoggingConfiguration operation returned by the service.

Throws:

AccessDeniedException

ResourceNotFoundException

ValidationException

See Also:

AWS API Documentation

getRoom

public GetRoomResult getRoom(GetRoomRequest request)

Gets the specified room.

Specified by:

getRoom in interface Amazonivschat

Parameters:

getRoomRequest -

Returns:

Result of the GetRoom operation returned by the service.

Throws:

AccessDeniedException

ResourceNotFoundException

ValidationException

See Also:

AWS API Documentation

listLoggingConfigurations

public ListLoggingConfigurationsResult listLoggingConfigurations(ListLoggingConfigurationsRequest request)

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

Specified by:

listLoggingConfigurations in interface Amazonivschat

Parameters:

listLoggingConfigurationsRequest -

Returns:

Result of the ListLoggingConfigurations operation returned by the service.

Throws:

AccessDeniedException

ValidationException

See Also:

AWS API Documentation

listRooms

public ListRoomsResult listRooms(ListRoomsRequest request)

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.

Specified by:

listRooms in interface Amazonivschat

Parameters:

listRoomsRequest -

Returns:

Result of the ListRooms operation returned by the service.

Throws:

AccessDeniedException

ResourceNotFoundException

ValidationException

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Gets information about AWS tags for the specified ARN.

Specified by:

listTagsForResource in interface Amazonivschat

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ResourceNotFoundException

InternalServerException

ValidationException

See Also:

AWS API Documentation

sendEvent

public SendEventResult sendEvent(SendEventRequest request)

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.

Specified by:

sendEvent in interface Amazonivschat

Parameters:

sendEventRequest -

Returns:

Result of the SendEvent operation returned by the service.

Throws:

ThrottlingException

AccessDeniedException

ResourceNotFoundException

PendingVerificationException

ValidationException

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

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

Specified by:

tagResource in interface Amazonivschat

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

ResourceNotFoundException

InternalServerException

ValidationException

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes tags from the resource with the specified ARN.

Specified by:

untagResource in interface Amazonivschat

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ResourceNotFoundException

InternalServerException

ValidationException

See Also:

AWS API Documentation

updateLoggingConfiguration

public UpdateLoggingConfigurationResult updateLoggingConfiguration(UpdateLoggingConfigurationRequest request)

Updates a specified logging configuration.

Specified by:

updateLoggingConfiguration in interface Amazonivschat

Parameters:

updateLoggingConfigurationRequest -

Returns:

Result of the UpdateLoggingConfiguration operation returned by the service.

Throws:

ConflictException

AccessDeniedException

ResourceNotFoundException

PendingVerificationException

ValidationException

See Also:

AWS API Documentation

updateRoom

public UpdateRoomResult updateRoom(UpdateRoomRequest request)

Updates a room’s configuration.

Specified by:

updateRoom in interface Amazonivschat

Parameters:

updateRoomRequest -

Returns:

Result of the UpdateRoom operation returned by the service.

Throws:

AccessDeniedException

ResourceNotFoundException

PendingVerificationException

ValidationException

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface Amazonivschat

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface Amazonivschat

Overrides:

shutdown in class AmazonWebServiceClient