[ aws . chime-sdk-messaging ]

describe-channel-membership

Description

Returns the full details of a user’s channel membership.

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-membership
--channel-arn <value>
--member-arn <value>
--chime-bearer <value>
[--sub-channel-id <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--channel-arn (string)

The ARN of the channel.

--member-arn (string)

The AppInstanceUserArn of the member.

--chime-bearer (string)

The AppInstanceUserArn of the user that makes the API call.

--sub-channel-id (string)

The ID of the SubChannel in the request. The response contains an ElasticChannelConfiguration object.

Note

Only required to get a user’s SubChannel membership details.

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

ChannelMembership -> (structure)

The details of the membership.

InvitedBy -> (structure)

The identifier of the member who invited another member.

Arn -> (string)

The ARN in an Identity.

Name -> (string)

The name in an Identity.

Type -> (string)

The membership type set for the channel member.

Member -> (structure)

The data of the channel member.

Arn -> (string)

The ARN in an Identity.

Name -> (string)

The name in an Identity.

ChannelArn -> (string)

The ARN of the member’s channel.

CreatedTimestamp -> (timestamp)

The time at which the channel membership was created.

LastUpdatedTimestamp -> (timestamp)

The time at which a channel membership was last updated.

SubChannelId -> (string)

The ID of the SubChannel that a user belongs to.