Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateDeliverabilityTestReport

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.

Request Syntax


POST /v1/email/deliverability-dashboard/test HTTP/1.1
Content-type: application/json

{
   "Content": { 
      "Raw": { 
         "Data": blob
      },
      "Simple": { 
         "Body": { 
            "Html": { 
               "Charset": "string",
               "Data": "string"
            },
            "Text": { 
               "Charset": "string",
               "Data": "string"
            }
         },
         "Subject": { 
            "Charset": "string",
            "Data": "string"
         }
      },
      "Template": { 
         "TemplateArn": "string",
         "TemplateData": "string"
      }
   },
   "FromEmailAddress": "string",
   "ReportName": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Content

The HTML body of the message that you sent when you performed the predictive inbox placement test.

Type: EmailContent object

Required: Yes

FromEmailAddress

The email address that the predictive inbox placement test email was sent from.

Type: String

Required: Yes

ReportName

A unique name that helps you to identify the predictive inbox placement test when you retrieve the results.

Type: String

Required: No

Tags

An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.

Type: Array of Tag objects

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "DeliverabilityTestStatus": "string",
   "ReportId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DeliverabilityTestStatus

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.

Type: String

Valid Values: IN_PROGRESS | COMPLETED

ReportId

A unique string that identifies the predictive inbox placement test.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccountSuspendedException

The message can't be sent because the account's ability to send email has been permanently restricted.

HTTP Status Code: 400

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

ConcurrentModificationException

The resource is being modified by another operation or thread.

HTTP Status Code: 500

LimitExceededException

There are too many instances of the specified resource type.

HTTP Status Code: 400

MailFromDomainNotVerifiedException

The message can't be sent because the sending domain isn't verified.

HTTP Status Code: 400

MessageRejected

The message can't be sent because it contains invalid content.

HTTP Status Code: 400

NotFoundException

The resource you attempted to access doesn't exist.

HTTP Status Code: 404

SendingPausedException

The message can't be sent because the account's ability to send email is currently paused.

HTTP Status Code: 400

TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429