com.amazonaws.services.ivschat.Amazonivschat Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ivschat Show documentation
/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.ivschat;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.ivschat.model.*;
/**
* Interface for accessing ivschat.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.ivschat.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 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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface Amazonivschat {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "ivschat";
/**
*
* 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.
*
*
* @param createChatTokenRequest
* @return Result of the CreateChatToken operation returned by the service.
* @throws AccessDeniedException
* @throws ResourceNotFoundException
* @throws PendingVerificationException
* @throws ValidationException
* @sample Amazonivschat.CreateChatToken
* @see AWS API
* Documentation
*/
CreateChatTokenResult createChatToken(CreateChatTokenRequest createChatTokenRequest);
/**
*
* Creates a logging configuration that allows clients to store and record sent messages.
*
*
* @param createLoggingConfigurationRequest
* @return Result of the CreateLoggingConfiguration operation returned by the service.
* @throws ConflictException
* @throws AccessDeniedException
* @throws ResourceNotFoundException
* @throws ServiceQuotaExceededException
* @throws PendingVerificationException
* @throws ValidationException
* @sample Amazonivschat.CreateLoggingConfiguration
* @see AWS API Documentation
*/
CreateLoggingConfigurationResult createLoggingConfiguration(CreateLoggingConfigurationRequest createLoggingConfigurationRequest);
/**
*
* Creates a room that allows clients to connect and pass messages.
*
*
* @param createRoomRequest
* @return Result of the CreateRoom operation returned by the service.
* @throws ConflictException
* @throws AccessDeniedException
* @throws ResourceNotFoundException
* @throws ServiceQuotaExceededException
* @throws PendingVerificationException
* @throws ValidationException
* @sample Amazonivschat.CreateRoom
* @see AWS API
* Documentation
*/
CreateRoomResult createRoom(CreateRoomRequest createRoomRequest);
/**
*
* Deletes the specified logging configuration.
*
*
* @param deleteLoggingConfigurationRequest
* @return Result of the DeleteLoggingConfiguration operation returned by the service.
* @throws ConflictException
* @throws AccessDeniedException
* @throws ResourceNotFoundException
* @throws PendingVerificationException
* @throws ValidationException
* @sample Amazonivschat.DeleteLoggingConfiguration
* @see AWS API Documentation
*/
DeleteLoggingConfigurationResult deleteLoggingConfiguration(DeleteLoggingConfigurationRequest deleteLoggingConfigurationRequest);
/**
*
* 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.
*
*
* @param deleteMessageRequest
* @return Result of the DeleteMessage operation returned by the service.
* @throws ThrottlingException
* @throws AccessDeniedException
* @throws ResourceNotFoundException
* @throws PendingVerificationException
* @throws ValidationException
* @sample Amazonivschat.DeleteMessage
* @see AWS API
* Documentation
*/
DeleteMessageResult deleteMessage(DeleteMessageRequest deleteMessageRequest);
/**
*
* Deletes the specified room.
*
*
* @param deleteRoomRequest
* @return Result of the DeleteRoom operation returned by the service.
* @throws AccessDeniedException
* @throws ResourceNotFoundException
* @throws PendingVerificationException
* @throws ValidationException
* @sample Amazonivschat.DeleteRoom
* @see AWS API
* Documentation
*/
DeleteRoomResult deleteRoom(DeleteRoomRequest deleteRoomRequest);
/**
*
* Disconnects all connections using a specified user ID from a room. This replicates the
* DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.
*
*
* @param disconnectUserRequest
* @return Result of the DisconnectUser operation returned by the service.
* @throws ThrottlingException
* @throws AccessDeniedException
* @throws ResourceNotFoundException
* @throws PendingVerificationException
* @throws ValidationException
* @sample Amazonivschat.DisconnectUser
* @see AWS API
* Documentation
*/
DisconnectUserResult disconnectUser(DisconnectUserRequest disconnectUserRequest);
/**
*
* Gets the specified logging configuration.
*
*
* @param getLoggingConfigurationRequest
* @return Result of the GetLoggingConfiguration operation returned by the service.
* @throws AccessDeniedException
* @throws ResourceNotFoundException
* @throws ValidationException
* @sample Amazonivschat.GetLoggingConfiguration
* @see AWS API Documentation
*/
GetLoggingConfigurationResult getLoggingConfiguration(GetLoggingConfigurationRequest getLoggingConfigurationRequest);
/**
*
* Gets the specified room.
*
*
* @param getRoomRequest
* @return Result of the GetRoom operation returned by the service.
* @throws AccessDeniedException
* @throws ResourceNotFoundException
* @throws ValidationException
* @sample Amazonivschat.GetRoom
* @see AWS API
* Documentation
*/
GetRoomResult getRoom(GetRoomRequest getRoomRequest);
/**
*
* Gets summary information about all your logging configurations in the AWS region where the API request is
* processed.
*
*
* @param listLoggingConfigurationsRequest
* @return Result of the ListLoggingConfigurations operation returned by the service.
* @throws AccessDeniedException
* @throws ValidationException
* @sample Amazonivschat.ListLoggingConfigurations
* @see AWS API Documentation
*/
ListLoggingConfigurationsResult listLoggingConfigurations(ListLoggingConfigurationsRequest listLoggingConfigurationsRequest);
/**
*
* 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.
*
*
* @param listRoomsRequest
* @return Result of the ListRooms operation returned by the service.
* @throws AccessDeniedException
* @throws ResourceNotFoundException
* @throws ValidationException
* @sample Amazonivschat.ListRooms
* @see AWS API
* Documentation
*/
ListRoomsResult listRooms(ListRoomsRequest listRoomsRequest);
/**
*
* Gets information about AWS tags for the specified ARN.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ResourceNotFoundException
* @throws InternalServerException
* @throws ValidationException
* @sample Amazonivschat.ListTagsForResource
* @see AWS
* API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* 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.
*
*
* @param sendEventRequest
* @return Result of the SendEvent operation returned by the service.
* @throws ThrottlingException
* @throws AccessDeniedException
* @throws ResourceNotFoundException
* @throws PendingVerificationException
* @throws ValidationException
* @sample Amazonivschat.SendEvent
* @see AWS API
* Documentation
*/
SendEventResult sendEvent(SendEventRequest sendEventRequest);
/**
*
* Adds or updates tags for the AWS resource with the specified ARN.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws ResourceNotFoundException
* @throws InternalServerException
* @throws ValidationException
* @sample Amazonivschat.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Removes tags from the resource with the specified ARN.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws ResourceNotFoundException
* @throws InternalServerException
* @throws ValidationException
* @sample Amazonivschat.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Updates a specified logging configuration.
*
*
* @param updateLoggingConfigurationRequest
* @return Result of the UpdateLoggingConfiguration operation returned by the service.
* @throws ConflictException
* @throws AccessDeniedException
* @throws ResourceNotFoundException
* @throws PendingVerificationException
* @throws ValidationException
* @sample Amazonivschat.UpdateLoggingConfiguration
* @see AWS API Documentation
*/
UpdateLoggingConfigurationResult updateLoggingConfiguration(UpdateLoggingConfigurationRequest updateLoggingConfigurationRequest);
/**
*
* Updates a room’s configuration.
*
*
* @param updateRoomRequest
* @return Result of the UpdateRoom operation returned by the service.
* @throws AccessDeniedException
* @throws ResourceNotFoundException
* @throws PendingVerificationException
* @throws ValidationException
* @sample Amazonivschat.UpdateRoom
* @see AWS API
* Documentation
*/
UpdateRoomResult updateRoom(UpdateRoomRequest updateRoomRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}