[ aws . chime-sdk-messaging ]

create-channel-moderator

Description

Creates a new ChannelModerator . A channel moderator can:

• Add and remove other members of the channel.

• Add and remove other moderators of the channel.

• Add and remove user bans for the channel.

• Redact messages in the channel.

• List messages in the channel.

Note

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-channel-moderator
--channel-arn <value>
--channel-moderator-arn <value>
--chime-bearer <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--channel-arn (string)

The ARN of the channel.

--channel-moderator-arn (string)

The AppInstanceUserArn of the moderator.

--chime-bearer (string)

The AppInstanceUserArn of the user that makes the API call.

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

Output

ChannelArn -> (string)

The ARN of the channel.

ChannelModerator -> (structure)

The ARNs of the channel and the moderator.

Arn -> (string)

The ARN in an Identity.

Name -> (string)

The name in an Identity.