Amazon Interactive Video Service Chat 2020-07-14
- Client: Aws\ivschat\ivschatClient
- Service ID: ivschat
- Version: 2020-07-14
This page describes the parameters and results for the operations of the Amazon Interactive Video Service Chat (2020-07-14), and shows how to use the Aws\ivschat\ivschatClient object to call the described operations. This documentation is specific to the 2020-07-14 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- CreateChatToken ( array $params = [] )
Creates an encrypted token that is used by a chat participant to establish an individual WebSocket chat connection to a room.
- CreateLoggingConfiguration ( array $params = [] )
Creates a logging configuration that allows clients to store and record sent messages.
- CreateRoom ( array $params = [] )
Creates a room that allows clients to connect and pass messages.
- DeleteLoggingConfiguration ( array $params = [] )
Deletes the specified logging configuration.
- DeleteMessage ( array $params = [] )
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.
- DeleteRoom ( array $params = [] )
Deletes the specified room.
- DisconnectUser ( array $params = [] )
Disconnects all connections using a specified user ID from a room.
- GetLoggingConfiguration ( array $params = [] )
Gets the specified logging configuration.
- GetRoom ( array $params = [] )
Gets the specified room.
- ListLoggingConfigurations ( array $params = [] )
Gets summary information about all your logging configurations in the AWS region where the API request is processed.
- ListRooms ( array $params = [] )
Gets summary information about all your rooms in the AWS region where the API request is processed.
- ListTagsForResource ( array $params = [] )
Gets information about AWS tags for the specified ARN.
- SendEvent ( array $params = [] )
Sends an event to a room.
- TagResource ( array $params = [] )
Adds or updates tags for the AWS resource with the specified ARN.
- UntagResource ( array $params = [] )
Removes tags from the resource with the specified ARN.
- UpdateLoggingConfiguration ( array $params = [] )
Updates a specified logging configuration.
- UpdateRoom ( array $params = [] )
Updates a room’s configuration.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
CreateChatToken
$result = $client->createChatToken([/* ... */]); $promise = $client->createChatTokenAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->createChatToken([
'attributes' => ['<string>', ...],
'capabilities' => ['<string>', ...],
'roomIdentifier' => '<string>', // REQUIRED
'sessionDurationInMinutes' => <integer>,
'userId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- attributes
-
- Type: Associative array of custom strings keys (String) to strings
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.
- capabilities
-
- Type: Array of strings
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).
- roomIdentifier
-
- Required: Yes
- Type: string
Identifier of the room that the client is trying to access. Currently this must be an ARN.
- sessionDurationInMinutes
-
- Type: int
Session duration (in minutes), after which the session expires. Default: 60 (1 hour).
- userId
-
- Required: Yes
- Type: string
Application-provided ID that uniquely identifies the user associated with this token. This can be any UTF-8 encoded text.
Result Syntax
[
'sessionExpirationTime' => <DateTime>,
'token' => '<string>',
'tokenExpirationTime' => <DateTime>,
]
Result Details
Members
- sessionExpirationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
- token
-
- Type: string
The issued client token, encrypted.
- tokenExpirationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
Errors
CreateLoggingConfiguration
$result = $client->createLoggingConfiguration([/* ... */]); $promise = $client->createLoggingConfigurationAsync([/* ... */]);
Creates a logging configuration that allows clients to store and record sent messages.
Parameter Syntax
$result = $client->createLoggingConfiguration([
'destinationConfiguration' => [ // REQUIRED
'cloudWatchLogs' => [
'logGroupName' => '<string>', // REQUIRED
],
'firehose' => [
'deliveryStreamName' => '<string>', // REQUIRED
],
's3' => [
'bucketName' => '<string>', // REQUIRED
],
],
'name' => '<string>',
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- destinationConfiguration
-
- Required: Yes
- Type: DestinationConfiguration structure
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, ors3) in adestinationConfiguration. - name
-
- Type: string
Logging-configuration name. The value does not need to be unique.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
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.
Result Syntax
[
'arn' => '<string>',
'createTime' => <DateTime>,
'destinationConfiguration' => [
'cloudWatchLogs' => [
'logGroupName' => '<string>',
],
'firehose' => [
'deliveryStreamName' => '<string>',
],
's3' => [
'bucketName' => '<string>',
],
],
'id' => '<string>',
'name' => '<string>',
'state' => 'ACTIVE',
'tags' => ['<string>', ...],
'updateTime' => <DateTime>,
]
Result Details
Members
- arn
-
- Type: string
Logging-configuration ARN, assigned by the system.
- createTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string.
- destinationConfiguration
-
- Type: DestinationConfiguration structure
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, ors3) in adestinationConfiguration. - id
-
- Type: 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
-
- Type: string
Logging-configuration name, from the request (if specified).
- state
-
- Type: string
The state of the logging configuration. When the state is
ACTIVE, the configuration is ready to log chat content. - tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Tags attached to the resource, from the request (if specified). Array of maps, each of the form
string:string (key:value). - updateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
Errors
CreateRoom
$result = $client->createRoom([/* ... */]); $promise = $client->createRoomAsync([/* ... */]);
Creates a room that allows clients to connect and pass messages.
Parameter Syntax
$result = $client->createRoom([
'loggingConfigurationIdentifiers' => ['<string>', ...],
'maximumMessageLength' => <integer>,
'maximumMessageRatePerSecond' => <integer>,
'messageReviewHandler' => [
'fallbackResult' => 'ALLOW|DENY',
'uri' => '<string>',
],
'name' => '<string>',
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- loggingConfigurationIdentifiers
-
- Type: Array of strings
Array of logging-configuration identifiers attached to the room.
- maximumMessageLength
-
- Type: int
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
-
- Type: int
Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.
- messageReviewHandler
-
- Type: MessageReviewHandler structure
Configuration information for optional review of messages.
- name
-
- Type: string
Room name. The value does not need to be unique.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
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.
Result Syntax
[
'arn' => '<string>',
'createTime' => <DateTime>,
'id' => '<string>',
'loggingConfigurationIdentifiers' => ['<string>', ...],
'maximumMessageLength' => <integer>,
'maximumMessageRatePerSecond' => <integer>,
'messageReviewHandler' => [
'fallbackResult' => 'ALLOW|DENY',
'uri' => '<string>',
],
'name' => '<string>',
'tags' => ['<string>', ...],
'updateTime' => <DateTime>,
]
Result Details
Members
- arn
-
- Type: string
Room ARN, assigned by the system.
- createTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.
- id
-
- Type: string
Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
- loggingConfigurationIdentifiers
-
- Type: Array of strings
Array of logging configurations attached to the room, from the request (if specified).
- maximumMessageLength
-
- Type: int
Maximum number of characters in a single message, from the request (if specified).
- maximumMessageRatePerSecond
-
- Type: int
Maximum number of messages per second that can be sent to the room (by all clients), from the request (if specified).
- messageReviewHandler
-
- Type: MessageReviewHandler structure
Configuration information for optional review of messages.
- name
-
- Type: string
Room name, from the request (if specified).
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Tags attached to the resource, from the request (if specified).
- updateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
Errors
DeleteLoggingConfiguration
$result = $client->deleteLoggingConfiguration([/* ... */]); $promise = $client->deleteLoggingConfigurationAsync([/* ... */]);
Deletes the specified logging configuration.
Parameter Syntax
$result = $client->deleteLoggingConfiguration([
'identifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
DeleteMessage
$result = $client->deleteMessage([/* ... */]); $promise = $client->deleteMessageAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteMessage([
'id' => '<string>', // REQUIRED
'reason' => '<string>',
'roomIdentifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- id
-
- Required: Yes
- Type: string
ID of the message to be deleted. This is the
Idfield in the received message (see Message (Subscribe) in the Chat Messaging API). - reason
-
- Type: string
Reason for deleting the message.
- roomIdentifier
-
- Required: Yes
- Type: string
Identifier of the room where the message should be deleted. Currently this must be an ARN.
Result Syntax
[
'id' => '<string>',
]
Result Details
Errors
DeleteRoom
$result = $client->deleteRoom([/* ... */]); $promise = $client->deleteRoomAsync([/* ... */]);
Deletes the specified room.
Parameter Syntax
$result = $client->deleteRoom([
'identifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
DisconnectUser
$result = $client->disconnectUser([/* ... */]); $promise = $client->disconnectUserAsync([/* ... */]);
Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.
Parameter Syntax
$result = $client->disconnectUser([
'reason' => '<string>',
'roomIdentifier' => '<string>', // REQUIRED
'userId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
GetLoggingConfiguration
$result = $client->getLoggingConfiguration([/* ... */]); $promise = $client->getLoggingConfigurationAsync([/* ... */]);
Gets the specified logging configuration.
Parameter Syntax
$result = $client->getLoggingConfiguration([
'identifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'arn' => '<string>',
'createTime' => <DateTime>,
'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>', ...],
'updateTime' => <DateTime>,
]
Result Details
Members
- arn
-
- Type: string
Logging-configuration ARN, from the request (if
identifierwas an ARN). - createTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string.
- destinationConfiguration
-
- Type: DestinationConfiguration structure
A complex type that contains a destination configuration for where chat content will be logged. There is only one type of destination (
cloudWatchLogs,firehose, ors3) in adestinationConfiguration. - id
-
- Type: 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
-
- Type: string
Logging-configuration name. This value does not need to be unique.
- state
-
- Type: string
The state of the logging configuration. When the state is
ACTIVE, the configuration is ready to log chat content. - tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Tags attached to the resource. Array of maps, each of the form
string:string (key:value). - updateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
Errors
GetRoom
$result = $client->getRoom([/* ... */]); $promise = $client->getRoomAsync([/* ... */]);
Gets the specified room.
Parameter Syntax
$result = $client->getRoom([
'identifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'arn' => '<string>',
'createTime' => <DateTime>,
'id' => '<string>',
'loggingConfigurationIdentifiers' => ['<string>', ...],
'maximumMessageLength' => <integer>,
'maximumMessageRatePerSecond' => <integer>,
'messageReviewHandler' => [
'fallbackResult' => 'ALLOW|DENY',
'uri' => '<string>',
],
'name' => '<string>',
'tags' => ['<string>', ...],
'updateTime' => <DateTime>,
]
Result Details
Members
- arn
-
- Type: string
Room ARN, from the request (if
identifierwas an ARN). - createTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.
- id
-
- Type: string
Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
- loggingConfigurationIdentifiers
-
- Type: Array of strings
Array of logging configurations attached to the room.
- maximumMessageLength
-
- Type: int
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
-
- Type: int
Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.
- messageReviewHandler
-
- Type: MessageReviewHandler structure
Configuration information for optional review of messages.
- name
-
- Type: string
Room name. The value does not need to be unique.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Tags attached to the resource. Array of maps, each of the form
string:string (key:value). - updateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
Errors
ListLoggingConfigurations
$result = $client->listLoggingConfigurations([/* ... */]); $promise = $client->listLoggingConfigurationsAsync([/* ... */]);
Gets summary information about all your logging configurations in the AWS region where the API request is processed.
Parameter Syntax
$result = $client->listLoggingConfigurations([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'loggingConfigurations' => [
[
'arn' => '<string>',
'createTime' => <DateTime>,
'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>', ...],
'updateTime' => <DateTime>,
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- loggingConfigurations
-
- Required: Yes
- Type: Array of LoggingConfigurationSummary structures
List of the matching logging configurations (summary information only). There is only one type of destination (
cloudWatchLogs,firehose, ors3) in adestinationConfiguration. - nextToken
-
- Type: string
If there are more logging configurations than
maxResults, usenextTokenin the request to get the next set.
Errors
ListRooms
$result = $client->listRooms([/* ... */]); $promise = $client->listRoomsAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listRooms([
'loggingConfigurationIdentifier' => '<string>',
'maxResults' => <integer>,
'messageReviewHandlerUri' => '<string>',
'name' => '<string>',
'nextToken' => '<string>',
]);
Parameter Details
Members
- loggingConfigurationIdentifier
-
- Type: string
Logging-configuration identifier.
- maxResults
-
- Type: int
Maximum number of rooms to return. Default: 50.
- messageReviewHandlerUri
-
- Type: string
Filters the list to match the specified message review handler URI.
- name
-
- Type: string
Filters the list to match the specified room name.
- nextToken
-
- Type: string
The first room to retrieve. This is used for pagination; see the
nextTokenresponse field.
Result Syntax
[
'nextToken' => '<string>',
'rooms' => [
[
'arn' => '<string>',
'createTime' => <DateTime>,
'id' => '<string>',
'loggingConfigurationIdentifiers' => ['<string>', ...],
'messageReviewHandler' => [
'fallbackResult' => 'ALLOW|DENY',
'uri' => '<string>',
],
'name' => '<string>',
'tags' => ['<string>', ...],
'updateTime' => <DateTime>,
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
If there are more rooms than
maxResults, usenextTokenin the request to get the next set. - rooms
-
- Required: Yes
- Type: Array of RoomSummary structures
List of the matching rooms (summary information only).
Errors
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Gets information about AWS tags for the specified ARN.
Parameter Syntax
$result = $client->listTagsForResource([
'resourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'tags' => ['<string>', ...],
]
Result Details
Members
Errors
SendEvent
$result = $client->sendEvent([/* ... */]); $promise = $client->sendEventAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->sendEvent([
'attributes' => ['<string>', ...],
'eventName' => '<string>', // REQUIRED
'roomIdentifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- attributes
-
- Type: Associative array of custom strings keys (String) to strings
Application-defined metadata to attach to the event sent to clients. The maximum length of the metadata is 1 KB total.
- eventName
-
- Required: Yes
- Type: string
Application-defined name of the event to send to clients.
- roomIdentifier
-
- Required: Yes
- Type: string
Identifier of the room to which the event will be sent. Currently this must be an ARN.
Result Syntax
[
'id' => '<string>',
]
Result Details
Members
Errors
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Adds or updates tags for the AWS resource with the specified ARN.
Parameter Syntax
$result = $client->tagResource([
'resourceArn' => '<string>', // REQUIRED
'tags' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The ARN of the resource to be tagged. The ARN must be URL-encoded.
- tags
-
- Required: Yes
- Type: Associative array of custom strings keys (TagKey) to strings
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.
Result Syntax
[]
Result Details
Errors
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes tags from the resource with the specified ARN.
Parameter Syntax
$result = $client->untagResource([
'resourceArn' => '<string>', // REQUIRED
'tagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The ARN of the resource to be untagged. The ARN must be URL-encoded.
- tagKeys
-
- Required: Yes
- Type: Array of strings
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.
Result Syntax
[]
Result Details
Errors
UpdateLoggingConfiguration
$result = $client->updateLoggingConfiguration([/* ... */]); $promise = $client->updateLoggingConfigurationAsync([/* ... */]);
Updates a specified logging configuration.
Parameter Syntax
$result = $client->updateLoggingConfiguration([
'destinationConfiguration' => [
'cloudWatchLogs' => [
'logGroupName' => '<string>', // REQUIRED
],
'firehose' => [
'deliveryStreamName' => '<string>', // REQUIRED
],
's3' => [
'bucketName' => '<string>', // REQUIRED
],
],
'identifier' => '<string>', // REQUIRED
'name' => '<string>',
]);
Parameter Details
Members
- destinationConfiguration
-
- Type: DestinationConfiguration structure
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, ors3) in adestinationConfiguration. - identifier
-
- Required: Yes
- Type: string
Identifier of the logging configuration to be updated.
- name
-
- Type: string
Logging-configuration name. The value does not need to be unique.
Result Syntax
[
'arn' => '<string>',
'createTime' => <DateTime>,
'destinationConfiguration' => [
'cloudWatchLogs' => [
'logGroupName' => '<string>',
],
'firehose' => [
'deliveryStreamName' => '<string>',
],
's3' => [
'bucketName' => '<string>',
],
],
'id' => '<string>',
'name' => '<string>',
'state' => 'ACTIVE',
'tags' => ['<string>', ...],
'updateTime' => <DateTime>,
]
Result Details
Members
- arn
-
- Type: string
Logging-configuration ARN, from the request (if
identifierwas an ARN). - createTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string.
- destinationConfiguration
-
- Type: DestinationConfiguration structure
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, ors3) in adestinationConfiguration. - id
-
- Type: string
Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
- name
-
- Type: string
Logging-configuration name, from the request (if specified).
- state
-
- Type: string
The state of the logging configuration. When the state is
ACTIVE, the configuration is ready to log chat content. - tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Tags attached to the resource. Array of maps, each of the form
string:string (key:value). - updateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
Errors
UpdateRoom
$result = $client->updateRoom([/* ... */]); $promise = $client->updateRoomAsync([/* ... */]);
Updates a room’s configuration.
Parameter Syntax
$result = $client->updateRoom([
'identifier' => '<string>', // REQUIRED
'loggingConfigurationIdentifiers' => ['<string>', ...],
'maximumMessageLength' => <integer>,
'maximumMessageRatePerSecond' => <integer>,
'messageReviewHandler' => [
'fallbackResult' => 'ALLOW|DENY',
'uri' => '<string>',
],
'name' => '<string>',
]);
Parameter Details
Members
- identifier
-
- Required: Yes
- Type: string
Identifier of the room to be updated. Currently this must be an ARN.
- loggingConfigurationIdentifiers
-
- Type: Array of strings
Array of logging-configuration identifiers attached to the room.
- maximumMessageLength
-
- Type: int
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.
- maximumMessageRatePerSecond
-
- Type: int
Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.
- messageReviewHandler
-
- Type: MessageReviewHandler structure
Configuration information for optional review of messages. Specify an empty
uristring to disassociate a message review handler from the specified room. - name
-
- Type: string
Room name. The value does not need to be unique.
Result Syntax
[
'arn' => '<string>',
'createTime' => <DateTime>,
'id' => '<string>',
'loggingConfigurationIdentifiers' => ['<string>', ...],
'maximumMessageLength' => <integer>,
'maximumMessageRatePerSecond' => <integer>,
'messageReviewHandler' => [
'fallbackResult' => 'ALLOW|DENY',
'uri' => '<string>',
],
'name' => '<string>',
'tags' => ['<string>', ...],
'updateTime' => <DateTime>,
]
Result Details
Members
- arn
-
- Type: string
Room ARN, from the request (if
identifierwas an ARN). - createTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.
- id
-
- Type: string
Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
- loggingConfigurationIdentifiers
-
- Type: Array of strings
Array of logging configurations attached to the room, from the request (if specified).
- maximumMessageLength
-
- Type: int
Maximum number of characters in a single message, from the request (if specified).
- maximumMessageRatePerSecond
-
- Type: int
Maximum number of messages per second that can be sent to the room (by all clients), from the request (if specified).
- messageReviewHandler
-
- Type: MessageReviewHandler structure
Configuration information for optional review of messages.
- name
-
- Type: string
Room name, from the request (if specified).
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Tags attached to the resource. Array of maps, each of the form
string:string (key:value). - updateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
Errors
Shapes
AccessDeniedException
CloudWatchLogsDestinationConfiguration
Description
Specifies a CloudWatch Logs location where chat logs will be stored.
Members
ConflictException
Description
Members
DestinationConfiguration
Description
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).
Members
- cloudWatchLogs
-
- Type: CloudWatchLogsDestinationConfiguration structure
An Amazon CloudWatch Logs destination configuration where chat activity will be logged.
- firehose
-
- Type: FirehoseDestinationConfiguration structure
An Amazon Kinesis Data Firehose destination configuration where chat activity will be logged.
- s3
-
- Type: S3DestinationConfiguration structure
An Amazon S3 destination configuration where chat activity will be logged.
FirehoseDestinationConfiguration
Description
Specifies a Kinesis Firehose location where chat logs will be stored.
Members
InternalServerException
LoggingConfigurationSummary
Description
Summary information about a logging configuration.
Members
- arn
-
- Type: string
Logging-configuration ARN.
- createTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string.
- destinationConfiguration
-
- Type: DestinationConfiguration structure
A complex type that contains a destination configuration for where chat content will be logged.
- id
-
- Type: string
Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
- name
-
- Type: string
Logging-configuration name. The value does not need to be unique.
- state
-
- Type: string
The state of the logging configuration. When this is
ACTIVE, the configuration is ready for logging chat content. - tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
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. - updateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
MessageReviewHandler
Description
Configuration information for optional message review.
Members
- fallbackResult
-
- Type: 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
-
- Type: string
Identifier of the message review handler. Currently this must be an ARN of a lambda function.
PendingVerification
ResourceNotFoundException
Description
Members
RoomSummary
Description
Summary information about a room.
Members
- arn
-
- Type: string
Room ARN.
- createTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.
- id
-
- Type: string
Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
- loggingConfigurationIdentifiers
-
- Type: Array of strings
List of logging-configuration identifiers attached to the room.
- messageReviewHandler
-
- Type: MessageReviewHandler structure
Configuration information for optional review of messages.
- name
-
- Type: string
Room name. The value does not need to be unique.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
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. - updateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
S3DestinationConfiguration
Description
Specifies an S3 location where chat logs will be stored.
Members
ServiceQuotaExceededException
Description
Members
ThrottlingException
Description
Members
ValidationException
Description
Members
- fieldList
-
- Type: Array of ValidationExceptionField structures
- message
-
- Required: Yes
- Type: string
- reason
-
- Required: Yes
- Type: string