Returns the full details of a channel in an Amazon Chime
x-amz-chime-bearerrequest header is mandatory. Use the ARN of the
AppInstanceBotthat makes the API call as the value in the header.
See also: AWS API Documentation
describe-channel --channel-arn <value> --chime-bearer <value> [--cli-input-json | --cli-input-yaml] [--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>] [--cli-binary-format <value>] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt]
The ARN of the channel.
The ARN of the
AppInstanceBotthat makes the API call.
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
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.
Turn on debug logging.
Override command’s default URL with the given URL.
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.
Disable automatic pagination.
The formatting style for command output.
A JMESPath query to use in filtering the response data.
Use a specific profile from your credential file.
The region to use. Overrides config/env settings.
Display the version of this tool.
Turn on/off color output.
Do not sign requests. Credentials will not be loaded if this argument is provided.
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
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.
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.
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob
fileb:// will always be treated as binary and use the file contents directly regardless of the
cli-binary-format setting. When using
file:// the file contents will need to properly formatted for the configured
Disable cli pager for output.
Automatically prompt for CLI input parameters.
Disable automatically prompt for CLI input parameters.
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)
AppInstanceUserwho created the channel.
Arn -> (string)The ARN in an Identity.
Name -> (string)The name in an Identity.
CreatedTimestamp -> (timestamp)The time at which the
AppInstanceUsercreated 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.