Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . chime ]

update-room

Description

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

Synopsis

  update-room
--account-id <value>
--room-id <value>
[--name <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--account-id (string)

The Amazon Chime account ID.

--room-id (string)

The room ID.

--name (string)

The room name.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To update a chat room

The following update-room example modifies the name of the specified chat room.

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

Output:

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

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

Output

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.