Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

BatchSuspendUser

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.

Request Syntax


POST /accounts/accountId/users?operation=suspend HTTP/1.1
Content-type: application/json

{
   "UserIdList": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

accountId

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes

Request Body

The request accepts the following data in JSON format.

UserIdList

The request containing the user IDs to suspend.

Type: Array of strings

Array Members: Maximum number of 50 items.

Pattern: .*\S.*

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "UserErrors": [ 
      { 
         "ErrorCode": "string",
         "ErrorMessage": "string",
         "UserId": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

UserErrors

If the BatchSuspendUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.

Type: Array of UserError objects

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples

In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example

This example suspends the listed users from the specified Amazon Chime account.

Sample Request


POST /console/accounts/12a3456b-7c89-012d-3456-78901e23fg45/users?operation=suspend HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.83 Python/3.6.6 Windows/10 botocore/1.12.73 X-Amz-Date: 20190108T183005Z Authorization: AUTHPARAMS Content-Length: 56 {"UserIdList": ["4ab2345c-67de-8901-f23g-45h678901j2k"]}

Sample Response


HTTP/1.1 200 OK x-amzn-RequestId: 5343c54a-eedf-487a-8178-38afb05c33ef Content-Type: application/json Content-Length: 146 Date: Tue, 08 Jan 2019 18:30:05 GMT Connection: keep-alive {"UserErrors": [] }