(constructor)

[configuration]

Constructs a new instance of the <code>IvschatClient</code> class

config

The resolved configuration of IvschatClient class. This is resolved and normalized from the [constructor configuration interface](@aws-sdk/client-ivschat!IvschatClientConfig:Interface).

destroy

Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

middlewareStack

send

command

options

IvschatClient

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 <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/chat-messaging-api.html"> Amazon IVS Chat Messaging API</a>, 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 <a href="https://docs.aws.amazon.com/general/latest/gr/ivs.html">Amazon IVS page</a> in the AWS General Reference. This document describes HTTP operations. There is a separate messaging API for managing Chat resources; see the <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/chat-messaging-api.html"> Amazon IVS Chat Messaging API Reference</a>. Notes on terminology: <ul> <li> You create service applications using the Amazon IVS Chat API. We refer to these as applications. </li> <li> You create front-end client applications (browser and Android/iOS apps) using the Amazon IVS Chat Messaging API. We refer to these as clients. </li> </ul> Resources The following resources are part of Amazon IVS Chat: <ul> <li> LoggingConfiguration — A configuration that allows customers to store and record sent messages in a chat room. See the Logging Configuration endpoints for more information. </li> <li> Room — The central Amazon IVS Chat resource through which clients connect to and exchange chat messages. See the Room endpoints for more information. </li> </ul> 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 <code>topic:nature</code> to label a particular video category. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in Tagging Amazon Web Services Resources and Tag Editor for details, 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 <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Access Tags</a>). The Amazon IVS Chat API has these tag-related operations: 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: <ul> <li> Authentication is about verifying identity. Requests to the Amazon IVS Chat API must be signed to verify your identity. </li> <li> Authorization is about granting permissions. Your IAM roles need to have permissions for Amazon IVS Chat API requests. </li> </ul> Users (viewers) connect to a room using secure access tokens that you create using the CreateChatToken operation 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 <code>ivschat:DeleteMessage</code> permission. For more information: <ul> <li> Authentication and generating signatures — See <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html">Authenticating Requests (Amazon Web Services Signature Version 4)</a> in the Amazon Web Services General Reference. </li> <li> Managing Amazon IVS permissions — See <a href="https://docs.aws.amazon.com/ivs/latest/userguide/security-iam.html">Identity and Access Management</a> on the Security page of the Amazon IVS User Guide. </li> </ul> 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 <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names</a> in the AWS General Reference.

defaultsMode

The [@smithy/smithy-client#DefaultsMode](@smithy/smithy-client!DefaultsMode:type) that will be used to determine how certain default configuration options are resolved in the SDK.

disableHostPrefix

Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.

extensions

logger

Optional logger for logging debug/info/warn/error.

maxAttempts

Value for how many times a request will be made at most in case of retry.

region

The AWS region to which this client will send requests

requestHandler

The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.

retryMode

useDualstackEndpoint

useFipsEndpoint

ClientDefaults

CreateChatTokenCommand

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 <code>capabilities</code> field to permit an end user to send messages or moderate a room. The <code>attributes</code> 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.

CreateLoggingConfigurationCommand

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

CreateRoomCommand

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

DeleteLoggingConfigurationCommand

Deletes the specified logging configuration.

DeleteMessageCommand

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 <code>EventName</code> is <code>aws:DELETE_MESSAGE</code>. This replicates the <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-deletemessage-publish.html"> DeleteMessage</a> WebSocket operation in the Amazon IVS Chat Messaging API.

DeleteRoomCommand

DisconnectUserCommand

Disconnects all connections using a specified user ID from a room. This replicates the <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-disconnectuser-publish.html"> DisconnectUser</a> WebSocket operation in the Amazon IVS Chat Messaging API.

GetLoggingConfigurationCommand

Gets the specified logging configuration.

GetRoomCommand

ListLoggingConfigurationsCommand

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

ListRoomsCommand

Gets summary information about all your rooms in the AWS region where the API request is processed. Results are sorted in descending order of <code>updateTime</code>.

ListTagsForResourceCommand

Gets information about AWS tags for the specified ARN.

SendEventCommand

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.

TagResourceCommand

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

UntagResourceCommand

Removes tags from the resource with the specified ARN.

UpdateLoggingConfigurationCommand

Updates a specified logging configuration.