AWS CLI Command Reference

[ aws . ivschat ]

update-room

Description

Updates a room’s configuration.

See also: AWS API Documentation

Synopsis

  update-room
--identifier <value>
[--logging-configuration-identifiers <value>]
[--maximum-message-length <value>]
[--maximum-message-rate-per-second <value>]
[--message-review-handler <value>]
[--name <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--identifier (string)

Identifier of the room to be updated. Currently this must be an ARN.

--logging-configuration-identifiers (list)

Array of logging-configuration identifiers attached to the room.

(string)

Syntax:

"string" "string" ...

--maximum-message-length (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.

--maximum-message-rate-per-second (integer)

Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.

--message-review-handler (structure)

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.

Shorthand Syntax:

fallbackResult=string,uri=string

JSON Syntax:

{
  "fallbackResult": "ALLOW"|"DENY",
  "uri": "string"
}

--name (string)

Room name. The value does not need to be unique.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json

  • text

  • table

  • yaml

  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on

  • off

  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64

  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

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" \
    --name "chat-room-a" \
    --maximumMessageLength 256 \
    --maximumMessageRatePerSecond 5

Output:

{
    "arn": "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6",
    "createTime": "2022-03-16T04:44:09+00:00",
    "id": "12345689012",
    "maximumMessageLength": 256,
    "maximumMessageRatePerSecond": 5,
    "name": "test-room-1",
    "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.

Output

arn -> (string)

Room ARN, from the request (if identifier was an ARN).

createTime -> (timestamp)

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 -> (structure)

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 -> (map)

Tags attached to the resource. Array of maps, each of the form string:string (key:value) .

key -> (string)

value -> (string)

updateTime -> (timestamp)

Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string .

© Copyright 2018, Amazon Web Services. Created using Sphinx.