[ aws . chime ]

batch-create-channel-membership

Description

Adds a specified number of users to a channel.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  batch-create-channel-membership
--channel-arn <value>
[--type <value>]
--member-arns <value>
[--chime-bearer <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--channel-arn (string)

The ARN of the channel to which you’re adding users.

--type (string)

The membership type of a user, DEFAULT or HIDDEN . Default members are always returned as part of ListChannelMemberships . Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN . Otherwise hidden members are not returned. This is only supported by moderators.

Possible values:

• DEFAULT

• HIDDEN

--member-arns (list)

The ARNs of the members you want to add to the channel.

(string)

Syntax:

"string" "string" ...

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

BatchChannelMemberships -> (structure)

The list of channel memberships in the response.

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 types set for the channel users.

Members -> (list)

The users successfully added to the request.

(structure)

The details of a user.

Arn -> (string)

The ARN in an Identity.

Name -> (string)

The name in an Identity.

ChannelArn -> (string)

The ARN of the channel to which you’re adding users.

Errors -> (list)

If the action fails for one or more of the memberships in the request, a list of the memberships is returned, along with error codes and error messages.

(structure)

A list of failed member ARNs, error codes, and error messages.

MemberArn -> (string)

The ARN of the member that the service couldn’t add.

ErrorCode -> (string)

The error code.

ErrorMessage -> (string)

The error message.