The Amazon Chime SDK Identity, Media Pipelines, Meetings, and Messaging APIs are now published on the new Amazon Chime SDK API Reference. For more information, see the Amazon Chime SDK API Reference.
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 users.
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
- Type
-
The membership types set for the channel users.
Type: String
Valid Values:
DEFAULT | HIDDENRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
