AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginCreateChannelBan and EndCreateChannelBan.
Namespace: Amazon.Chime
Assembly: AWSSDK.Chime.dll
Version: 3.x.y.z
public abstract Task<CreateChannelBanResponse> CreateChannelBanAsync( CreateChannelBanRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the CreateChannelBan service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| BadRequestException | The input parameters don't match the service's restrictions. |
| ConflictException | The request could not be processed because of conflict in the current state of the resource. |
| ForbiddenException | The client is permanently forbidden from making the request. |
| ResourceLimitExceededException | The request exceeds the resource limit. |
| ServiceFailureException | The service encountered an unexpected error. |
| ServiceUnavailableException | The service is currently unavailable. |
| ThrottledClientException | The client exceeded its request rate limit. |
| UnauthorizedClientException | The client is not currently authorized to make the request. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5