Chime / Client / batch_update_user

batch_update_user#

Chime.Client.batch_update_user(**kwargs)#

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

response = client.batch_update_user(
    AccountId='string',
    UpdateUserRequestItems=[
        {
            '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.
UpdateUserRequestItems (list) –
[REQUIRED]

The request containing the user IDs and details to update.
- (dict) –
  
  The user ID and user fields to update, used with the BatchUpdateUser action.
  - UserId (string) – [REQUIRED]
    
    The user ID.
  - LicenseType (string) –
    
    The user license type.
  - 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

{
    'UserErrors': [
        {
            'UserId': 'string',
            'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

(dict) –
- 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.
  - (dict) –
    
    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.

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