Skip to content

aws.pinpoint_email.get_deliverability_dashboard_options

Example SQL Queries

SELECT * FROM
aws.pinpoint_email.get_deliverability_dashboard_options;

Description

Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.

When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.

Table Definition

Column NameColumn Data Type
_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.

account_status

The current status of your Deliverability dashboard subscription. If this value is PENDING_EXPIRATION, your subscription is scheduled to expire at the end of the current calendar month.

VARCHAR
active_subscribed_domains

An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that isn’t scheduled to expire at the end of the current calendar month.

STRUCT(
"domain" VARCHAR,
"subscription_start_date" TIMESTAMP_S,
"inbox_placement_tracking_option" STRUCT(
"global" BOOLEAN,
"tracked_isps" VARCHAR[]
)
)[]
Show child fields
active_subscribed_domains[]
Show child fields
active_subscribed_domains[].domain

A verified domain that’s associated with your AWS account and currently has an active Deliverability dashboard subscription.

active_subscribed_domains[].inbox_placement_tracking_option

An object that contains information about the inbox placement data settings for the domain.

Show child fields
active_subscribed_domains[].inbox_placement_tracking_option.global

Specifies whether inbox placement data is being tracked for the domain.

active_subscribed_domains[].inbox_placement_tracking_option.tracked_isps[]
active_subscribed_domains[].subscription_start_date

The date, in Unix time format, when you enabled the Deliverability dashboard for the domain.

dashboard_enabled

Specifies whether the Deliverability dashboard is enabled for your Amazon Pinpoint account. If this value is true, the dashboard is enabled.

BOOLEAN
pending_expiration_subscribed_domains

An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that's scheduled to expire at the end of the current calendar month.

STRUCT(
"domain" VARCHAR,
"subscription_start_date" TIMESTAMP_S,
"inbox_placement_tracking_option" STRUCT(
"global" BOOLEAN,
"tracked_isps" VARCHAR[]
)
)[]
Show child fields
pending_expiration_subscribed_domains[]
Show child fields
pending_expiration_subscribed_domains[].domain

A verified domain that’s associated with your AWS account and currently has an active Deliverability dashboard subscription.

pending_expiration_subscribed_domains[].inbox_placement_tracking_option

An object that contains information about the inbox placement data settings for the domain.

Show child fields
pending_expiration_subscribed_domains[].inbox_placement_tracking_option.global

Specifies whether inbox placement data is being tracked for the domain.

pending_expiration_subscribed_domains[].inbox_placement_tracking_option.tracked_isps[]
pending_expiration_subscribed_domains[].subscription_start_date

The date, in Unix time format, when you enabled the Deliverability dashboard for the domain.

subscription_expiry_date

The date, in Unix time format, when your current subscription to the Deliverability dashboard is scheduled to expire, if your subscription is scheduled to expire at the end of the current calendar month. This value is null if you have an active subscription that isn’t due to expire at the end of the month.

TIMESTAMP_S