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.

Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

Users suspended from a Team account are disassociated from the account,but they can continue to use Amazon Chime as free users. To remove the suspension from suspended Team account users, invite them to the Team account again. You can use the InviteUsers action to do so.

Users suspended from an EnterpriseLWA account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended EnterpriseLWA account users, use the BatchUnsuspendUser action.

To sign out users without suspending them, use the LogoutUser action.

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 BeginBatchSuspendUser and EndBatchSuspendUser.

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

Syntax

C#
public abstract Task<BatchSuspendUserResponse> BatchSuspendUserAsync(
         BatchSuspendUserRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.Chime.Model.BatchSuspendUserRequest

Container for the necessary parameters to execute the BatchSuspendUser 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 BatchSuspendUser 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.
NotFoundException One or more of the resources in the request does not exist in the system.
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 Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also