Chime / Client / update_user_settings

update_user_settings

Chime.Client.update_user_settings(**kwargs)

Updates the settings for the specified user, such as phone number settings.

See also: AWS API Documentation

Request Syntax

response = client.update_user_settings(
    AccountId='string',
    UserId='string',
    UserSettings={
        'Telephony': {
            'InboundCalling': True|False,
            'OutboundCalling': True|False,
            'SMS': True|False
        }
    }
)

Parameters:

• AccountId (string) –

  [REQUIRED]

  The Amazon Chime account ID.

• UserId (string) –

  [REQUIRED]

  The user ID.

• UserSettings (dict) –

  [REQUIRED]

  The user settings to update.

  • Telephony (dict) – [REQUIRED]

    The telephony settings associated with the user.

    • InboundCalling (boolean) – [REQUIRED]

      Allows or denies inbound calling.

    • OutboundCalling (boolean) – [REQUIRED]

      Allows or denies outbound calling.

    • SMS (boolean) – [REQUIRED]

      Allows or denies SMS messaging.

Returns:

None

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