ChannelBan - Amazon Chime

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.


The details of a channel ban.



The ARN of the channel from which a member is being banned.

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


The AppInstanceUser who created the ban.

Type: Identity object

Required: No


The time at which the ban was created.

Type: Timestamp

Required: No


The member being banned from the channel.

Type: Identity object

Required: No

See Also

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