AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ 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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

See also: AWS API Documentation

Synopsis

  describe-channel
--channel-arn <value>
--chime-bearer <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--channel-arn (string)

The ARN of the channel.

--chime-bearer (string)

The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

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.

ElasticChannelConfiguration -> (structure)

The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.

MaximumSubChannels -> (integer)

The maximum number of SubChannels that you want to allow in the elastic channel.

TargetMembershipsPerSubChannel -> (integer)

The maximum number of members allowed in a SubChannel.

MinimumMembershipPercentage -> (integer)

The minimum allowed percentage of TargetMembershipsPerSubChannel users. Ceil of the calculated value is used in balancing members among SubChannels of the elastic channel.

ExpirationSettings -> (structure)

Settings that control when a channel expires.

ExpirationDays -> (integer)

The period in days after which the system automatically deletes a channel.

ExpirationCriterion -> (string)

The conditions that must be met for a channel to expire.