/AWS1/CL_CHE=>CREATECHANNELBAN()

About CreateChannelBan

Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to DeleteChannelBan, and then CreateChannelMembership. Bans are cleaned up when you delete users or channels.

If you ban a user who is already part of a channel, that user is automatically kicked from the channel.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannelBan, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Method Signature

IMPORTING

Required arguments:

IV_CHANNELARN TYPE /AWS1/CHECHIMEARN /AWS1/CHECHIMEARN

The ARN of the ban request.

IV_MEMBERARN TYPE /AWS1/CHECHIMEARN /AWS1/CHECHIMEARN

The ARN of the member being banned.

Optional arguments:

IV_CHIMEBEARER TYPE /AWS1/CHECHIMEARN /AWS1/CHECHIMEARN

The AppInstanceUserArn of the user that makes the API call.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_CHECRECHANNELBANRSP /AWS1/CL_CHECRECHANNELBANRSP