aws ivschat update-room

Updates a room’s configuration. AWS CLI reference

1 example 6 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To update a room's configuration

The following update-room example updates the specified room's configuration with the given data.

aws ivschat update-room --identifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" --logging-configuration-identifiers "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ" --name "chat-room-a" --maximum-message-length 256 --maximum-message-rate-per-second 5

Identify

--identifierIdentifier of the room to be updated.

--logging-configuration-identifiersArray of logging-configuration identifiers attached to the room.

--nameRoom name.

--maximum-message-lengthThe maximum number of characters in a single message.

--maximum-message-rate-per-secondMaximum number of messages per second that can be sent to the room (by all clients).

Its output

{
    "arn": "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6",
    "createTime": "2022-03-16T04:44:09+00:00",
    "id": "g1H2I3j4k5L6",
    "loggingConfigurationIdentifiers": ["arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ"],
    "maximumMessageLength": 256,
    "maximumMessageRatePerSecond": 5,
    "name": "chat-room-a",
    "tags": {},
    "updateTime": "2022-03-16T07:22:09+00:00"
}

For more information, see Getting Started with Amazon IVS Chat in the Amazon Interactive Video Service User Guide.

Options

6 in the AWS CLI reference

--identifierIdentifier of the room to be updated.

--logging-configuration-identifiersArray of logging-configuration identifiers attached to the room.

--maximum-message-lengthThe maximum number of characters in a single message.

--maximum-message-rate-per-secondMaximum number of messages per second that can be sent to the room (by all clients).

--message-review-handlerConfiguration information for optional review of messages.

--nameRoom name.