| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.PinpointEmail.GetDeliverabilityTestReport
Description
Retrieve the results of a predictive inbox placement test.
Synopsis
- data GetDeliverabilityTestReport = GetDeliverabilityTestReport' {}
- newGetDeliverabilityTestReport :: Text -> GetDeliverabilityTestReport
- getDeliverabilityTestReport_reportId :: Lens' GetDeliverabilityTestReport Text
- data GetDeliverabilityTestReportResponse = GetDeliverabilityTestReportResponse' {}
- newGetDeliverabilityTestReportResponse :: Int -> DeliverabilityTestReport -> PlacementStatistics -> GetDeliverabilityTestReportResponse
- getDeliverabilityTestReportResponse_message :: Lens' GetDeliverabilityTestReportResponse (Maybe Text)
- getDeliverabilityTestReportResponse_tags :: Lens' GetDeliverabilityTestReportResponse (Maybe [Tag])
- getDeliverabilityTestReportResponse_httpStatus :: Lens' GetDeliverabilityTestReportResponse Int
- getDeliverabilityTestReportResponse_deliverabilityTestReport :: Lens' GetDeliverabilityTestReportResponse DeliverabilityTestReport
- getDeliverabilityTestReportResponse_overallPlacement :: Lens' GetDeliverabilityTestReportResponse PlacementStatistics
- getDeliverabilityTestReportResponse_ispPlacements :: Lens' GetDeliverabilityTestReportResponse [IspPlacement]
Creating a Request
data GetDeliverabilityTestReport Source #
A request to retrieve the results of a predictive inbox placement test.
See: newGetDeliverabilityTestReport smart constructor.
Constructors
| GetDeliverabilityTestReport' | |
Instances
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
| |
Instances
newGetDeliverabilityTestReportResponse Source #
Arguments
| :: Int | |
| -> DeliverabilityTestReport |
|
| -> PlacementStatistics | |
| -> GetDeliverabilityTestReportResponse |
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_httpStatus :: Lens' GetDeliverabilityTestReportResponse Int Source #
The response's http status code.
getDeliverabilityTestReportResponse_deliverabilityTestReport :: Lens' GetDeliverabilityTestReportResponse DeliverabilityTestReport Source #
An object that contains the results of 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.