batch-update-user¶

Description¶

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.

Synopsis¶

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

Options¶

--account-id (string)

The Amazon Chime account ID.

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

The request containing the user IDs and details to update.

(structure)

The user ID and user fields to update, used with the BatchUpdateUser action.

UserId -> (string)

The user ID.

LicenseType -> (string)

The user license type.

UserType -> (string)

The user type.

AlexaForBusinessMetadata -> (structure)

The Alexa for Business metadata.

IsAlexaForBusinessEnabled -> (boolean)

Starts or stops Alexa for Business.

AlexaForBusinessRoomArn -> (string)

The ARN of the room resource.

Shorthand Syntax:

UserId=string,LicenseType=string,UserType=string,AlexaForBusinessMetadata={IsAlexaForBusinessEnabled=boolean,AlexaForBusinessRoomArn=string} ...

JSON Syntax:

[
  {
    "UserId": "string",
    "LicenseType": "Basic"|"Plus"|"Pro"|"ProTrial",
    "UserType": "PrivateUser"|"SharedDevice",
    "AlexaForBusinessMetadata": {
      "IsAlexaForBusinessEnabled": true|false,
      "AlexaForBusinessRoomArn": "string"
    }
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

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"

Output:

{
    "UserErrors": []
}

Output¶

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.

(structure)

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.

Table of Contents

Feedback

User Guide