Skip to content
AWS for Query.Farm

aws.pinpoint_sms_voice_v2.describe_sender_ids

Example SQL Queries

SELECT * FROM
aws.pinpoint_sms_voice_v2.describe_sender_ids;

Description

Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.

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

f you specify a sender ID that isn't valid, an error is returned.

Table Definition

Column NameColumn Data Type
filters Input Column

An array of SenderIdFilter 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[]
sender_ids Input Column

An array of SenderIdAndCountry objects to search for.

STRUCT(
    "sender_id" VARCHAR,
    "iso_country_code" VARCHAR
)[]
Show child fields
sender_ids[]
Show child fields
sender_ids[].iso_country_code

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

sender_ids[].sender_id

The unique identifier of the sender.

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

deletion_protection_enabled

By default this is set to false. When set to true the sender ID 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_types

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[]
Show child fields
message_types[]
monthly_leasing_price

The monthly leasing price, in US dollars.

VARCHAR
registered

True if the sender ID is registered.

BOOLEAN
registration_id

The unique identifier for the registration.

VARCHAR
sender_id

The alphanumeric sender ID in a specific country that you'd like to describe.

VARCHAR
sender_id_arn

The Amazon Resource Name (ARN) associated with the SenderId.

VARCHAR