Chime / Client / update_user

update_user#

Chime.Client.update_user(**kwargs)#

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

Request Syntax

response = client.update_user(
    AccountId='string',
    UserId='string',
    LicenseType='Basic'|'Plus'|'Pro'|'ProTrial',
    UserType='PrivateUser'|'SharedDevice',
    AlexaForBusinessMetadata={
        'IsAlexaForBusinessEnabled': True|False,
        'AlexaForBusinessRoomArn': 'string'
    }
)

Parameters:

AccountId (string) –
[REQUIRED]

The Amazon Chime account ID.
UserId (string) –
[REQUIRED]

The user ID.
LicenseType (string) – The user license type to update. This must be a supported license type for the Amazon Chime account that the user belongs to.
UserType (string) – The user type.
AlexaForBusinessMetadata (dict) –
The Alexa for Business metadata.
- IsAlexaForBusinessEnabled (boolean) –
  
  Starts or stops Alexa for Business.
- AlexaForBusinessRoomArn (string) –
  
  The ARN of the room resource.

Return type:

dict

Returns:

Response Syntax

{
    'User': {
        'UserId': 'string',
        'AccountId': 'string',
        'PrimaryEmail': 'string',
        'PrimaryProvisionedNumber': 'string',
        'DisplayName': 'string',
        'LicenseType': 'Basic'|'Plus'|'Pro'|'ProTrial',
        'UserType': 'PrivateUser'|'SharedDevice',
        'UserRegistrationStatus': 'Unregistered'|'Registered'|'Suspended',
        'UserInvitationStatus': 'Pending'|'Accepted'|'Failed',
        'RegisteredOn': datetime(2015, 1, 1),
        'InvitedOn': datetime(2015, 1, 1),
        'AlexaForBusinessMetadata': {
            'IsAlexaForBusinessEnabled': True|False,
            'AlexaForBusinessRoomArn': 'string'
        },
        'PersonalPIN': 'string'
    }
}

Response Structure

(dict) –
- User (dict) –
  
  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 (datetime) –
    
    Date and time when the user is registered, in ISO 8601 format.
  - InvitedOn (datetime) –
    
    Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.
  - AlexaForBusinessMetadata (dict) –
    
    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.

Exceptions

Chime.Client.exceptions.UnauthorizedClientException
Chime.Client.exceptions.NotFoundException
Chime.Client.exceptions.ForbiddenException
Chime.Client.exceptions.BadRequestException
Chime.Client.exceptions.ThrottledClientException
Chime.Client.exceptions.ServiceUnavailableException
Chime.Client.exceptions.ServiceFailureException