Skip to content
AWS for Query.Farm

aws.pinpoint_sms_voice_v2.describe_opted_out_numbers

Example SQL Queries

SELECT * FROM
aws.pinpoint_sms_voice_v2.describe_opted_out_numbers
WHERE
"opt_out_list_name" = 'VALUE';

Description

Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.

If you specify opted out numbers, the output includes information for only the specified opted out numbers. If you specify filters, the output includes information for only those opted out numbers that meet the filter criteria. If you don't specify opted out numbers or filters, the output includes information for all opted out destination numbers in your opt-out list.

If you specify an opted out number that isn't valid, an error is returned.

Table Definition

Column NameColumn Data Type
opt_out_list_name Required Input Column

The name of the OptOutList.

VARCHAR
filters Input Column

An array of OptedOutFilter objects to filter the results on.

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

The name of the attribute to filter on.

filters[].values[]
_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.

_input_opted_out_numbers Input Column
VARCHAR[]
Show child fields
_input_opted_out_numbers[]
opt_out_list_arn

The Amazon Resource Name (ARN) of the OptOutList.

VARCHAR
opted_out_numbers

An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.

STRUCT(
    "opted_out_number" VARCHAR,
    "opted_out_timestamp" TIMESTAMP_S,
    "end_user_opted_out" BOOLEAN
)[]
Show child fields
opted_out_numbers[]
Show child fields
opted_out_numbers[].end_user_opted_out

This is set to true if it was the end recipient that opted out.

opted_out_numbers[].opted_out_number

The phone number that is opted out.

opted_out_numbers[].opted_out_timestamp

The time that the op tout occurred, in UNIX epoch time format.