Skip to content
AWS for Query.Farm

aws.connect.describe_phone_number

Example SQL Queries

SELECT * FROM
aws.connect.describe_phone_number
WHERE
"phone_number_id" = 'VALUE';

Description

Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.

If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

Table Definition

Column NameColumn Data Type
phone_number_id Required Input Column

A unique identifier for the phone number.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
claimed_phone_number_summary

Information about a phone number that's been claimed to your Amazon Connect instance or traffic distribution group.

STRUCT(
    "phone_number_id" VARCHAR,
    "phone_number_arn" VARCHAR,
    "phone_number" VARCHAR,
    "phone_number_country_code" VARCHAR,
    "phone_number_type" VARCHAR,
    "phone_number_description" VARCHAR,
    "target_arn" VARCHAR,
    "instance_id" VARCHAR,
    "tags" MAP(VARCHAR, VARCHAR),
    "phone_number_status" STRUCT(
        "status" VARCHAR,
        "message" VARCHAR
    ),
    "source_phone_number_arn" VARCHAR
)
Show child fields
claimed_phone_number_summary.instance_id

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.

claimed_phone_number_summary.phone_number

The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].

claimed_phone_number_summary.phone_number_arn

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

claimed_phone_number_summary.phone_number_country_code

The ISO country code.

claimed_phone_number_summary.phone_number_description

The description of the phone number.

claimed_phone_number_summary.phone_number_id

A unique identifier for the phone number.

claimed_phone_number_summary.phone_number_status

The status of the phone number.

  • CLAIMED means the previous ClaimPhoneNumber or UpdatePhoneNumber operation succeeded.

  • IN_PROGRESS means a ClaimPhoneNumber, UpdatePhoneNumber, or UpdatePhoneNumberMetadata operation is still in progress and has not yet completed. You can call DescribePhoneNumber at a later time to verify if the previous operation has completed.

  • FAILED indicates that the previous ClaimPhoneNumber or UpdatePhoneNumber operation has failed. It will include a message indicating the failure reason. A common reason for a failure may be that the TargetArn value you are claiming or updating a phone number to has reached its limit of total claimed numbers. If you received a FAILED status from a ClaimPhoneNumber API call, you have one day to retry claiming the phone number before the number is released back to the inventory for other customers to claim.

You will not be billed for the phone number during the 1-day period if number claiming fails.

Show child fields
claimed_phone_number_summary.phone_number_status.message

The status message.

claimed_phone_number_summary.phone_number_status.status

The status.

claimed_phone_number_summary.phone_number_type

The type of phone number.

claimed_phone_number_summary.source_phone_number_arn

The claimed phone number ARN that was previously imported from the external service, such as Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like the ARN of the phone number that was imported from Amazon Pinpoint.

claimed_phone_number_summary.tags

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

claimed_phone_number_summary.target_arn

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through.