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…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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 .
This document describes HTTP operations. There is a separate messaging API
for managing Chat resources; see the Amazon IVS Chat Messaging API
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 Best practices and strategies 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 Access Tags ).
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:
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 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 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 .
Endpoints 17
- POSTCreate chat token
/CreateChatTokenCreates 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… - POSTCreate logging configuration
/CreateLoggingConfigurationCreates a logging configuration that allows clients to store and record sent messages. - POSTCreate room
/CreateRoomCreates a room that allows clients to connect and pass messages. - POSTDelete logging configuration
/DeleteLoggingConfigurationDeletes the specified logging configuration. - POSTDelete message
/DeleteMessageSends 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… - POSTDelete room
/DeleteRoomDeletes the specified room. - POSTDisconnect user
/DisconnectUserDisconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API. - POSTGet logging configuration
/GetLoggingConfigurationGets the specified logging configuration. - POSTGet room
/GetRoomGets the specified room. - POSTList logging configurations
/ListLoggingConfigurationsGets summary information about all your logging configurations in the AWS region where the API request is processed. - POSTList rooms
/ListRoomsGets summary information about all your rooms in the AWS region where the API request is processed. Results are sorted in descending order of updateTime . - GETList tags for resource
/tags/:resourceArnGets information about AWS tags for the specified ARN. - POSTTag resource
/tags/:resourceArnAdds or updates tags for the AWS resource with the specified ARN. - DELETEUntag resource
/tags/:resourceArn?tagKeys=Removes tags from the resource with the specified ARN. - POSTSend event
/SendEventSends 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… - POSTUpdate logging configuration
/UpdateLoggingConfigurationUpdates a specified logging configuration. - POSTUpdate room
/UpdateRoomUpdates a room’s configuration.
API details
- Base URL
https://ivschat.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 17 operations on 15 pathsPOST 15GET 1DELETE 1
- Description format
- AWS Smithy model, API version
2020-07-14 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon Interactive Video Service Chat in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Interactive Video Service Chat collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Create chat token” (POST /CreateChatToken), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the 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… It is listed under Media & content and has 17 endpoints.
Who publishes the Amazon Interactive Video Service Chat?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon Interactive Video Service Chat?
Requests go to https://ivschat.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon Interactive Video Service Chat?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon Interactive Video Service Chat have?
17 operations on 15 paths (15 POST, 1 GET, 1 DELETE).
Is forking the Amazon Interactive Video Service Chat free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.