Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . chime ]



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.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--account-id <value>
--update-user-request-items <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--account-id (string)

The Amazon Chime account ID.

--update-user-request-items (list)

The request containing the user IDs and details to update.

Shorthand Syntax:

UserId=string,LicenseType=string ...

JSON Syntax:

    "UserId": "string",
    "LicenseType": "Basic"|"Plus"|"Pro"|"ProTrial"

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


To update multiple users in a single command

The following batch-update-user example updates the LicenseType for each of the listed users in the specified Amazon Chime account.

aws chime batch-update-user \
    --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
    --update-user-request-items "UserId=a1b2c3d4-5678-90ab-cdef-22222EXAMPLE,LicenseType=Basic" "UserId=a1b2c3d4-5678-90ab-cdef-33333EXAMPLE,LicenseType=Basic"


    "UserErrors": []


UserErrors -> (list)

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.


The list of errors returned when errors are encountered during the BatchSuspendUser , BatchUnsuspendUser , or BatchUpdateUser actions. This includes user IDs, error codes, and error messages.

UserId -> (string)

The user ID for which the action failed.

ErrorCode -> (string)

The error code.

ErrorMessage -> (string)

The error message.