[ aws . chime ]



Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


--account-id <value>
--room-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]


--account-id (string)

The Amazon Chime account ID.

--room-id (string)

The room ID.

--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.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.


To get the details about a chat room

The following get-room example displays details about the specified chat room.

aws chime get-room \
    --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \
    --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j


    "Room": {
        "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j",
        "Name": "chatRoom",
        "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45",
        "CreatedBy": "arn:aws:iam::111122223333:user/alejandro",
        "CreatedTimestamp": "2019-12-02T22:29:31.549Z",
        "UpdatedTimestamp": "2019-12-02T22:29:31.549Z"

For more information, see Creating a Chat Room in the Amazon Chime User Guide.


Room -> (structure)

The room details.

RoomId -> (string)

The room ID.

Name -> (string)

The room name.

AccountId -> (string)

The Amazon Chime account ID.

CreatedBy -> (string)

The identifier of the room creator.

CreatedTimestamp -> (timestamp)

The room creation timestamp, in ISO 8601 format.

UpdatedTimestamp -> (timestamp)

The room update timestamp, in ISO 8601 format.