Skip to content
AWS for Query.Farm

aws.pinpoint_sms_voice_v2.describe_phone_numbers

Example SQL Queries

SELECT * FROM
aws.pinpoint_sms_voice_v2.describe_phone_numbers;

Description

Describes the specified origination phone number, or all the phone numbers in your account.

If you specify phone number IDs, the output includes information for only the specified phone numbers. If you specify filters, the output includes information for only those phone numbers that meet the filter criteria. If you don't specify phone number IDs or filters, the output includes information for all phone numbers.

If you specify a phone number ID that isn't valid, an error is returned.

Table Definition

Column NameColumn Data Type
filters Input Column

An array of PhoneNumberFilter objects to filter the results.

STRUCT(
    "name" VARCHAR,
    "values" VARCHAR[]
)[]
Show child fields
filters[]
Show child fields
filters[].name

The name of the attribute to filter on.

filters[].values[]
phone_number_ids Input Column

The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.

VARCHAR[]
Show child fields
phone_number_ids[]
_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.

created_timestamp

The time when the phone number was created, in UNIX epoch time format.

TIMESTAMP_S
deletion_protection_enabled

When set to true the phone number can't be deleted.

BOOLEAN
iso_country_code

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. 

VARCHAR
message_type

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

VARCHAR
monthly_leasing_price

The price, in US dollars, to lease the phone number.

VARCHAR
number_capabilities

Describes if the origination identity can be used for text messages, voice calls or both.

VARCHAR[]
Show child fields
number_capabilities[]
number_type

The type of phone number.

VARCHAR
opt_out_list_name

The name of the OptOutList associated with the phone number.

VARCHAR
phone_number

The phone number in E.164 format.

VARCHAR
phone_number_arn

The Amazon Resource Name (ARN) associated with the phone number.

VARCHAR
phone_number_id

The unique identifier for the phone number.

VARCHAR
pool_id

The unique identifier of the pool associated with the phone number.

VARCHAR
registration_id

The unique identifier for the registration.

VARCHAR
self_managed_opt_outs_enabled

When set to false an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out request. For more information see Self-managed opt-outs 

BOOLEAN
status

The current status of the phone number.

VARCHAR
two_way_channel_arn

The Amazon Resource Name (ARN) of the two way channel.

VARCHAR
two_way_channel_role

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

VARCHAR
two_way_enabled

By default this is set to false. When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.

BOOLEAN