Class ListDomainDeliverabilityCampaignsCommandProtected

Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard (PutDeliverabilityDashboardOption operation) for the domain.

Example

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

import { PinpointEmailClient, ListDomainDeliverabilityCampaignsCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import
// const { PinpointEmailClient, ListDomainDeliverabilityCampaignsCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import
const client = new PinpointEmailClient(config);
const input = { // ListDomainDeliverabilityCampaignsRequest
  StartDate: new Date("TIMESTAMP"), // required
  EndDate: new Date("TIMESTAMP"), // required
  SubscribedDomain: "STRING_VALUE", // required
  NextToken: "STRING_VALUE",
  PageSize: Number("int"),
};
const command = new ListDomainDeliverabilityCampaignsCommand(input);
const response = await client.send(command);
// { // ListDomainDeliverabilityCampaignsResponse
//   DomainDeliverabilityCampaigns: [ // DomainDeliverabilityCampaignList // required
//     { // 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",
//       ],
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

Param

ListDomainDeliverabilityCampaignsCommandInput

Returns

ListDomainDeliverabilityCampaignsCommandOutput

See

• ListDomainDeliverabilityCampaignsCommandInput for command's input shape.
• ListDomainDeliverabilityCampaignsCommandOutput 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.