list-room-memberships¶

Description¶

Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members’ IDs, email addresses, and names.

Synopsis¶

  list-room-memberships
--account-id <value>
--room-id <value>
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--account-id (string)

The Amazon Chime account ID.

--room-id (string)

The room ID.

--max-results (integer)

The maximum number of results to return in a single call.

--next-token (string)

The token to use to retrieve the next page of results.

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

See ‘aws help’ for descriptions of global 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 list room memberships

The following list-room-memberships example displays a list of the membership details for the specified chat room.

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

Output:

{
    "RoomMemberships": [
        {
            "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j",
            "Member": {
                "MemberId": "2ab2345c-67de-8901-f23g-45h678901j2k",
                "MemberType": "User",
                "Email": "zhangw@example.com",
                "FullName": "Zhang Wei",
                "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45"
            },
            "Role": "Member",
            "InvitedBy": "arn:aws:iam::111122223333:user/alejandro",
            "UpdatedTimestamp": "2019-12-02T22:46:58.532Z"
        },
        {
            "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j",
            "Member": {
                "MemberId": "1ab2345c-67de-8901-f23g-45h678901j2k",
                "MemberType": "User",
                "Email": "janed@example.com",
                "FullName": "Jane Doe",
                "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45"
            },
            "Role": "Administrator",
            "InvitedBy": "arn:aws:iam::111122223333:user/alejandro",
            "UpdatedTimestamp": "2019-12-02T22:46:58.532Z"
        }
    ]
}

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

Output¶

RoomMemberships -> (list)

The room membership details.

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

NextToken -> (string)

The token to use to retrieve the next page of results.

Table of Contents

Feedback

User Guide