update-room-membership¶

Description¶

Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account. The member role designates whether the member is a chat room administrator or a general chat room member. The member role can be updated only for user IDs.

Synopsis¶

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

Options¶

--account-id (string)

The Amazon Chime account ID.

--room-id (string)

The room ID.

--member-id (string)

The member ID.

--role (string)

The role of the member.

Possible values:

Administrator

Member

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

Examples¶

To update a room membership

The following update-room-membership example modifies the role of the specified chat room member to Administrator.

aws chime update-room-membership \
    --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \
    --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j \
    --member-id 1ab2345c-67de-8901-f23g-45h678901j2k \
    --role Administrator

Output:

{
    "RoomMembership": {
        "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j",
        "Member": {
            "MemberId": "1ab2345c-67de-8901-f23g-45h678901j2k",
            "MemberType": "User",
            "Email": "sofiamartinez@example.com",
            "FullName": "Sofia Martinez",
            "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45"
        },
        "Role": "Administrator",
        "InvitedBy": "arn:aws:iam::111122223333:user/admin",
        "UpdatedTimestamp": "2019-12-02T22:40:22.931Z"
    }
}

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

Output¶

RoomMembership -> (structure)

The room membership details.

RoomId -> (string)

The room ID.

Member -> (structure)

The member details, such as email address, name, member ID, and member type.

MemberId -> (string)

The member ID (user ID or bot ID).

MemberType -> (string)

The member type.

Email -> (string)

The member email address.

FullName -> (string)

The member name.

AccountId -> (string)

The Amazon Chime account ID.

Role -> (string)

The membership role.

InvitedBy -> (string)

The identifier of the user that invited the room member.

UpdatedTimestamp -> (timestamp)

The room membership update timestamp, in ISO 8601 format.

Table of Contents

Feedback

User Guide