domain_deliverability_campaigns

Creates, updates, deletes, gets or lists a domain_deliverability_campaigns resource.

Overview

Name	domain_deliverability_campaigns
Type	Resource
Id	aws.pinpoint_email.domain_deliverability_campaigns

Fields

The following fields are returned by SELECT queries:

list_domain_deliverability_campaigns

Name	Datatype	Description
domain_deliverability_campaigns	array	An array of responses, one for each campaign that used the domain to send email during the specified time range.
next_token	string	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.

get_domain_deliverability_campaign

Name	Datatype	Description
campaign_id	string	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.
delete_rate	number (double)	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.
esps	array	The major email providers who handled the email message.
first_seen_date_time	string (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.
from_address	string	The verified email address that the email message was sent from.
image_url	string	The URL of an image that contains a snapshot of the email message that was sent.
inbox_count	integer (int64)	The number of email messages that were delivered to recipients’ inboxes.
last_seen_date_time	string (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.
projected_volume	integer (int64)	The projected number of recipients that the email message was sent to.
read_delete_rate	number (double)	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.
read_rate	number (double)	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.
sending_ips	array	The IP addresses that were used to send the email message.
spam_count	integer (int64)	The number of email messages that were delivered to recipients' spam or junk mail folders.
subject	string	The subject line, or title, of the email message.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_domain_deliverability_campaigns	select	StartDate, EndDate, subscribed_domain, region	NextToken, PageSize	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.
get_domain_deliverability_campaign	select	campaign_id, region		Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption operation).

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
EndDate	string (date-time)	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.
StartDate	string (date-time)	The first day, in Unix time format, that you want to obtain deliverability data for.
campaign_id	string	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.
region	string	AWS region (default: us-east-1)
subscribed_domain	string	The domain to obtain deliverability data for.
NextToken	string	A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of a campaign in the list of campaigns.
PageSize	integer	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.

SELECT examples

list_domain_deliverability_campaigns

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.

SELECT
domain_deliverability_campaigns,
next_token
FROM aws.pinpoint_email.domain_deliverability_campaigns
WHERE StartDate = '{{ StartDate }}' -- required
AND EndDate = '{{ EndDate }}' -- required
AND subscribed_domain = '{{ subscribed_domain }}' -- required
AND region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
AND PageSize = '{{ PageSize }}'
;

get_domain_deliverability_campaign

Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption operation).

SELECT
campaign_id,
delete_rate,
esps,
first_seen_date_time,
from_address,
image_url,
inbox_count,
last_seen_date_time,
projected_volume,
read_delete_rate,
read_rate,
sending_ips,
spam_count,
subject
FROM aws.pinpoint_email.domain_deliverability_campaigns
WHERE campaign_id = '{{ campaign_id }}' -- required
AND region = '{{ region }}' -- required
;