Connect / Client / update_phone_number_metadata

update_phone_number_metadata#

Connect.Client.update_phone_number_metadata(**kwargs)#

Updates a phone number’s metadata.

Warning

To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API.

See also: AWS API Documentation

Request Syntax

response = client.update_phone_number_metadata(
    PhoneNumberId='string',
    PhoneNumberDescription='string',
    ClientToken='string'
)
Parameters:
  • PhoneNumberId (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) or resource ID of the phone number.

  • PhoneNumberDescription (string) – The description of the phone number.

  • ClientToken (string) –

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    This field is autopopulated if not provided.

Returns:

None

Exceptions

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.AccessDeniedException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.ResourceInUseException

  • Connect.Client.exceptions.IdempotencyException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.InternalServiceException