delete-room-membership¶

Description¶

Removes a member from a chat room in an Amazon Chime Enterprise account.

Synopsis¶

  delete-room-membership
--account-id <value>
--room-id <value>
--member-id <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 (user ID or bot ID).

--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 remove a user as a member of a chat room

The following delete-room-membership example removes the specified member from the specified chat room.

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

This command produces no output.

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

Output¶

None

Table of Contents

Feedback

User Guide