[ aws . chime-sdk-messaging ]

list-channel-memberships

Description

Lists all channel memberships in a channel.

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.

If you want to list the channels to which a specific app instance user belongs, see the ListChannelMembershipsForAppInstanceUser API.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--channel-arn (string)

The maximum number of channel memberships that you want returned.

--type (string)

The membership type of a user, DEFAULT or HIDDEN . Default members are returned as part of ListChannelMemberships if no type is specified. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN .

Possible values:

• DEFAULT

• HIDDEN

--max-results (integer)

The maximum number of channel memberships that you want returned.

--next-token (string)

The token passed by previous API calls until all requested channel memberships are returned.

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

ChannelArn -> (string)

The ARN of the channel.

ChannelMemberships -> (list)

The information for the requested channel memberships.

(structure)

Summary of the details of a ChannelMembership .

Member -> (structure)

A member’s summary data.

Arn -> (string)

The ARN in an Identity.

Name -> (string)

The name in an Identity.

NextToken -> (string)

The token passed by previous API calls until all requested channel memberships are returned.