Module Awso_ivschat.ValuesSource

Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval serviceAbbreviation : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule LogGroupName : sig ... end
Sourcemodule DeliveryStreamName : sig ... end
Sourcemodule BucketName : sig ... end
Sourcemodule ErrorMessage : sig ... end
Sourcemodule FieldName : sig ... end
Sourcemodule FallbackResult : sig ... end
Sourcemodule LambdaArn : sig ... end
Sourcemodule TagKey : sig ... end
Sourcemodule TagValue : sig ... end

Specifies a CloudWatch Logs location where chat logs will be stored.

Specifies a Kinesis Firehose location where chat logs will be stored.

Specifies an S3 location where chat logs will be stored.

Sourcemodule ValidationExceptionField : sig ... end

This object is used in the ValidationException error.

Sourcemodule MessageReviewHandler : sig ... end

Configuration information for optional message review.

Sourcemodule RoomArn : sig ... end
Sourcemodule RoomID : sig ... end
Sourcemodule RoomName : sig ... end
Sourcemodule Tags : sig ... end
Sourcemodule Time : sig ... end
Sourcemodule DestinationConfiguration : sig ... end

A complex type that describes a location where chat logs will be stored. Each member represents the configuration of one log destination. For logging, you define only one type of destination (for CloudWatch Logs, Kinesis Firehose, or S3).

Sourcemodule LoggingConfigurationArn : sig ... end
Sourcemodule LoggingConfigurationID : sig ... end
Sourcemodule LoggingConfigurationName : sig ... end
Sourcemodule LoggingConfigurationState : sig ... end
Sourcemodule ResourceId : sig ... end
Sourcemodule ResourceType : sig ... end
Sourcemodule ValidationExceptionReason : sig ... end
Sourcemodule Limit : sig ... end
Sourcemodule String_ : sig ... end
Sourcemodule RoomSummary : sig ... end

Summary information about a room.

Summary information about a logging configuration.

Sourcemodule ChatTokenCapability : sig ... end
Sourcemodule AccessDeniedException : sig ... end
Sourcemodule PendingVerification : sig ... end
Sourcemodule ResourceNotFoundException : sig ... end
Sourcemodule RoomMaxMessageLength : sig ... end
Sourcemodule ValidationException : sig ... end
Sourcemodule RoomIdentifier : sig ... end
Sourcemodule ConflictException : sig ... end
Sourcemodule InternalServerException : sig ... end
Sourcemodule ResourceArn : sig ... end
Sourcemodule TagKeyList : sig ... end
Sourcemodule ID : sig ... end
Sourcemodule ThrottlingException : sig ... end
Sourcemodule EventAttributes : sig ... end
Sourcemodule EventName : sig ... end
Sourcemodule PaginationToken : sig ... end
Sourcemodule RoomList : sig ... end
Sourcemodule MaxRoomResults : sig ... end
Sourcemodule LoggingConfigurationList : sig ... end
Sourcemodule Reason : sig ... end
Sourcemodule UserID : sig ... end
Sourcemodule MessageID : sig ... end
Sourcemodule ChatToken : sig ... end
Sourcemodule ChatTokenAttributes : sig ... end
Sourcemodule ChatTokenCapabilities : sig ... end
Sourcemodule SessionDurationInMinutes : sig ... end
Sourcemodule UpdateRoomResponse : sig ... end

Updates a room’s configuration.

Sourcemodule UpdateRoomRequest : sig ... end

Updates a room’s configuration.

Updates a specified logging configuration.

Updates a specified logging configuration.

Sourcemodule UntagResourceResponse : sig ... end

Removes tags from the resource with the specified ARN.

Sourcemodule UntagResourceRequest : sig ... end

Removes tags from the resource with the specified ARN.

Sourcemodule TagResourceResponse : sig ... end

Adds or updates tags for the AWS resource with the specified ARN.

Sourcemodule TagResourceRequest : sig ... end

Adds or updates tags for the AWS resource with the specified ARN.

Sourcemodule SendEventResponse : sig ... end

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.

Sourcemodule SendEventRequest : sig ... end

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.

Gets information about AWS tags for the specified ARN.

Gets information about AWS tags for the specified ARN.

Sourcemodule ListRoomsResponse : sig ... end

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.

Sourcemodule ListRoomsRequest : sig ... end

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.

Gets summary information about all your logging configurations in the AWS region where the API request is processed.

Gets summary information about all your logging configurations in the AWS region where the API request is processed.

Sourcemodule GetRoomResponse : sig ... end

Gets the specified room.

Sourcemodule GetRoomRequest : sig ... end

Gets the specified room.

Gets the specified logging configuration.

Gets the specified logging configuration.

Sourcemodule DisconnectUserResponse : sig ... end

Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.

Sourcemodule DisconnectUserRequest : sig ... end

Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.

Sourcemodule DeleteRoomRequest : sig ... end

Deletes the specified room.

Sourcemodule DeleteMessageResponse : sig ... end

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.

Sourcemodule DeleteMessageRequest : sig ... end

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.

Deletes the specified logging configuration.

Sourcemodule CreateRoomResponse : sig ... end

Creates a room that allows clients to connect and pass messages.

Sourcemodule CreateRoomRequest : sig ... end

Creates a room that allows clients to connect and pass messages.

Creates a logging configuration that allows clients to store and record sent messages.

Creates a logging configuration that allows clients to store and record sent messages.

Sourcemodule CreateChatTokenResponse : sig ... end

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.

Sourcemodule CreateChatTokenRequest : sig ... end

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.