AWS SDK for C++AWS SDK for C++ Version 1.11.777 |
#include <IvschatClient.h>
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.
Definition at line 92 of file IvschatClient.h.
Definition at line 97 of file IvschatClient.h.
Definition at line 101 of file IvschatClient.h.
Definition at line 102 of file IvschatClient.h.
Aws::ivschat::IvschatClientConfiguration(),
nullptr
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr,
Aws::ivschat::IvschatClientConfiguration()
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr,
Aws::ivschat::IvschatClientConfiguration()
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
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.
nullptr
An Async wrapper for CreateChatToken that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 181 of file IvschatClient.h.
A Callable wrapper for CreateChatToken that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 172 of file IvschatClient.h.
Creates a logging configuration that allows clients to store and record sent messages.
nullptr
An Async wrapper for CreateLoggingConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 210 of file IvschatClient.h.
A Callable wrapper for CreateLoggingConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 200 of file IvschatClient.h.
{})
const
nullptr,
{}
An Async wrapper for CreateRoom that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 237 of file IvschatClient.h.
{})
const
A Callable wrapper for CreateRoom that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 228 of file IvschatClient.h.
nullptr
An Async wrapper for DeleteLoggingConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 266 of file IvschatClient.h.
A Callable wrapper for DeleteLoggingConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 256 of file IvschatClient.h.
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.
nullptr
An Async wrapper for DeleteMessage that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 298 of file IvschatClient.h.
A Callable wrapper for DeleteMessage that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 289 of file IvschatClient.h.
nullptr
An Async wrapper for DeleteRoom that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 323 of file IvschatClient.h.
A Callable wrapper for DeleteRoom that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 314 of file IvschatClient.h.
Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.
nullptr
An Async wrapper for DisconnectUser that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 352 of file IvschatClient.h.
A Callable wrapper for DisconnectUser that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 343 of file IvschatClient.h.
nullptr
An Async wrapper for GetLoggingConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 378 of file IvschatClient.h.
A Callable wrapper for GetLoggingConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 369 of file IvschatClient.h.
nullptr
An Async wrapper for GetRoom that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 404 of file IvschatClient.h.
A Callable wrapper for GetRoom that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 395 of file IvschatClient.h.
{})
const
Gets summary information about all your logging configurations in the AWS region where the API request is processed.
nullptr,
{}
An Async wrapper for ListLoggingConfigurations that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 433 of file IvschatClient.h.
{})
const
A Callable wrapper for ListLoggingConfigurations that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 423 of file IvschatClient.h.
{})
const
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.
nullptr,
{}
An Async wrapper for ListRooms that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 461 of file IvschatClient.h.
{})
const
A Callable wrapper for ListRooms that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 452 of file IvschatClient.h.
nullptr
An Async wrapper for ListTagsForResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 489 of file IvschatClient.h.
A Callable wrapper for ListTagsForResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 480 of file IvschatClient.h.
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.
nullptr
An Async wrapper for SendEvent that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 516 of file IvschatClient.h.
A Callable wrapper for SendEvent that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 507 of file IvschatClient.h.
nullptr
An Async wrapper for TagResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 542 of file IvschatClient.h.
A Callable wrapper for TagResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 533 of file IvschatClient.h.
nullptr
An Async wrapper for UntagResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 568 of file IvschatClient.h.
A Callable wrapper for UntagResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 559 of file IvschatClient.h.
nullptr
An Async wrapper for UpdateLoggingConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 596 of file IvschatClient.h.
A Callable wrapper for UpdateLoggingConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 586 of file IvschatClient.h.
nullptr
An Async wrapper for UpdateRoom that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 622 of file IvschatClient.h.
A Callable wrapper for UpdateRoom that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 613 of file IvschatClient.h.
Definition at line 628 of file IvschatClient.h.