Class GetDomainDeliverabilityCampaignCommandProtected

Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption operation).

Example

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

import { PinpointEmailClient, GetDomainDeliverabilityCampaignCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import
// const { PinpointEmailClient, GetDomainDeliverabilityCampaignCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import
const client = new PinpointEmailClient(config);
const input = { // GetDomainDeliverabilityCampaignRequest
  CampaignId: "STRING_VALUE", // required
};
const command = new GetDomainDeliverabilityCampaignCommand(input);
const response = await client.send(command);
// { // GetDomainDeliverabilityCampaignResponse
//   DomainDeliverabilityCampaign: { // DomainDeliverabilityCampaign
//     CampaignId: "STRING_VALUE",
//     ImageUrl: "STRING_VALUE",
//     Subject: "STRING_VALUE",
//     FromAddress: "STRING_VALUE",
//     SendingIps: [ // IpList
//       "STRING_VALUE",
//     ],
//     FirstSeenDateTime: new Date("TIMESTAMP"),
//     LastSeenDateTime: new Date("TIMESTAMP"),
//     InboxCount: Number("long"),
//     SpamCount: Number("long"),
//     ReadRate: Number("double"),
//     DeleteRate: Number("double"),
//     ReadDeleteRate: Number("double"),
//     ProjectedVolume: Number("long"),
//     Esps: [ // Esps
//       "STRING_VALUE",
//     ],
//   },
// };

Param

GetDomainDeliverabilityCampaignCommandInput

Returns

GetDomainDeliverabilityCampaignCommandOutput

See

• GetDomainDeliverabilityCampaignCommandInput for command's input shape.
• GetDomainDeliverabilityCampaignCommandOutput for command's response shape.
• config for PinpointEmailClient's config shape.

Throws

BadRequestException (client fault)

The input you provided is invalid.

Throws

NotFoundException (client fault)

The resource you attempted to access doesn't exist.

Throws

TooManyRequestsException (client fault)

Too many requests have been made to the operation.

Throws

PinpointEmailServiceException

Base exception class for all service exceptions from PinpointEmail service.