libZSservicesZSamazonka-pinpoint-emailZSamazonka-pinpoint-email
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.PinpointEmail.CreateDeliverabilityTestReport

Description

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.

Synopsis

Creating a Request

data CreateDeliverabilityTestReport Source #

A request to perform a 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.

See: newCreateDeliverabilityTestReport smart constructor.

Constructors

CreateDeliverabilityTestReport' 

Fields

  • reportName :: Maybe Text

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

  • tags :: Maybe [Tag]

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

  • fromEmailAddress :: Text

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

  • content :: EmailContent

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

Instances

Instances details
Eq CreateDeliverabilityTestReport Source # 
Instance details

Defined in Amazonka.PinpointEmail.CreateDeliverabilityTestReport

Read CreateDeliverabilityTestReport Source # 
Instance details

Defined in Amazonka.PinpointEmail.CreateDeliverabilityTestReport

Show CreateDeliverabilityTestReport Source # 
Instance details

Defined in Amazonka.PinpointEmail.CreateDeliverabilityTestReport

Generic CreateDeliverabilityTestReport Source # 
Instance details

Defined in Amazonka.PinpointEmail.CreateDeliverabilityTestReport

Associated Types

type Rep CreateDeliverabilityTestReport :: Type -> Type #

NFData CreateDeliverabilityTestReport Source # 
Instance details

Defined in Amazonka.PinpointEmail.CreateDeliverabilityTestReport

Hashable CreateDeliverabilityTestReport Source # 
Instance details

Defined in Amazonka.PinpointEmail.CreateDeliverabilityTestReport

ToJSON CreateDeliverabilityTestReport Source # 
Instance details

Defined in Amazonka.PinpointEmail.CreateDeliverabilityTestReport

AWSRequest CreateDeliverabilityTestReport Source # 
Instance details

Defined in Amazonka.PinpointEmail.CreateDeliverabilityTestReport

ToHeaders CreateDeliverabilityTestReport Source # 
Instance details

Defined in Amazonka.PinpointEmail.CreateDeliverabilityTestReport

ToPath CreateDeliverabilityTestReport Source # 
Instance details

Defined in Amazonka.PinpointEmail.CreateDeliverabilityTestReport

ToQuery CreateDeliverabilityTestReport Source # 
Instance details

Defined in Amazonka.PinpointEmail.CreateDeliverabilityTestReport

type Rep CreateDeliverabilityTestReport Source # 
Instance details

Defined in Amazonka.PinpointEmail.CreateDeliverabilityTestReport

type Rep CreateDeliverabilityTestReport = D1 ('MetaData "CreateDeliverabilityTestReport" "Amazonka.PinpointEmail.CreateDeliverabilityTestReport" "libZSservicesZSamazonka-pinpoint-emailZSamazonka-pinpoint-email" 'False) (C1 ('MetaCons "CreateDeliverabilityTestReport'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "reportName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :*: (S1 ('MetaSel ('Just "fromEmailAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EmailContent))))
type AWSResponse CreateDeliverabilityTestReport Source # 
Instance details

Defined in Amazonka.PinpointEmail.CreateDeliverabilityTestReport

newCreateDeliverabilityTestReport Source #

Create a value of CreateDeliverabilityTestReport with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:reportName:CreateDeliverabilityTestReport', createDeliverabilityTestReport_reportName - A unique name that helps you to identify the predictive inbox placement test when you retrieve the results.

$sel:tags:CreateDeliverabilityTestReport', createDeliverabilityTestReport_tags - An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.

$sel:fromEmailAddress:CreateDeliverabilityTestReport', createDeliverabilityTestReport_fromEmailAddress - The email address that the predictive inbox placement test email was sent from.

$sel:content:CreateDeliverabilityTestReport', createDeliverabilityTestReport_content - The HTML body of the message that you sent when you performed the predictive inbox placement test.

Request Lenses

createDeliverabilityTestReport_reportName :: Lens' CreateDeliverabilityTestReport (Maybe Text) Source #

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

createDeliverabilityTestReport_tags :: Lens' CreateDeliverabilityTestReport (Maybe [Tag]) Source #

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

createDeliverabilityTestReport_fromEmailAddress :: Lens' CreateDeliverabilityTestReport Text Source #

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

createDeliverabilityTestReport_content :: Lens' CreateDeliverabilityTestReport EmailContent Source #

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

Destructuring the Response

data CreateDeliverabilityTestReportResponse Source #

Information about the predictive inbox placement test that you created.

See: newCreateDeliverabilityTestReportResponse smart constructor.

Constructors

CreateDeliverabilityTestReportResponse' 

Fields

  • httpStatus :: Int

    The response's http status code.

  • reportId :: Text

    A unique string that identifies the predictive inbox placement test.

  • deliverabilityTestStatus :: 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.

Instances

Instances details
Eq CreateDeliverabilityTestReportResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.CreateDeliverabilityTestReport

Read CreateDeliverabilityTestReportResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.CreateDeliverabilityTestReport

Show CreateDeliverabilityTestReportResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.CreateDeliverabilityTestReport

Generic CreateDeliverabilityTestReportResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.CreateDeliverabilityTestReport

NFData CreateDeliverabilityTestReportResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.CreateDeliverabilityTestReport

type Rep CreateDeliverabilityTestReportResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.CreateDeliverabilityTestReport

type Rep CreateDeliverabilityTestReportResponse = D1 ('MetaData "CreateDeliverabilityTestReportResponse" "Amazonka.PinpointEmail.CreateDeliverabilityTestReport" "libZSservicesZSamazonka-pinpoint-emailZSamazonka-pinpoint-email" 'False) (C1 ('MetaCons "CreateDeliverabilityTestReportResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "reportId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "deliverabilityTestStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeliverabilityTestStatus))))

newCreateDeliverabilityTestReportResponse Source #

Create a value of CreateDeliverabilityTestReportResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:CreateDeliverabilityTestReportResponse', createDeliverabilityTestReportResponse_httpStatus - The response's http status code.

$sel:reportId:CreateDeliverabilityTestReportResponse', createDeliverabilityTestReportResponse_reportId - A unique string that identifies the predictive inbox placement test.

$sel:deliverabilityTestStatus:CreateDeliverabilityTestReportResponse', createDeliverabilityTestReportResponse_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.

Response Lenses

createDeliverabilityTestReportResponse_reportId :: Lens' CreateDeliverabilityTestReportResponse Text Source #

A unique string that identifies the predictive inbox placement test.

createDeliverabilityTestReportResponse_deliverabilityTestStatus :: Lens' CreateDeliverabilityTestReportResponse DeliverabilityTestStatus Source #

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.