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.GetDeliverabilityTestReport

Description

Retrieve the results of a predictive inbox placement test.

Synopsis

Creating a Request

data GetDeliverabilityTestReport Source #

A request to retrieve the results of a predictive inbox placement test.

See: newGetDeliverabilityTestReport smart constructor.

Constructors

GetDeliverabilityTestReport' 

Fields

  • reportId :: Text

    A unique string that identifies the predictive inbox placement test.

Instances

Instances details
Eq GetDeliverabilityTestReport Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityTestReport

Read GetDeliverabilityTestReport Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityTestReport

Show GetDeliverabilityTestReport Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityTestReport

Generic GetDeliverabilityTestReport Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityTestReport

Associated Types

type Rep GetDeliverabilityTestReport :: Type -> Type #

NFData GetDeliverabilityTestReport Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityTestReport

Hashable GetDeliverabilityTestReport Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityTestReport

AWSRequest GetDeliverabilityTestReport Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityTestReport

ToHeaders GetDeliverabilityTestReport Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityTestReport

ToPath GetDeliverabilityTestReport Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityTestReport

ToQuery GetDeliverabilityTestReport Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityTestReport

type Rep GetDeliverabilityTestReport Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityTestReport

type Rep GetDeliverabilityTestReport = D1 ('MetaData "GetDeliverabilityTestReport" "Amazonka.PinpointEmail.GetDeliverabilityTestReport" "libZSservicesZSamazonka-pinpoint-emailZSamazonka-pinpoint-email" 'False) (C1 ('MetaCons "GetDeliverabilityTestReport'" 'PrefixI 'True) (S1 ('MetaSel ('Just "reportId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetDeliverabilityTestReport Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityTestReport

newGetDeliverabilityTestReport Source #

Create a value of GetDeliverabilityTestReport 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:reportId:GetDeliverabilityTestReport', getDeliverabilityTestReport_reportId - A unique string that identifies the predictive inbox placement test.

Request Lenses

getDeliverabilityTestReport_reportId :: Lens' GetDeliverabilityTestReport Text Source #

A unique string that identifies the predictive inbox placement test.

Destructuring the Response

data GetDeliverabilityTestReportResponse Source #

The results of the predictive inbox placement test.

See: newGetDeliverabilityTestReportResponse smart constructor.

Constructors

GetDeliverabilityTestReportResponse' 

Fields

  • message :: Maybe Text

    An object that contains the message that you sent when you performed this predictive inbox placement test.

  • tags :: Maybe [Tag]

    An array of objects that define the tags (keys and values) that are associated with the predictive inbox placement test.

  • httpStatus :: Int

    The response's http status code.

  • deliverabilityTestReport :: DeliverabilityTestReport

    An object that contains the results of the predictive inbox placement test.

  • overallPlacement :: PlacementStatistics

    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.

  • ispPlacements :: [IspPlacement]

    An object that describes how the test email was handled by several email providers, including Gmail, Hotmail, Yahoo, AOL, and others.

Instances

Instances details
Eq GetDeliverabilityTestReportResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityTestReport

Read GetDeliverabilityTestReportResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityTestReport

Show GetDeliverabilityTestReportResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityTestReport

Generic GetDeliverabilityTestReportResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityTestReport

NFData GetDeliverabilityTestReportResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityTestReport

type Rep GetDeliverabilityTestReportResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityTestReport

type Rep GetDeliverabilityTestReportResponse = D1 ('MetaData "GetDeliverabilityTestReportResponse" "Amazonka.PinpointEmail.GetDeliverabilityTestReport" "libZSservicesZSamazonka-pinpoint-emailZSamazonka-pinpoint-email" 'False) (C1 ('MetaCons "GetDeliverabilityTestReportResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) :*: (S1 ('MetaSel ('Just "deliverabilityTestReport") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeliverabilityTestReport) :*: (S1 ('MetaSel ('Just "overallPlacement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PlacementStatistics) :*: S1 ('MetaSel ('Just "ispPlacements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [IspPlacement])))))

newGetDeliverabilityTestReportResponse Source #

Create a value of GetDeliverabilityTestReportResponse 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:message:GetDeliverabilityTestReportResponse', getDeliverabilityTestReportResponse_message - An object that contains the message that you sent when you performed this predictive inbox placement test.

$sel:tags:GetDeliverabilityTestReportResponse', getDeliverabilityTestReportResponse_tags - An array of objects that define the tags (keys and values) that are associated with the predictive inbox placement test.

$sel:httpStatus:GetDeliverabilityTestReportResponse', getDeliverabilityTestReportResponse_httpStatus - The response's http status code.

$sel:deliverabilityTestReport:GetDeliverabilityTestReportResponse', getDeliverabilityTestReportResponse_deliverabilityTestReport - An object that contains the results of the predictive inbox placement test.

$sel:overallPlacement:GetDeliverabilityTestReportResponse', getDeliverabilityTestReportResponse_overallPlacement - 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.

$sel:ispPlacements:GetDeliverabilityTestReportResponse', getDeliverabilityTestReportResponse_ispPlacements - An object that describes how the test email was handled by several email providers, including Gmail, Hotmail, Yahoo, AOL, and others.

Response Lenses

getDeliverabilityTestReportResponse_message :: Lens' GetDeliverabilityTestReportResponse (Maybe Text) Source #

An object that contains the message that you sent when you performed this predictive inbox placement test.

getDeliverabilityTestReportResponse_tags :: Lens' GetDeliverabilityTestReportResponse (Maybe [Tag]) Source #

An array of objects that define the tags (keys and values) that are associated with the predictive inbox placement test.

getDeliverabilityTestReportResponse_overallPlacement :: Lens' GetDeliverabilityTestReportResponse PlacementStatistics Source #

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.

getDeliverabilityTestReportResponse_ispPlacements :: Lens' GetDeliverabilityTestReportResponse [IspPlacement] Source #

An object that describes how the test email was handled by several email providers, including Gmail, Hotmail, Yahoo, AOL, and others.