/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the ivschat-2020-07-14.normal.json service model. */ using System; using System.Threading; using System.Threading.Tasks; using System.Collections.Generic; using Amazon.Runtime; using Amazon.Ivschat.Model; namespace Amazon.Ivschat { /// /// Interface for accessing Ivschat /// /// 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: /// /// /// /// Resources /// /// /// /// The following resources are part of Amazon IVS Chat: /// /// /// /// 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 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). /// /// /// /// 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 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. /// /// public partial interface IAmazonIvschat : IAmazonService, IDisposable { #if AWS_ASYNC_ENUMERABLES_API /// /// Paginators for the service /// IIvschatPaginatorFactory Paginators { get; } #endif #region CreateChatToken /// /// 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. /// /// /// Container for the necessary parameters to execute the CreateChatToken service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateChatToken service method, as returned by Ivschat. /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for CreateChatToken Operation Task CreateChatTokenAsync(CreateChatTokenRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateLoggingConfiguration /// /// Creates a logging configuration that allows clients to store and record sent messages. /// /// Container for the necessary parameters to execute the CreateLoggingConfiguration service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateLoggingConfiguration service method, as returned by Ivschat. /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for CreateLoggingConfiguration Operation Task CreateLoggingConfigurationAsync(CreateLoggingConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateRoom /// /// Creates a room that allows clients to connect and pass messages. /// /// Container for the necessary parameters to execute the CreateRoom service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateRoom service method, as returned by Ivschat. /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for CreateRoom Operation Task CreateRoomAsync(CreateRoomRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteLoggingConfiguration /// /// Deletes the specified logging configuration. /// /// Container for the necessary parameters to execute the DeleteLoggingConfiguration service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteLoggingConfiguration service method, as returned by Ivschat. /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for DeleteLoggingConfiguration Operation Task DeleteLoggingConfigurationAsync(DeleteLoggingConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteMessage /// /// 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. /// /// Container for the necessary parameters to execute the DeleteMessage service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteMessage service method, as returned by Ivschat. /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for DeleteMessage Operation Task DeleteMessageAsync(DeleteMessageRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteRoom /// /// Deletes the specified room. /// /// Container for the necessary parameters to execute the DeleteRoom service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteRoom service method, as returned by Ivschat. /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for DeleteRoom Operation Task DeleteRoomAsync(DeleteRoomRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DisconnectUser /// /// Disconnects all connections using a specified user ID from a room. This replicates /// the /// DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API. /// /// Container for the necessary parameters to execute the DisconnectUser service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DisconnectUser service method, as returned by Ivschat. /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for DisconnectUser Operation Task DisconnectUserAsync(DisconnectUserRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetLoggingConfiguration /// /// Gets the specified logging configuration. /// /// Container for the necessary parameters to execute the GetLoggingConfiguration service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetLoggingConfiguration service method, as returned by Ivschat. /// /// /// /// /// /// /// /// /// /// REST API Reference for GetLoggingConfiguration Operation Task GetLoggingConfigurationAsync(GetLoggingConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetRoom /// /// Gets the specified room. /// /// Container for the necessary parameters to execute the GetRoom service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetRoom service method, as returned by Ivschat. /// /// /// /// /// /// /// /// /// /// REST API Reference for GetRoom Operation Task GetRoomAsync(GetRoomRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListLoggingConfigurations /// /// Gets summary information about all your logging configurations in the AWS region where /// the API request is processed. /// /// Container for the necessary parameters to execute the ListLoggingConfigurations service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListLoggingConfigurations service method, as returned by Ivschat. /// /// /// /// /// /// /// REST API Reference for ListLoggingConfigurations Operation Task ListLoggingConfigurationsAsync(ListLoggingConfigurationsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListRooms /// /// 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. /// /// Container for the necessary parameters to execute the ListRooms service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListRooms service method, as returned by Ivschat. /// /// /// /// /// /// /// /// /// /// REST API Reference for ListRooms Operation Task ListRoomsAsync(ListRoomsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListTagsForResource /// /// Gets information about AWS tags for the specified ARN. /// /// Container for the necessary parameters to execute the ListTagsForResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListTagsForResource service method, as returned by Ivschat. /// /// /// /// /// /// /// /// /// /// REST API Reference for ListTagsForResource Operation Task ListTagsForResourceAsync(ListTagsForResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region SendEvent /// /// 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. /// /// Container for the necessary parameters to execute the SendEvent service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the SendEvent service method, as returned by Ivschat. /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for SendEvent Operation Task SendEventAsync(SendEventRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region TagResource /// /// Adds or updates tags for the AWS resource with the specified ARN. /// /// Container for the necessary parameters to execute the TagResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the TagResource service method, as returned by Ivschat. /// /// /// /// /// /// /// /// /// /// REST API Reference for TagResource Operation Task TagResourceAsync(TagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UntagResource /// /// Removes tags from the resource with the specified ARN. /// /// Container for the necessary parameters to execute the UntagResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UntagResource service method, as returned by Ivschat. /// /// /// /// /// /// /// /// /// /// REST API Reference for UntagResource Operation Task UntagResourceAsync(UntagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateLoggingConfiguration /// /// Updates a specified logging configuration. /// /// Container for the necessary parameters to execute the UpdateLoggingConfiguration service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateLoggingConfiguration service method, as returned by Ivschat. /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for UpdateLoggingConfiguration Operation Task UpdateLoggingConfigurationAsync(UpdateLoggingConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateRoom /// /// Updates a room’s configuration. /// /// Container for the necessary parameters to execute the UpdateRoom service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateRoom service method, as returned by Ivschat. /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for UpdateRoom Operation Task UpdateRoomAsync(UpdateRoomRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion } }