String logGroupName
Name of the Amazon Cloudwatch Logs destination where chat activity will be logged.
Map<K,V> attributes
Application-provided attributes to encode into the token and attach to a chat session. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.
List<E> capabilities
Set of capabilities that the user is allowed to perform in the room. Default: None (the capability to view messages is implicitly included in all requests).
String roomIdentifier
Identifier of the room that the client is trying to access. Currently this must be an ARN.
Integer sessionDurationInMinutes
Session duration (in minutes), after which the session expires. Default: 60 (1 hour).
String userId
Application-provided ID that uniquely identifies the user associated with this token. This can be any UTF-8 encoded text.
Date sessionExpirationTime
Time after which an end user's session is no longer valid. This is an ISO 8601 timestamp; note that this is returned as a string.
String token
The issued client token, encrypted.
Date tokenExpirationTime
Time after which the token is no longer valid and cannot be used to connect to a room. This is an ISO 8601 timestamp; note that this is returned as a string.
DestinationConfiguration destinationConfiguration
A complex type that contains a destination configuration for where chat content will be logged. There can be only
one type of destination (cloudWatchLogs, firehose, or s3) in a
destinationConfiguration.
String name
Logging-configuration name. The value does not need to be unique.
Map<K,V> tags
Tags to attach to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details,
including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no
constraints on tags beyond what is documented there.
String arn
Logging-configuration ARN, assigned by the system.
Date createTime
Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string.
DestinationConfiguration destinationConfiguration
A complex type that contains a destination configuration for where chat content will be logged, from the request.
There is only one type of destination (cloudWatchLogs, firehose, or s3) in
a destinationConfiguration.
String id
Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the logging configuration.
String name
Logging-configuration name, from the request (if specified).
String state
The state of the logging configuration. When the state is ACTIVE, the configuration is ready to log
chat content.
Map<K,V> tags
Tags attached to the resource, from the request (if specified). Array of maps, each of the form
string:string (key:value).
Date updateTime
Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
List<E> loggingConfigurationIdentifiers
Array of logging-configuration identifiers attached to the room.
Integer maximumMessageLength
Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.
Integer maximumMessageRatePerSecond
Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.
MessageReviewHandler messageReviewHandler
Configuration information for optional review of messages.
String name
Room name. The value does not need to be unique.
Map<K,V> tags
Tags to attach to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details,
including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no
constraints beyond what is documented there.
String arn
Room ARN, assigned by the system.
Date createTime
Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.
String id
Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
List<E> loggingConfigurationIdentifiers
Array of logging configurations attached to the room, from the request (if specified).
Integer maximumMessageLength
Maximum number of characters in a single message, from the request (if specified).
Integer maximumMessageRatePerSecond
Maximum number of messages per second that can be sent to the room (by all clients), from the request (if specified).
MessageReviewHandler messageReviewHandler
Configuration information for optional review of messages.
String name
Room name, from the request (if specified).
Map<K,V> tags
Tags attached to the resource, from the request (if specified).
Date updateTime
Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
String identifier
Identifier of the logging configuration to be deleted.
String id
ID of the message to be deleted. This is the Id field in the received message (see Message
(Subscribe) in the Chat Messaging API).
String reason
Reason for deleting the message.
String roomIdentifier
Identifier of the room where the message should be deleted. Currently this must be an ARN.
String id
Operation identifier, generated by Amazon IVS Chat.
String identifier
Identifier of the room to be deleted. Currently this must be an ARN.
CloudWatchLogsDestinationConfiguration cloudWatchLogs
An Amazon CloudWatch Logs destination configuration where chat activity will be logged.
FirehoseDestinationConfiguration firehose
An Amazon Kinesis Data Firehose destination configuration where chat activity will be logged.
S3DestinationConfiguration s3
An Amazon S3 destination configuration where chat activity will be logged.
String deliveryStreamName
Name of the Amazon Kinesis Firehose delivery stream where chat activity will be logged.
String identifier
Identifier of the logging configuration to be retrieved.
String arn
Logging-configuration ARN, from the request (if identifier was an ARN).
Date createTime
Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string.
DestinationConfiguration destinationConfiguration
A complex type that contains a destination configuration for where chat content will be logged. There is only one
type of destination (cloudWatchLogs, firehose, or s3) in a
destinationConfiguration.
String id
Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the logging configuration.
String name
Logging-configuration name. This value does not need to be unique.
String state
The state of the logging configuration. When the state is ACTIVE, the configuration is ready to log
chat content.
Map<K,V> tags
Tags attached to the resource. Array of maps, each of the form string:string (key:value).
Date updateTime
Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
String identifier
Identifier of the room for which the configuration is to be retrieved. Currently this must be an ARN.
String arn
Room ARN, from the request (if identifier was an ARN).
Date createTime
Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.
String id
Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
List<E> loggingConfigurationIdentifiers
Array of logging configurations attached to the room.
Integer maximumMessageLength
Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.
Integer maximumMessageRatePerSecond
Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.
MessageReviewHandler messageReviewHandler
Configuration information for optional review of messages.
String name
Room name. The value does not need to be unique.
Map<K,V> tags
Tags attached to the resource. Array of maps, each of the form string:string (key:value).
Date updateTime
Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
List<E> loggingConfigurations
List of the matching logging configurations (summary information only). There is only one type of destination (
cloudWatchLogs, firehose, or s3) in a
destinationConfiguration.
String nextToken
If there are more logging configurations than maxResults, use nextToken in the request
to get the next set.
String loggingConfigurationIdentifier
Logging-configuration identifier.
Integer maxResults
Maximum number of rooms to return. Default: 50.
String messageReviewHandlerUri
Filters the list to match the specified message review handler URI.
String name
Filters the list to match the specified room name.
String nextToken
The first room to retrieve. This is used for pagination; see the nextToken response field.
String resourceArn
The ARN of the resource to be retrieved. The ARN must be URL-encoded.
String arn
Logging-configuration ARN.
Date createTime
Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string.
DestinationConfiguration destinationConfiguration
A complex type that contains a destination configuration for where chat content will be logged.
String id
Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
String name
Logging-configuration name. The value does not need to be unique.
String state
The state of the logging configuration. When this is ACTIVE, the configuration is ready for logging
chat content.
Map<K,V> tags
Tags to attach to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details,
including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no
constraints on tags beyond what is documented there.
Date updateTime
Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
String fallbackResult
Specifies the fallback behavior (whether the message is allowed or denied) if the handler does not return a valid
response, encounters an error, or times out. (For the timeout period, see Service Quotas.) If allowed, the
message is delivered with returned content to all users connected to the room. If denied, the message is not
delivered to any user. Default: ALLOW.
String uri
Identifier of the message review handler. Currently this must be an ARN of a lambda function.
String arn
Room ARN.
Date createTime
Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.
String id
Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
List<E> loggingConfigurationIdentifiers
List of logging-configuration identifiers attached to the room.
MessageReviewHandler messageReviewHandler
Configuration information for optional review of messages.
String name
Room name. The value does not need to be unique.
Map<K,V> tags
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details,
including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no
constraints beyond what is documented there.
Date updateTime
Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
String bucketName
Name of the Amazon S3 bucket where chat activity will be logged.
Map<K,V> attributes
Application-defined metadata to attach to the event sent to clients. The maximum length of the metadata is 1 KB total.
String eventName
Application-defined name of the event to send to clients.
String roomIdentifier
Identifier of the room to which the event will be sent. Currently this must be an ARN.
String id
An identifier generated by Amazon IVS Chat. This identifier must be used in subsequent operations for this message, such as DeleteMessage.
String resourceArn
The ARN of the resource to be tagged. The ARN must be URL-encoded.
Map<K,V> tags
Array of tags to be added or updated. Array of maps, each of the form string:string (key:value). See
Tagging AWS Resources for details,
including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no
constraints beyond what is documented there.
String resourceArn
The ARN of the resource to be untagged. The ARN must be URL-encoded.
List<E> tagKeys
Array of tags to be removed. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details,
including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no
constraints beyond what is documented there.
DestinationConfiguration destinationConfiguration
A complex type that contains a destination configuration for where chat content will be logged. There can be only
one type of destination (cloudWatchLogs, firehose, or s3) in a
destinationConfiguration.
String identifier
Identifier of the logging configuration to be updated.
String name
Logging-configuration name. The value does not need to be unique.
String arn
Logging-configuration ARN, from the request (if identifier was an ARN).
Date createTime
Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string.
DestinationConfiguration destinationConfiguration
A complex type that contains a destination configuration for where chat content will be logged, from the request.
There is only one type of destination (cloudWatchLogs, firehose, or s3) in
a destinationConfiguration.
String id
Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
String name
Logging-configuration name, from the request (if specified).
String state
The state of the logging configuration. When the state is ACTIVE, the configuration is ready to log
chat content.
Map<K,V> tags
Tags attached to the resource. Array of maps, each of the form string:string (key:value).
Date updateTime
Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
String identifier
Identifier of the room to be updated. Currently this must be an ARN.
List<E> loggingConfigurationIdentifiers
Array of logging-configuration identifiers attached to the room.
Integer maximumMessageLength
The maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.
Integer maximumMessageRatePerSecond
Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.
MessageReviewHandler messageReviewHandler
Configuration information for optional review of messages. Specify an empty uri string to
disassociate a message review handler from the specified room.
String name
Room name. The value does not need to be unique.
String arn
Room ARN, from the request (if identifier was an ARN).
Date createTime
Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.
String id
Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
List<E> loggingConfigurationIdentifiers
Array of logging configurations attached to the room, from the request (if specified).
Integer maximumMessageLength
Maximum number of characters in a single message, from the request (if specified).
Integer maximumMessageRatePerSecond
Maximum number of messages per second that can be sent to the room (by all clients), from the request (if specified).
MessageReviewHandler messageReviewHandler
Configuration information for optional review of messages.
String name
Room name, from the request (if specified).
Map<K,V> tags
Tags attached to the resource. Array of maps, each of the form string:string (key:value).
Date updateTime
Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
Copyright © 2024. All rights reserved.