amazonka-pinpoint-email-2.0: Amazon Pinpoint Email Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.PinpointEmail.Types.DeliverabilityTestReport

Description

 
Synopsis

Documentation

data DeliverabilityTestReport Source #

An object that contains metadata related to a predictive inbox placement test.

See: newDeliverabilityTestReport smart constructor.

Constructors

DeliverabilityTestReport' 

Fields

  • createDate :: Maybe POSIX

    The date and time when the predictive inbox placement test was created, in Unix time format.

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

  • fromEmailAddress :: Maybe Text

    The sender address that you specified for the predictive inbox placement test.

  • reportId :: Maybe Text

    A unique string that identifies the predictive inbox placement test.

  • reportName :: Maybe Text

    A name that helps you identify a predictive inbox placement test report.

  • subject :: Maybe Text

    The subject line for an email that you submitted in a predictive inbox placement test.

Instances

Instances details
FromJSON DeliverabilityTestReport Source # 
Instance details

Defined in Amazonka.PinpointEmail.Types.DeliverabilityTestReport

Generic DeliverabilityTestReport Source # 
Instance details

Defined in Amazonka.PinpointEmail.Types.DeliverabilityTestReport

Associated Types

type Rep DeliverabilityTestReport :: Type -> Type #

Read DeliverabilityTestReport Source # 
Instance details

Defined in Amazonka.PinpointEmail.Types.DeliverabilityTestReport

Show DeliverabilityTestReport Source # 
Instance details

Defined in Amazonka.PinpointEmail.Types.DeliverabilityTestReport

NFData DeliverabilityTestReport Source # 
Instance details

Defined in Amazonka.PinpointEmail.Types.DeliverabilityTestReport

Eq DeliverabilityTestReport Source # 
Instance details

Defined in Amazonka.PinpointEmail.Types.DeliverabilityTestReport

Hashable DeliverabilityTestReport Source # 
Instance details

Defined in Amazonka.PinpointEmail.Types.DeliverabilityTestReport

type Rep DeliverabilityTestReport Source # 
Instance details

Defined in Amazonka.PinpointEmail.Types.DeliverabilityTestReport

type Rep DeliverabilityTestReport = D1 ('MetaData "DeliverabilityTestReport" "Amazonka.PinpointEmail.Types.DeliverabilityTestReport" "amazonka-pinpoint-email-2.0-EgVsRBIHQXMGA9Xbyu2BvI" 'False) (C1 ('MetaCons "DeliverabilityTestReport'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "createDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "deliverabilityTestStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeliverabilityTestStatus)) :*: S1 ('MetaSel ('Just "fromEmailAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "reportId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "reportName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "subject") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDeliverabilityTestReport :: DeliverabilityTestReport Source #

Create a value of DeliverabilityTestReport 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:createDate:DeliverabilityTestReport', deliverabilityTestReport_createDate - The date and time when the predictive inbox placement test was created, in Unix time format.

$sel:deliverabilityTestStatus:DeliverabilityTestReport', deliverabilityTestReport_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.

$sel:fromEmailAddress:DeliverabilityTestReport', deliverabilityTestReport_fromEmailAddress - The sender address that you specified for the predictive inbox placement test.

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

$sel:reportName:DeliverabilityTestReport', deliverabilityTestReport_reportName - A name that helps you identify a predictive inbox placement test report.

$sel:subject:DeliverabilityTestReport', deliverabilityTestReport_subject - The subject line for an email that you submitted in a predictive inbox placement test.

deliverabilityTestReport_createDate :: Lens' DeliverabilityTestReport (Maybe UTCTime) Source #

The date and time when the predictive inbox placement test was created, in Unix time format.

deliverabilityTestReport_deliverabilityTestStatus :: Lens' DeliverabilityTestReport (Maybe 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.

deliverabilityTestReport_fromEmailAddress :: Lens' DeliverabilityTestReport (Maybe Text) Source #

The sender address that you specified for the predictive inbox placement test.

deliverabilityTestReport_reportId :: Lens' DeliverabilityTestReport (Maybe Text) Source #

A unique string that identifies the predictive inbox placement test.

deliverabilityTestReport_reportName :: Lens' DeliverabilityTestReport (Maybe Text) Source #

A name that helps you identify a predictive inbox placement test report.

deliverabilityTestReport_subject :: Lens' DeliverabilityTestReport (Maybe Text) Source #

The subject line for an email that you submitted in a predictive inbox placement test.