Skip to content

aws.pinpoint_email.list_domain_deliverability_campaigns

Example SQL Queries

SELECT * FROM
aws.pinpoint_email.list_domain_deliverability_campaigns
WHERE
"start_date" = 'VALUE'
AND "end_date" = 'VALUE'
AND "subscribed_domain" = 'VALUE';

Description

Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard (PutDeliverabilityDashboardOption operation) for the domain.

Table Definition

Column NameColumn Data Type
end_date Required Input Column

The last day, in Unix time format, that you want to obtain deliverability data for. This value has to be less than or equal to 30 days after the value of the StartDate parameter.

TIMESTAMP_S
start_date Required Input Column

The first day, in Unix time format, that you want to obtain deliverability data for.

TIMESTAMP_S
subscribed_domain Required Input Column

The domain to obtain deliverability data for.

VARCHAR
next_token Input Column

A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of the campaign in the list of campaigns.

VARCHAR
page_size Input Column

The maximum number of results to include in response to a single call to the ListDomainDeliverabilityCampaigns operation. If the number of results is larger than the number that you specify in this parameter, the response includes a NextToken element, which you can use to obtain additional results.

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

domain_deliverability_campaigns

An array of responses, one for each campaign that used the domain to send email during the specified time range.

STRUCT(
"campaign_id" VARCHAR,
"image_url" VARCHAR,
"subject" VARCHAR,
"from_address" VARCHAR,
"sending_ips" VARCHAR[],
"first_seen_date_time" TIMESTAMP_S,
"last_seen_date_time" TIMESTAMP_S,
"inbox_count" BIGINT,
"spam_count" BIGINT,
"read_rate" DOUBLE,
"delete_rate" DOUBLE,
"read_delete_rate" DOUBLE,
"projected_volume" BIGINT,
"esps" VARCHAR[]
)[]
Show child fields
domain_deliverability_campaigns[]
Show child fields
domain_deliverability_campaigns[].campaign_id

The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this identifier to a campaign. This value is not the same as the campaign identifier that Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the Amazon Pinpoint console.

domain_deliverability_campaigns[].delete_rate

The percentage of email messages that were deleted by recipients, without being opened first. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.

domain_deliverability_campaigns[].esps[]
domain_deliverability_campaigns[].first_seen_date_time

The first time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.

domain_deliverability_campaigns[].from_address

The verified email address that the email message was sent from.

domain_deliverability_campaigns[].image_url

The URL of an image that contains a snapshot of the email message that was sent.

domain_deliverability_campaigns[].inbox_count

The number of email messages that were delivered to recipients’ inboxes.

domain_deliverability_campaigns[].last_seen_date_time

The last time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.

domain_deliverability_campaigns[].projected_volume

The projected number of recipients that the email message was sent to.

domain_deliverability_campaigns[].read_delete_rate

The percentage of email messages that were opened and then deleted by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.

domain_deliverability_campaigns[].read_rate

The percentage of email messages that were opened by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.

domain_deliverability_campaigns[].sending_ips[]
domain_deliverability_campaigns[].spam_count

The number of email messages that were delivered to recipients' spam or junk mail folders.

domain_deliverability_campaigns[].subject

The subject line, or title, of the email message.