[ aws . chime-sdk-messaging ]

list-sub-channels

Description

Lists all the SubChannels in an elastic channel when given a channel ID. Available only to the app instance admins and channel moderators of elastic channels.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-sub-channels
--channel-arn <value>
--chime-bearer <value>
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--channel-arn (string)

The ARN of elastic channel.

--chime-bearer (string)

The AppInstanceUserArn of the user making the API call.

--max-results (integer)

The maximum number of sub-channels that you want to return.

--next-token (string)

The token passed by previous API calls until all requested sub-channels are returned.

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

SubChannels -> (list)

The information about each sub-channel.

(structure)

Summary of the sub-channels associated with the elastic channel.

SubChannelId -> (string)

The unique ID of a SubChannel.

MembershipCount -> (integer)

The number of members in a SubChannel.

NextToken -> (string)

The token passed by previous API calls until all requested sub-channels are returned.