AWS SDK Version 3 for .NET
API Reference

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.

Lists all the users banned from a particular 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, ListChannelBans, 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.

Note:

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 BeginListChannelBans and EndListChannelBans.

Namespace: Amazon.Chime
Assembly: AWSSDK.Chime.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<ListChannelBansResponse> ListChannelBansAsync(
         ListChannelBansRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.Chime.Model.ListChannelBansRequest

Container for the necessary parameters to execute the ListChannelBans service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the ListChannelBans service method, as returned by Chime.

Exceptions

ExceptionCondition
BadRequestException The input parameters don't match the service's restrictions.
ForbiddenException The client is permanently forbidden from making the request.
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.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also