[ aws . chime-sdk-messaging ]

describe-channel

Description

Returns the full details of a channel in an Amazon Chime AppInstance .

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

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

Options

--channel-arn (string)

The ARN of the channel.

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

See ‘aws help’ for descriptions of global parameters.

Output

Channel -> (structure)

The channel details.

Name -> (string)

The name of a channel.

ChannelArn -> (string)

The ARN of a channel.

Mode -> (string)

The mode of the channel.

Privacy -> (string)

The channel’s privacy setting.

Metadata -> (string)

The channel’s metadata.

CreatedBy -> (structure)

The AppInstanceUser who created the channel.

Arn -> (string)

The ARN in an Identity.

Name -> (string)

The name in an Identity.

CreatedTimestamp -> (timestamp)

The time at which the AppInstanceUser created the channel.

LastMessageTimestamp -> (timestamp)

The time at which a member sent the last message in the channel.

LastUpdatedTimestamp -> (timestamp)

The time at which a channel was last updated.

ChannelFlowArn -> (string)

The ARN of the channel flow.