2022/11/17 - Amazon Interactive Video Service Chat - 5 new 4 updated api methods
Changes Adds LoggingConfiguration APIs for IVS Chat - a feature that allows customers to store and record sent messages in a chat room to S3 buckets, CloudWatch logs, or Kinesis firehose.
Gets the specified logging configuration.
See also: AWS API Documentation
Request Syntax
client.get_logging_configuration(
identifier='string'
)
string
[REQUIRED]
Identifier of the logging configuration to be retrieved.
dict
Response Syntax
{
'arn': 'string',
'createTime': datetime(2015, 1, 1),
'destinationConfiguration': {
'cloudWatchLogs': {
'logGroupName': 'string'
},
'firehose': {
'deliveryStreamName': 'string'
},
's3': {
'bucketName': 'string'
}
},
'id': 'string',
'name': 'string',
'state': 'CREATING'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'ACTIVE',
'tags': {
'string': 'string'
},
'updateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
arn (string) --
Logging-configuration ARN, from the request (if identifier was an ARN).
createTime (datetime) --
Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string .
destinationConfiguration (dict) --
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 .
cloudWatchLogs (dict) --
Name of the Amazon CloudWatch Logs destination where chat activity will be logged.
logGroupName (string) --
Name of the Amazon Cloudwatch Logs destination where chat activity will be logged.
firehose (dict) --
Name of the Amazon Kinesis Data Firehose destination where chat activity will be logged
deliveryStreamName (string) --
Name of the Amazon Kinesis Firehose delivery stream where chat activity will be logged.
s3 (dict) --
Name of the Amazon S3 bucket where chat activity will be logged.
bucketName (string) --
Name of the Amazon S3 bucket where chat activity will be logged.
id (string) --
Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the logging configuration.
name (string) --
Logging-configuration name. This value does not need to be unique.
state (string) --
The state of the logging configuration. When the state is ACTIVE , the configuration is ready to log chat content.
tags (dict) --
Tags attached to the resource. Array of maps, each of the form string:string (key:value) .
(string) --
(string) --
updateTime (datetime) --
Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as a string .
Creates a logging configuration that allows clients to store and record sent messages.
See also: AWS API Documentation
Request Syntax
client.create_logging_configuration(
destinationConfiguration={
'cloudWatchLogs': {
'logGroupName': 'string'
},
'firehose': {
'deliveryStreamName': 'string'
},
's3': {
'bucketName': 'string'
}
},
name='string',
tags={
'string': 'string'
}
)
dict
[REQUIRED]
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 .
cloudWatchLogs (dict) --
Name of the Amazon CloudWatch Logs destination where chat activity will be logged.
logGroupName (string) -- [REQUIRED]
Name of the Amazon Cloudwatch Logs destination where chat activity will be logged.
firehose (dict) --
Name of the Amazon Kinesis Data Firehose destination where chat activity will be logged
deliveryStreamName (string) -- [REQUIRED]
Name of the Amazon Kinesis Firehose delivery stream where chat activity will be logged.
s3 (dict) --
Name of the Amazon S3 bucket where chat activity will be logged.
bucketName (string) -- [REQUIRED]
Name of the Amazon S3 bucket where chat activity will be logged.
string
Logging-configuration name. The value does not need to be unique.
dict
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) --
(string) --
dict
Response Syntax
{
'arn': 'string',
'createTime': datetime(2015, 1, 1),
'destinationConfiguration': {
'cloudWatchLogs': {
'logGroupName': 'string'
},
'firehose': {
'deliveryStreamName': 'string'
},
's3': {
'bucketName': 'string'
}
},
'id': 'string',
'name': 'string',
'state': 'ACTIVE',
'tags': {
'string': 'string'
},
'updateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
arn (string) --
Logging-configuration ARN, assigned by the system.
createTime (datetime) --
Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string .
destinationConfiguration (dict) --
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 .
cloudWatchLogs (dict) --
Name of the Amazon CloudWatch Logs destination where chat activity will be logged.
logGroupName (string) --
Name of the Amazon Cloudwatch Logs destination where chat activity will be logged.
firehose (dict) --
Name of the Amazon Kinesis Data Firehose destination where chat activity will be logged
deliveryStreamName (string) --
Name of the Amazon Kinesis Firehose delivery stream where chat activity will be logged.
s3 (dict) --
Name of the Amazon S3 bucket where chat activity will be logged.
bucketName (string) --
Name of the Amazon S3 bucket where chat activity will be logged.
id (string) --
Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the logging configuration.
name (string) --
Logging-configuration name, from the request (if specified).
state (string) --
The state of the logging configuration. When the state is ACTIVE , the configuration is ready to log chat content.
tags (dict) --
Tags attached to the resource, from the request (if specified). Array of maps, each of the form string:string (key:value) .
(string) --
(string) --
updateTime (datetime) --
Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as a string .
Deletes the specified logging configuration.
See also: AWS API Documentation
Request Syntax
client.delete_logging_configuration(
identifier='string'
)
string
[REQUIRED]
Identifier of the logging configuration to be deleted.
None
Updates a specified logging configuration.
See also: AWS API Documentation
Request Syntax
client.update_logging_configuration(
destinationConfiguration={
'cloudWatchLogs': {
'logGroupName': 'string'
},
'firehose': {
'deliveryStreamName': 'string'
},
's3': {
'bucketName': 'string'
}
},
identifier='string',
name='string'
)
dict
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 .
cloudWatchLogs (dict) --
Name of the Amazon CloudWatch Logs destination where chat activity will be logged.
logGroupName (string) -- [REQUIRED]
Name of the Amazon Cloudwatch Logs destination where chat activity will be logged.
firehose (dict) --
Name of the Amazon Kinesis Data Firehose destination where chat activity will be logged
deliveryStreamName (string) -- [REQUIRED]
Name of the Amazon Kinesis Firehose delivery stream where chat activity will be logged.
s3 (dict) --
Name of the Amazon S3 bucket where chat activity will be logged.
bucketName (string) -- [REQUIRED]
Name of the Amazon S3 bucket where chat activity will be logged.
string
[REQUIRED]
Identifier of the logging configuration to be updated.
string
Logging-configuration name. The value does not need to be unique.
dict
Response Syntax
{
'arn': 'string',
'createTime': datetime(2015, 1, 1),
'destinationConfiguration': {
'cloudWatchLogs': {
'logGroupName': 'string'
},
'firehose': {
'deliveryStreamName': 'string'
},
's3': {
'bucketName': 'string'
}
},
'id': 'string',
'name': 'string',
'state': 'ACTIVE',
'tags': {
'string': 'string'
},
'updateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
arn (string) --
Logging-configuration ARN, from the request (if identifier was an ARN).
createTime (datetime) --
Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string .
destinationConfiguration (dict) --
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 .
cloudWatchLogs (dict) --
Name of the Amazon CloudWatch Logs destination where chat activity will be logged.
logGroupName (string) --
Name of the Amazon Cloudwatch Logs destination where chat activity will be logged.
firehose (dict) --
Name of the Amazon Kinesis Data Firehose destination where chat activity will be logged
deliveryStreamName (string) --
Name of the Amazon Kinesis Firehose delivery stream where chat activity will be logged.
s3 (dict) --
Name of the Amazon S3 bucket where chat activity will be logged.
bucketName (string) --
Name of the Amazon S3 bucket where chat activity will be logged.
id (string) --
Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
name (string) --
Logging-configuration name, from the request (if specified).
state (string) --
The state of the logging configuration. When the state is ACTIVE , the configuration is ready to log chat content.
tags (dict) --
Tags attached to the resource. Array of maps, each of the form string:string (key:value) .
(string) --
(string) --
updateTime (datetime) --
Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as a string .
Gets summary information about all your logging configurations in the AWS region where the API request is processed.
See also: AWS API Documentation
Request Syntax
client.list_logging_configurations(
maxResults=123,
nextToken='string'
)
integer
Maximum number of logging configurations to return. Default: 50.
string
The first logging configurations to retrieve. This is used for pagination; see the nextToken response field.
dict
Response Syntax
{
'loggingConfigurations': [
{
'arn': 'string',
'createTime': datetime(2015, 1, 1),
'destinationConfiguration': {
'cloudWatchLogs': {
'logGroupName': 'string'
},
'firehose': {
'deliveryStreamName': 'string'
},
's3': {
'bucketName': 'string'
}
},
'id': 'string',
'name': 'string',
'state': 'CREATING'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'ACTIVE',
'tags': {
'string': 'string'
},
'updateTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
loggingConfigurations (list) --
List of the matching logging configurations (summary information only). There is only one type of destination (cloudWatchLogs , firehose , or s3 ) in a destinationConfiguration .
(dict) --
Summary information about a logging configuration.
arn (string) --
Logging-configuration ARN.
createTime (datetime) --
Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string .
destinationConfiguration (dict) --
A complex type that contains a destination configuration for where chat content will be logged.
cloudWatchLogs (dict) --
Name of the Amazon CloudWatch Logs destination where chat activity will be logged.
logGroupName (string) --
Name of the Amazon Cloudwatch Logs destination where chat activity will be logged.
firehose (dict) --
Name of the Amazon Kinesis Data Firehose destination where chat activity will be logged
deliveryStreamName (string) --
Name of the Amazon Kinesis Firehose delivery stream where chat activity will be logged.
s3 (dict) --
Name of the Amazon S3 bucket where chat activity will be logged.
bucketName (string) --
Name of the Amazon S3 bucket where chat activity will be logged.
id (string) --
Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
name (string) --
Logging-configuration name. The value does not need to be unique.
state (string) --
The state of the logging configuration. When this is ACTIVE , the configuration is ready for logging chat content.
tags (dict) --
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) --
(string) --
updateTime (datetime) --
Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as a string .
nextToken (string) --
If there are more logging configurations than maxResults , use nextToken in the request to get the next set.
{'loggingConfigurationIdentifiers': ['string']}
Creates a room that allows clients to connect and pass messages.
See also: AWS API Documentation
Request Syntax
client.create_room(
loggingConfigurationIdentifiers=[
'string',
],
maximumMessageLength=123,
maximumMessageRatePerSecond=123,
messageReviewHandler={
'fallbackResult': 'ALLOW'|'DENY',
'uri': 'string'
},
name='string',
tags={
'string': 'string'
}
)
list
Array of logging-configuration identifiers attached to the room.
(string) --
integer
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
Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.
dict
Configuration information for optional review of messages.
fallbackResult (string) --
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 .
uri (string) --
Identifier of the message review handler. Currently this must be an ARN of a lambda function.
string
Room name. The value does not need to be unique.
dict
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) --
(string) --
dict
Response Syntax
{
'arn': 'string',
'createTime': datetime(2015, 1, 1),
'id': 'string',
'loggingConfigurationIdentifiers': [
'string',
],
'maximumMessageLength': 123,
'maximumMessageRatePerSecond': 123,
'messageReviewHandler': {
'fallbackResult': 'ALLOW'|'DENY',
'uri': 'string'
},
'name': 'string',
'tags': {
'string': 'string'
},
'updateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
arn (string) --
Room ARN, assigned by the system.
createTime (datetime) --
Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string .
id (string) --
Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
loggingConfigurationIdentifiers (list) --
Array of logging configurations attached to the room, from the request (if specified).
(string) --
maximumMessageLength (integer) --
Maximum number of characters in a single message, from the request (if specified).
maximumMessageRatePerSecond (integer) --
Maximum number of messages per second that can be sent to the room (by all clients), from the request (if specified).
messageReviewHandler (dict) --
Configuration information for optional review of messages.
fallbackResult (string) --
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 .
uri (string) --
Identifier of the message review handler. Currently this must be an ARN of a lambda function.
name (string) --
Room name, from the request (if specified).
tags (dict) --
Tags attached to the resource, from the request (if specified).
(string) --
(string) --
updateTime (datetime) --
Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string .
{'loggingConfigurationIdentifiers': ['string']}
Gets the specified room.
See also: AWS API Documentation
Request Syntax
client.get_room(
identifier='string'
)
string
[REQUIRED]
Identifier of the room for which the configuration is to be retrieved. Currently this must be an ARN.
dict
Response Syntax
{
'arn': 'string',
'createTime': datetime(2015, 1, 1),
'id': 'string',
'loggingConfigurationIdentifiers': [
'string',
],
'maximumMessageLength': 123,
'maximumMessageRatePerSecond': 123,
'messageReviewHandler': {
'fallbackResult': 'ALLOW'|'DENY',
'uri': 'string'
},
'name': 'string',
'tags': {
'string': 'string'
},
'updateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
arn (string) --
Room ARN, from the request (if identifier was an ARN).
createTime (datetime) --
Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string .
id (string) --
Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
loggingConfigurationIdentifiers (list) --
Array of logging configurations attached to the room.
(string) --
maximumMessageLength (integer) --
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.
maximumMessageRatePerSecond (integer) --
Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.
messageReviewHandler (dict) --
Configuration information for optional review of messages.
fallbackResult (string) --
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 .
uri (string) --
Identifier of the message review handler. Currently this must be an ARN of a lambda function.
name (string) --
Room name. The value does not need to be unique.
tags (dict) --
Tags attached to the resource. Array of maps, each of the form string:string (key:value) .
(string) --
(string) --
updateTime (datetime) --
Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string .
{'loggingConfigurationIdentifier': 'string'}
Response {'rooms': {'loggingConfigurationIdentifiers': ['string']}}
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 .
See also: AWS API Documentation
Request Syntax
client.list_rooms(
loggingConfigurationIdentifier='string',
maxResults=123,
messageReviewHandlerUri='string',
name='string',
nextToken='string'
)
string
Logging-configuration identifier.
integer
Maximum number of rooms to return. Default: 50.
string
Filters the list to match the specified message review handler URI.
string
Filters the list to match the specified room name.
string
The first room to retrieve. This is used for pagination; see the nextToken response field.
dict
Response Syntax
{
'nextToken': 'string',
'rooms': [
{
'arn': 'string',
'createTime': datetime(2015, 1, 1),
'id': 'string',
'loggingConfigurationIdentifiers': [
'string',
],
'messageReviewHandler': {
'fallbackResult': 'ALLOW'|'DENY',
'uri': 'string'
},
'name': 'string',
'tags': {
'string': 'string'
},
'updateTime': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
nextToken (string) --
If there are more rooms than maxResults , use nextToken in the request to get the next set.
rooms (list) --
List of the matching rooms (summary information only).
(dict) --
Summary information about a room.
arn (string) --
Room ARN.
createTime (datetime) --
Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string .
id (string) --
Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
loggingConfigurationIdentifiers (list) --
List of logging-configuration identifiers attached to the room.
(string) --
messageReviewHandler (dict) --
Configuration information for optional review of messages.
fallbackResult (string) --
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 .
uri (string) --
Identifier of the message review handler. Currently this must be an ARN of a lambda function.
name (string) --
Room name. The value does not need to be unique.
tags (dict) --
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.
(string) --
(string) --
updateTime (datetime) --
Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string .
{'loggingConfigurationIdentifiers': ['string']}
Updates a room’s configuration.
See also: AWS API Documentation
Request Syntax
client.update_room(
identifier='string',
loggingConfigurationIdentifiers=[
'string',
],
maximumMessageLength=123,
maximumMessageRatePerSecond=123,
messageReviewHandler={
'fallbackResult': 'ALLOW'|'DENY',
'uri': 'string'
},
name='string'
)
string
[REQUIRED]
Identifier of the room to be updated. Currently this must be an ARN.
list
Array of logging-configuration identifiers attached to the room.
(string) --
integer
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
Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.
dict
Configuration information for optional review of messages. Specify an empty uri string to disassociate a message review handler from the specified room.
fallbackResult (string) --
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 .
uri (string) --
Identifier of the message review handler. Currently this must be an ARN of a lambda function.
string
Room name. The value does not need to be unique.
dict
Response Syntax
{
'arn': 'string',
'createTime': datetime(2015, 1, 1),
'id': 'string',
'loggingConfigurationIdentifiers': [
'string',
],
'maximumMessageLength': 123,
'maximumMessageRatePerSecond': 123,
'messageReviewHandler': {
'fallbackResult': 'ALLOW'|'DENY',
'uri': 'string'
},
'name': 'string',
'tags': {
'string': 'string'
},
'updateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
arn (string) --
Room ARN, from the request (if identifier was an ARN).
createTime (datetime) --
Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string .
id (string) --
Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
loggingConfigurationIdentifiers (list) --
Array of logging configurations attached to the room, from the request (if specified).
(string) --
maximumMessageLength (integer) --
Maximum number of characters in a single message, from the request (if specified).
maximumMessageRatePerSecond (integer) --
Maximum number of messages per second that can be sent to the room (by all clients), from the request (if specified).
messageReviewHandler (dict) --
Configuration information for optional review of messages.
fallbackResult (string) --
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 .
uri (string) --
Identifier of the message review handler. Currently this must be an ARN of a lambda function.
name (string) --
Room name, from the request (if specified).
tags (dict) --
Tags attached to the resource. Array of maps, each of the form string:string (key:value) .
(string) --
(string) --
updateTime (datetime) --
Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string .