Package ivschat provides the API client, operations, and parameter types for
Amazon Interactive Video Service Chat.
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 (https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/chat-messaging-api.html)
, 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 (https://docs.aws.amazon.com/general/latest/gr/ivs.html)
in the AWS General Reference. Notes on terminology:
Key Concepts
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 (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
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 (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html)
). 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:
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:
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 (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
in the AWS General Reference. Messaging Endpoints
Chat Token Endpoint
Room Endpoints
Logging Configuration Endpoints
Tags Endpoints
All the above are HTTP operations. There is a separate messaging API for
managing Chat resources; see the Amazon IVS Chat Messaging API Reference (https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/chat-messaging-api.html)
.