Amazon Chime
API Reference (API Version 2018-05-01)

BatchUpdateUser

Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account. Currently, only LicenseType updates are supported for this action.

Request Syntax

POST /console/accounts/accountId/users HTTP/1.1 Content-type: application/json { "UpdateUserRequestItems": [ { "LicenseType": "string", "UserId": "string" } ] }

URI Request Parameters

The request requires the following URI parameters.

AccountId

The Amazon Chime account ID.

Pattern: .*\S.*

Request Body

The request accepts the following data in JSON format.

UpdateUserRequestItems

The request containing the user IDs and details to update.

Type: Array of UpdateUserRequestItem objects

Array Members: Maximum number of 20 items.

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 BatchUpdateUser 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. For example, when a user tries to create an account from an unsupported region.

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: