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 ]
Returns the full details of a user's channel membership.
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
describe-channel-membership
--channel-arn <value>
--member-arn <value>
--chime-bearer <value>
[--sub-channel-id <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>]
--channel-arn
(string)
The ARN of the channel.
--member-arn
(string)
TheAppInstanceUserArn
of the member.
--chime-bearer
(string)
The ARN of theAppInstanceUser
orAppInstanceBot
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
(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.
--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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--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.
--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.
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.