[ aws . chime ]

create-channel

Description

Creates a channel to which you can add users and send messages.

Restriction : You can’t change a channel’s privacy.

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
--app-instance-arn <value>
--name <value>
[--mode <value>]
[--privacy <value>]
[--metadata <value>]
[--client-request-token <value>]
[--tags <value>]
[--chime-bearer <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--app-instance-arn (string)

The ARN of the channel request.

--name (string)

The name of the channel.

--mode (string)

The channel mode: UNRESTRICTED or RESTRICTED . Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.

Possible values:

• UNRESTRICTED

• RESTRICTED

--privacy (string)

The channel’s privacy level: PUBLIC or PRIVATE . Private channels aren’t discoverable by users outside the channel. Public channels are discoverable by anyone in the AppInstance .

Possible values:

• PUBLIC

• PRIVATE

--metadata (string)

The metadata of the creation request. Limited to 1KB and UTF-8.

--client-request-token (string)

The client token for the request. An Idempotency token.

--tags (list)

The tags for the creation request.

(structure)

Describes a tag applied to a resource.

Key -> (string)

The key of the tag.

Value -> (string)

The value of the tag.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

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