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.
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 create_chat_token
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.
Messaging Endpoints
delete_message — 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.
disconnect_user — Disconnects all
connections using a specified user ID from a room. This replicates
the
DisconnectUser
WebSocket operation in the Amazon IVS Chat Messaging API.
send_event — 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
create_chat_token — 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
create_room — Creates a room that allows
clients to connect and pass messages.
delete_room — Deletes the specified room.
get_room — Gets the specified room.
list_rooms — Gets summary information about
all your rooms in the AWS region where the API request is processed.
update_room — Updates a room’s
configuration.
Tags Endpoints
list_tags_for_resource — Gets
information about AWS tags for the specified ARN.
tag_resource — Adds or updates tags for
the AWS resource with the specified ARN.
untag_resource — 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.
ivschat(config = list())A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Optional configuration of credentials, endpoint, and/or region.
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e., http://s3.amazonaws.com/BUCKET/KEY.
svc <- ivschat(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical"
)
)
| create_chat_token | Creates an encrypted token that is used to establish an individual WebSocket connection to a room |
| create_room | Creates a room that allows clients to connect and pass messages |
| delete_message | 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 |
| delete_room | Deletes the specified room |
| disconnect_user | Disconnects all connections using a specified user ID from a room |
| get_room | Gets the specified room |
| list_rooms | Gets summary information about all your rooms in the AWS region where the API request is processed |
| list_tags_for_resource | Gets information about AWS tags for the specified ARN |
| send_event | Sends an event to a room |
| tag_resource | Adds or updates tags for the AWS resource with the specified ARN |
| untag_resource | Removes tags from the resource with the specified ARN |
| update_room | Updates a room’s configuration |
if (FALSE) {
svc <- ivschat()
svc$create_chat_token(
Foo = 123
)
}
Run the code above in your browser using DataLab