[ aws . chime ]

update-user

Description

Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-user
--account-id <value>
--user-id <value>
[--license-type <value>]
[--user-type <value>]
[--alexa-for-business-metadata <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--account-id (string)

The Amazon Chime account ID.

--user-id (string)

The user ID.

--license-type (string)

The user license type to update. This must be a supported license type for the Amazon Chime account that the user belongs to.

Possible values:

• Basic

• Plus

• Pro

• ProTrial

--user-type (string)

The user type.

Possible values:

• PrivateUser

• SharedDevice

--alexa-for-business-metadata (structure)

The Alexa for Business metadata.

IsAlexaForBusinessEnabled -> (boolean)

Starts or stops Alexa for Business.

AlexaForBusinessRoomArn -> (string)

The ARN of the room resource.

Shorthand Syntax:

IsAlexaForBusinessEnabled=boolean,AlexaForBusinessRoomArn=string

JSON Syntax:

{
  "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.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To update user details

This example updates the specified details for the specified user.

Command:

aws chime update-user \
    --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \
    --user-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE \
    --license-type "Basic"

Output:

{
    "User": {
        "UserId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE"
    }
}

Output

User -> (structure)

The updated user details.

UserId -> (string)

The user ID.

AccountId -> (string)

The Amazon Chime account ID.

PrimaryEmail -> (string)

The primary email address of the user.

PrimaryProvisionedNumber -> (string)

The primary phone number associated with the user.

DisplayName -> (string)

The display name of the user.

LicenseType -> (string)

The license type for the user.

UserType -> (string)

The user type.

UserRegistrationStatus -> (string)

The user registration status.

UserInvitationStatus -> (string)

The user invite status.

RegisteredOn -> (timestamp)

Date and time when the user is registered, in ISO 8601 format.

InvitedOn -> (timestamp)

Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.

AlexaForBusinessMetadata -> (structure)

The Alexa for Business metadata.

IsAlexaForBusinessEnabled -> (boolean)

Starts or stops Alexa for Business.

AlexaForBusinessRoomArn -> (string)

The ARN of the room resource.

PersonalPIN -> (string)

The user’s personal meeting PIN.