Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).
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 ]
Adds a user to a channel. The InvitedBy
field in ChannelMembership
is derived from the request header. A channel member can:
Privacy settings impact this action as follows:
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.
create-channel-membership
--channel-arn <value>
--member-arn <value>
--type <value>
--chime-bearer <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
--channel-arn
(string)
The ARN of the channel to which you're adding users.
--member-arn
(string)
TheAppInstanceUserArn
of the member you want to add to the channel.
--type
(string)
The membership type of a user,
DEFAULT
orHIDDEN
. Default members are always returned as part ofListChannelMemberships
. Hidden members are only returned if the type filter inListChannelMemberships
equalsHIDDEN
. Otherwise hidden members are not returned. This is only supported by moderators.Possible values:
DEFAULT
HIDDEN
--chime-bearer
(string)
TheAppInstanceUserArn
of the user that makes the API call.
--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.
See 'aws help' for descriptions of global parameters.
ChannelArn -> (string)
The ARN of the channel.
Member -> (structure)
The ARN and metadata of the member being added.
Arn -> (string)
The ARN in an Identity.Name -> (string)
The name in an Identity.