com.amazonaws.services.ivschat

Interface Amazonivschat

All Known Subinterfaces:

AmazonivschatAsync

All Known Implementing Classes:

AbstractAmazonivschat, AbstractAmazonivschatAsync, AmazonivschatAsyncClient, AmazonivschatClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface Amazonivschat

Interface for accessing ivschat.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonivschat instead.

Introduction

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

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

Notes on terminology:

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

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

Resources

The following resource is part of Amazon IVS Chat:

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

Tagging

A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature to label a particular video category. See Tagging AWS Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no service-specific constraints beyond what is documented there.

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

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

At most 50 tags can be applied to a resource.

API Access Security

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

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

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

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

Signing API Requests

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

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

For more information:

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

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

Amazon Resource Names (ARNs)

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

Messaging Endpoints

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

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

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

Chat Token Endpoint

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

Room Endpoints

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

• DeleteRoom — Deletes the specified room.

• GetRoom — Gets the specified room.

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

• UpdateRoom — Updates a room’s configuration.

Tags Endpoints

• ListTagsForResource — Gets information about AWS tags for the specified ARN.

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

• UntagResource — Removes tags from the resource with the specified ARN.

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateChatTokenResult	createChatToken(CreateChatTokenRequest createChatTokenRequest) Creates an encrypted token that is used to establish an individual WebSocket connection to a room.
CreateRoomResult	createRoom(CreateRoomRequest createRoomRequest) Creates a room that allows clients to connect and pass messages.
DeleteMessageResult	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.
DeleteRoomResult	deleteRoom(DeleteRoomRequest deleteRoomRequest) Deletes the specified room.
DisconnectUserResult	disconnectUser(DisconnectUserRequest disconnectUserRequest) 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.
GetRoomResult	getRoom(GetRoomRequest getRoomRequest) Gets the specified room.
ListRoomsResult	listRooms(ListRoomsRequest listRoomsRequest) Gets summary information about all your rooms in the AWS region where the API request is processed.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Gets information about AWS tags for the specified ARN.
SendEventResult	sendEvent(SendEventRequest sendEventRequest) Sends an event to a room.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds or updates tags for the AWS resource with the specified ARN.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes tags from the resource with the specified ARN.
UpdateRoomResult	updateRoom(UpdateRoomRequest updateRoomRequest) Updates a room’s configuration.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createChatToken

CreateChatTokenResult createChatToken(CreateChatTokenRequest createChatTokenRequest)

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

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

Parameters:

createChatTokenRequest -

Returns:

Result of the CreateChatToken operation returned by the service.

Throws:

AccessDeniedException

ResourceNotFoundException

PendingVerificationException

ValidationException

See Also:

AWS API Documentation

createRoom

CreateRoomResult createRoom(CreateRoomRequest createRoomRequest)

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

Parameters:

createRoomRequest -

Returns:

Result of the CreateRoom operation returned by the service.

Throws:

ConflictException

AccessDeniedException

ResourceNotFoundException

ServiceQuotaExceededException

PendingVerificationException

ValidationException

See Also:

AWS API Documentation

deleteMessage

DeleteMessageResult deleteMessage(DeleteMessageRequest deleteMessageRequest)

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

Parameters:

deleteMessageRequest -

Returns:

Result of the DeleteMessage operation returned by the service.

Throws:

ThrottlingException

AccessDeniedException

ResourceNotFoundException

ValidationException

See Also:

AWS API Documentation

deleteRoom

DeleteRoomResult deleteRoom(DeleteRoomRequest deleteRoomRequest)

Deletes the specified room.

Parameters:

deleteRoomRequest -

Returns:

Result of the DeleteRoom operation returned by the service.

Throws:

AccessDeniedException

ResourceNotFoundException

PendingVerificationException

ValidationException

See Also:

AWS API Documentation

disconnectUser

DisconnectUserResult 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:

Result of the DisconnectUser operation returned by the service.

Throws:

ThrottlingException

AccessDeniedException

ResourceNotFoundException

ValidationException

See Also:

AWS API Documentation

getRoom

GetRoomResult getRoom(GetRoomRequest getRoomRequest)

Gets the specified room.

Parameters:

getRoomRequest -

Returns:

Result of the GetRoom operation returned by the service.

Throws:

AccessDeniedException

ResourceNotFoundException

ValidationException

See Also:

AWS API Documentation

listRooms

ListRoomsResult 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:

Result of the ListRooms operation returned by the service.

Throws:

AccessDeniedException

ResourceNotFoundException

ValidationException

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Gets information about AWS tags for the specified ARN.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ResourceNotFoundException

InternalServerException

ValidationException

See Also:

AWS API Documentation

sendEvent

SendEventResult 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:

Result of the SendEvent operation returned by the service.

Throws:

ThrottlingException

AccessDeniedException

ResourceNotFoundException

ValidationException

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

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

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

ResourceNotFoundException

InternalServerException

ValidationException

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes tags from the resource with the specified ARN.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ResourceNotFoundException

InternalServerException

ValidationException

See Also:

AWS API Documentation

updateRoom

UpdateRoomResult updateRoom(UpdateRoomRequest updateRoomRequest)

Updates a room’s configuration.

Parameters:

updateRoomRequest -

Returns:

Result of the UpdateRoom operation returned by the service.

Throws:

AccessDeniedException

ResourceNotFoundException

PendingVerificationException

ValidationException

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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