GetDeliverabilityTestReportCommand

Retrieve the results of a predictive inbox placement test.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SESv2Client, GetDeliverabilityTestReportCommand } from "@aws-sdk/client-sesv2"; // ES Modules import
// const { SESv2Client, GetDeliverabilityTestReportCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import
const client = new SESv2Client(config);
const input = { // GetDeliverabilityTestReportRequest
  ReportId: "STRING_VALUE", // required
};
const command = new GetDeliverabilityTestReportCommand(input);
const response = await client.send(command);
// { // GetDeliverabilityTestReportResponse
//   DeliverabilityTestReport: { // DeliverabilityTestReport
//     ReportId: "STRING_VALUE",
//     ReportName: "STRING_VALUE",
//     Subject: "STRING_VALUE",
//     FromEmailAddress: "STRING_VALUE",
//     CreateDate: new Date("TIMESTAMP"),
//     DeliverabilityTestStatus: "IN_PROGRESS" || "COMPLETED",
//   },
//   OverallPlacement: { // PlacementStatistics
//     InboxPercentage: Number("double"),
//     SpamPercentage: Number("double"),
//     MissingPercentage: Number("double"),
//     SpfPercentage: Number("double"),
//     DkimPercentage: Number("double"),
//   },
//   IspPlacements: [ // IspPlacements // required
//     { // IspPlacement
//       IspName: "STRING_VALUE",
//       PlacementStatistics: {
//         InboxPercentage: Number("double"),
//         SpamPercentage: Number("double"),
//         MissingPercentage: Number("double"),
//         SpfPercentage: Number("double"),
//         DkimPercentage: Number("double"),
//       },
//     },
//   ],
//   Message: "STRING_VALUE",
//   Tags: [ // TagList
//     { // Tag
//       Key: "STRING_VALUE", // required
//       Value: "STRING_VALUE", // required
//     },
//   ],
// };

GetDeliverabilityTestReportCommand Input

Parameter
Type
Description
ReportId
Required
string | undefined

A unique string that identifies the predictive inbox placement test.

GetDeliverabilityTestReportCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
DeliverabilityTestReport
Required
DeliverabilityTestReport | undefined

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

IspPlacements
Required
IspPlacement[] | undefined

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

OverallPlacement
Required
PlacementStatistics | undefined

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.

Message
string | undefined

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

Tags
Tag[] | undefined

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

Throws

Name
Fault
Details
BadRequestException
client

The input you provided is invalid.

NotFoundException
client

The resource you attempted to access doesn't exist.

TooManyRequestsException
client

Too many requests have been made to the operation.

SESv2ServiceException
Base exception class for all service exceptions from SESv2 service.