Skip to content
AWS for Query.Farm

aws.chime_sdk_voice.get_phone_number

Example SQL Queries

SELECT * FROM
aws.chime_sdk_voice.get_phone_number
WHERE
"phone_number_id" = 'VALUE';

Description

Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.

Table Definition

Column NameColumn Data Type
phone_number_id Required Input Column

The phone number ID.

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.

phone_number

The phone number details.

STRUCT(
    "phone_number_id" VARCHAR,
    "e164_phone_number" VARCHAR,
    "country" VARCHAR,
    "type" VARCHAR,
    "product_type" VARCHAR,
    "status" VARCHAR,
    "capabilities" STRUCT(
        "inbound_call" BOOLEAN,
        "outbound_call" BOOLEAN,
        "inbound_sms" BOOLEAN,
        "outbound_sms" BOOLEAN,
        "inbound_mms" BOOLEAN,
        "outbound_mms" BOOLEAN
    ),
    "associations" STRUCT(
        "value" VARCHAR,
        "name" VARCHAR,
        "associated_timestamp" TIMESTAMP_S
    )[],
    "calling_name" VARCHAR,
    "calling_name_status" VARCHAR,
    "created_timestamp" TIMESTAMP_S,
    "updated_timestamp" TIMESTAMP_S,
    "deletion_timestamp" TIMESTAMP_S,
    "order_id" VARCHAR,
    "name" VARCHAR
)
Show child fields
phone_number.associations[]
Show child fields
phone_number.associations[].associated_timestamp

The timestamp of the phone number association, in ISO 8601 format.

phone_number.associations[].name

Defines the association with an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID.

phone_number.associations[].value

Contains the ID for the entity specified in Name.

phone_number.calling_name

The outbound calling name associated with the phone number.

phone_number.calling_name_status

The outbound calling name status.

phone_number.capabilities

The phone number's capabilities.

Show child fields
phone_number.capabilities.inbound_call

Allows or denies inbound calling for the specified phone number.

phone_number.capabilities.inbound_mms

Allows or denies inbound MMS messaging for the specified phone number.

phone_number.capabilities.inbound_sms

Allows or denies inbound SMS messaging for the specified phone number.

phone_number.capabilities.outbound_call

Allows or denies outbound calling for the specified phone number.

phone_number.capabilities.outbound_mms

Allows or denies inbound MMS messaging for the specified phone number.

phone_number.capabilities.outbound_sms

Allows or denies outbound SMS messaging for the specified phone number.

phone_number.country

The phone number's country. Format: ISO 3166-1 alpha-2.

phone_number.created_timestamp

The phone number creation timestamp, in ISO 8601 format.

phone_number.deletion_timestamp

The deleted phone number timestamp, in ISO 8601 format.

phone_number.e164_phone_number

The phone number, in E.164 format.

phone_number.name

The name of the phone number.

phone_number.order_id

The phone number's order ID.

phone_number.phone_number_id

The phone number's ID.

phone_number.product_type

The phone number's product type.

phone_number.status

The phone number's status.

phone_number.type

The phone number's type.

phone_number.updated_timestamp

The updated phone number timestamp, in ISO 8601 format.