BatchChannelMemberships - Amazon Chime SDK

BatchChannelMemberships

The membership information, including member ARNs, the channel ARN, and membership types.

Contents

ChannelArn

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

Type: String

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

InvitedBy

The identifier of the member who invited another member.

Type: Identity object

Required: No

Members

The users successfully added to the request.

Type: Array of Identity objects

Required: No

SubChannelId

The ID of the SubChannel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Required: No

Type

The membership types set for the channel members.

Type: String

Valid Values: DEFAULT | HIDDEN

Required: No

See Also

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