Connect / Client / update_phone_number

update_phone_number#

Connect.Client.update_phone_number(**kwargs)#

Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.

Warning

After using this API, you must verify that the phone number is attached to the correct flow in the target instance or traffic distribution group. You need to do this because the API switches only the phone number to a new instance or traffic distribution group. It doesn’t migrate the flow configuration of the phone number, too.

You can call DescribePhoneNumber API to verify the status of a previous UpdatePhoneNumber operation.

See also: AWS API Documentation

Request Syntax

response = client.update_phone_number(
    PhoneNumberId='string',
    TargetArn='string',
    InstanceId='string',
    ClientToken='string'
)
Parameters:

  • PhoneNumberId (string) –

    [REQUIRED]

    A unique identifier for the phone number.

  • TargetArn (string) – The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId or TargetArn.

  • InstanceId (string) – The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.

  • 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.

Return type:

dict

Returns:

Response Syntax

{
    'PhoneNumberId': 'string',
    'PhoneNumberArn': 'string'
}

Response Structure

  • (dict) –

    • PhoneNumberId (string) –

      A unique identifier for the phone number.

    • PhoneNumberArn (string) –

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

Exceptions

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.InternalServiceException

  • Connect.Client.exceptions.ResourceInUseException

  • Connect.Client.exceptions.IdempotencyException

  • Connect.Client.exceptions.AccessDeniedException