BatchCreateChannelMembership - Amazon Chime

BatchCreateChannelMembership

Adds a specified number of users to a channel.

Request Syntax

POST /channels/channelArn/memberships?operation=batch-create HTTP/1.1 x-amz-chime-bearer: ChimeBearer Content-type: application/json { "MemberArns": [ "string" ], "Type": "string" }

URI Request Parameters

The request uses the following URI parameters.

channelArn

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

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Required: Yes

ChimeBearer

The AppInstanceUserArn of the user that makes the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Request Body

The request accepts the following data in JSON format.

MemberArns

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

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Required: Yes

Type

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.

Type: String

Valid Values: DEFAULT | HIDDEN

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "BatchChannelMemberships": { "ChannelArn": "string", "InvitedBy": { "Arn": "string", "Name": "string" }, "Members": [ { "Arn": "string", "Name": "string" } ], "Type": "string" }, "Errors": [ { "ErrorCode": "string", "ErrorMessage": "string", "MemberArn": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

BatchChannelMemberships

The list of channel memberships in the response.

Type: BatchChannelMemberships object

Errors

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.

Type: Array of BatchCreateChannelMembershipError objects

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: