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 ]

batch-create-room-membership

Description

Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be either users or bots. The member role designates whether the member is a chat room administrator or a general chat room member.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  batch-create-room-membership
--account-id <value>
--room-id <value>
--membership-item-list <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--account-id (string)

The Amazon Chime account ID.

--room-id (string)

The room ID.

--membership-item-list (list)

The list of membership items.

(structure)

Membership details, such as member ID and member role.

MemberId -> (string)

The member ID.

Role -> (string)

The member role.

Shorthand Syntax:

MemberId=string,Role=string ...

JSON Syntax:

[
  {
    "MemberId": "string",
    "Role": "Administrator"|"Member"
  }
  ...
]

--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 create multiple room memberships

The following batch-create-room-membership example adds multiple users to a chat room as chat room members. It also assigns administrator and member roles to the users.

aws chime batch-create-room-membership \
    --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \
    --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j \
    --membership-item-list "MemberId=1ab2345c-67de-8901-f23g-45h678901j2k,Role=Administrator" "MemberId=2ab2345c-67de-8901-f23g-45h678901j2k,Role=Member"

Output:

{
    "ResponseMetadata": {
        "RequestId": "169ba401-d886-475f-8b3f-e01eac6fadfb",
        "HTTPStatusCode": 201,
        "HTTPHeaders": {
            "x-amzn-requestid": "169ba401-d886-475f-8b3f-e01eac6fadfb",
            "content-type": "application/json",
            "content-length": "13",
            "date": "Mon, 02 Dec 2019 22:46:58 GMT",
            "connection": "keep-alive"
        },
        "RetryAttempts": 0
    },
    "Errors": []
}

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

Output

Errors -> (list)

If the action fails for one or more of the member IDs in the request, a list of the member IDs is returned, along with error codes and error messages.

(structure)

The list of errors returned when a member action results in an error.

MemberId -> (string)

The member ID.

ErrorCode -> (string)

The error code.

ErrorMessage -> (string)

The error message.