Skip to content

aws.pinpoint_email.get_deliverability_test_report

Example SQL Queries

SELECT * FROM
aws.pinpoint_email.get_deliverability_test_report
WHERE
"report_id" = 'VALUE';

Description

Retrieve the results of a predictive inbox placement test.

Table Definition

Column NameColumn Data Type
report_id Required Input Column

A unique string that identifies the predictive inbox placement test.

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.

deliverability_test_report

An object that contains the results of the predictive inbox placement test.

STRUCT(
"report_id" VARCHAR,
"report_name" VARCHAR,
"subject" VARCHAR,
"from_email_address" VARCHAR,
"create_date" TIMESTAMP_S,
"deliverability_test_status" VARCHAR
)
Show child fields
deliverability_test_report.create_date

The date and time when the predictive inbox placement test was created, in Unix time format.

deliverability_test_report.deliverability_test_status

The status of the predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE, then the test is finished, and you can use the GetDeliverabilityTestReport to view the results of the test.

deliverability_test_report.from_email_address

The sender address that you specified for the predictive inbox placement test.

deliverability_test_report.report_id

A unique string that identifies the predictive inbox placement test.

deliverability_test_report.report_name

A name that helps you identify a predictive inbox placement test report.

deliverability_test_report.subject

The subject line for an email that you submitted in a predictive inbox placement test.

isp_placements

An object that describes how the test email was handled by several email providers, including Gmail, Hotmail, Yahoo, AOL, and others.

STRUCT(
"isp_name" VARCHAR,
"placement_statistics" STRUCT(
"inbox_percentage" DOUBLE,
"spam_percentage" DOUBLE,
"missing_percentage" DOUBLE,
"spf_percentage" DOUBLE,
"dkim_percentage" DOUBLE
)
)[]
Show child fields
isp_placements[]
Show child fields
isp_placements[].isp_name

The name of the email provider that the inbox placement data applies to.

isp_placements[].placement_statistics

An object that contains inbox placement metrics for a specific email provider.

Show child fields
isp_placements[].placement_statistics.dkim_percentage

The percentage of emails that were authenticated by using DomainKeys Identified Mail (DKIM) during the predictive inbox placement test.

isp_placements[].placement_statistics.inbox_percentage

The percentage of emails that arrived in recipients' inboxes during the predictive inbox placement test.

isp_placements[].placement_statistics.missing_percentage

The percentage of emails that didn't arrive in recipients' inboxes at all during the predictive inbox placement test.

isp_placements[].placement_statistics.spam_percentage

The percentage of emails that arrived in recipients' spam or junk mail folders during the predictive inbox placement test.

isp_placements[].placement_statistics.spf_percentage

The percentage of emails that were authenticated by using Sender Policy Framework (SPF) during the predictive inbox placement test.

message

An object that contains the message that you sent when you performed this predictive inbox placement test.

VARCHAR
overall_placement

An object that specifies how many test messages that were sent during the predictive inbox placement test were delivered to recipients' inboxes, how many were sent to recipients' spam folders, and how many weren't delivered.

STRUCT(
"inbox_percentage" DOUBLE,
"spam_percentage" DOUBLE,
"missing_percentage" DOUBLE,
"spf_percentage" DOUBLE,
"dkim_percentage" DOUBLE
)
Show child fields
overall_placement.dkim_percentage

The percentage of emails that were authenticated by using DomainKeys Identified Mail (DKIM) during the predictive inbox placement test.

overall_placement.inbox_percentage

The percentage of emails that arrived in recipients' inboxes during the predictive inbox placement test.

overall_placement.missing_percentage

The percentage of emails that didn't arrive in recipients' inboxes at all during the predictive inbox placement test.

overall_placement.spam_percentage

The percentage of emails that arrived in recipients' spam or junk mail folders during the predictive inbox placement test.

overall_placement.spf_percentage

The percentage of emails that were authenticated by using Sender Policy Framework (SPF) during the predictive inbox placement test.

tags

An array of objects that define the tags (keys and values) that are associated with the predictive inbox placement test.

STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
Show child fields
tags[]
Show child fields
tags[].key

One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.

tags[].value

The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don’t want a resource to have a specific tag value, don’t specify a value for this parameter. Amazon Pinpoint will set the value to an empty string.