deliverability_test_reports

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

Overview

Name	deliverability_test_reports
Type	Resource
Id	aws.pinpoint_email.deliverability_test_reports

Fields

The following fields are returned by SELECT queries:

get_deliverability_test_report

Name	Datatype	Description
deliverability_test_report	object	An object that contains the results of the predictive inbox placement test.
isp_placements	array	An object that describes how the test email was handled by several email providers, including Gmail, Hotmail, Yahoo, AOL, and others.
message	string	An object that contains the message that you sent when you performed this predictive inbox placement test.
overall_placement	object	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.
tags	array	An array of objects that define the tags (keys and values) that are associated with the predictive inbox placement test.

list_deliverability_test_reports

Name	Datatype	Description
create_date	string (date-time)	The date and time when the predictive inbox placement test was created, in Unix time format.
deliverability_test_status	string	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. (IN_PROGRESS, COMPLETED)
from_email_address	string	The sender address that you specified for the predictive inbox placement test.
report_id	string	A unique string that identifies a Deliverability dashboard report.
report_name	string	A name that helps you identify a report generated by the Deliverability dashboard.
subject	string	The subject line for an email that you submitted in a predictive inbox placement test.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_deliverability_test_report	select	report_id, region		Retrieve the results of a predictive inbox placement test.
list_deliverability_test_reports	select	region	NextToken, PageSize	Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For predictive inbox placement tests that are complete, you can use the GetDeliverabilityTestReport operation to view the results.
create_deliverability_test_report	insert	region, FromEmailAddress, Content		Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. Amazon Pinpoint then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use the GetDeliverabilityTestReport operation to view the results of the test.

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
region	string	AWS region (default: us-east-1)
report_id	string	A unique string that identifies the predictive inbox placement test.
NextToken	string	A token returned from a previous call to ListDeliverabilityTestReports to indicate the position in the list of predictive inbox placement tests.
PageSize	integer	The number of results to show in a single call to ListDeliverabilityTestReports. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results. The value you specify has to be at least 0, and can be no more than 1000.

SELECT examples

get_deliverability_test_report

Retrieve the results of a predictive inbox placement test.

SELECT
deliverability_test_report,
isp_placements,
message,
overall_placement,
tags
FROM aws.pinpoint_email.deliverability_test_reports
WHERE report_id = '{{ report_id }}' -- required
AND region = '{{ region }}' -- required
;

list_deliverability_test_reports

Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For predictive inbox placement tests that are complete, you can use the GetDeliverabilityTestReport operation to view the results.

SELECT
create_date,
deliverability_test_status,
from_email_address,
report_id,
report_name,
subject
FROM aws.pinpoint_email.deliverability_test_reports
WHERE region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
AND PageSize = '{{ PageSize }}'
;

INSERT examples

create_deliverability_test_report

Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. Amazon Pinpoint then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use the GetDeliverabilityTestReport operation to view the results of the test.

INSERT INTO aws.pinpoint_email.deliverability_test_reports (
ReportName,
FromEmailAddress,
Content,
Tags,
region
)
SELECT 
'{{ ReportName }}',
'{{ FromEmailAddress }}' /* required */,
'{{ Content }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
deliverability_test_status,
report_id
;

Manifest

# Description fields are for documentation purposes
- name: deliverability_test_reports
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the deliverability_test_reports resource.
  - name: ReportName
    value: "{{ ReportName }}"
    description: |
      A name that helps you identify a report generated by the Deliverability dashboard.
  - name: FromEmailAddress
    value: "{{ FromEmailAddress }}"
  - name: Content
    description: |
      An object that defines the entire content of the email, including the message headers and the body content. You can create a simple email message, in which you specify the subject and the text and HTML versions of the message body. You can also create raw messages, in which you specify a complete MIME-formatted message. Raw messages can include attachments and custom headers.
    value:
      Simple:
        Subject:
          Data: "{{ Data }}"
          Charset: "{{ Charset }}"
        Body:
          Text:
            Data: "{{ Data }}"
            Charset: "{{ Charset }}"
          Html:
            Data: "{{ Data }}"
            Charset: "{{ Charset }}"
      Raw:
        Data: "{{ Data }}"
      Template:
        TemplateArn: "{{ TemplateArn }}"
        TemplateData: "{{ TemplateData }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"