batch-create-room-membership AWS CLI 2.1.29 Command Reference
Description
Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be 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.
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
| --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.
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.
ncG1vNJzZmiZp6iwrbWNmqSasp%2Bjrri%2FjZympmemZ3ylu8KupJ6mpJbBqrvNaJipoV9ne3J6kXJmq52Wmr%2BmusKeZpygmaKycK7ArZqhZZOnsqLAxGapqKedYrqmucGeqaygmaV7qcDMpQ%3D%3D