GetDomainDeliverabilityCampaignCommand

Suggest an Edit

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 Syntax

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",
//     ],
//   },
// };

GetDomainDeliverabilityCampaignCommand Input

See GetDomainDeliverabilityCampaignCommandInput for more details

Parameter
Type
Description
CampaignId
Required
string | undefined

The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this identifier to a campaign. This value is not the same as the campaign identifier that Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the Amazon Pinpoint console.

GetDomainDeliverabilityCampaignCommand Output

See GetDomainDeliverabilityCampaignCommandOutput for details

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

An object that contains the deliverability data for the campaign.

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.

PinpointEmailServiceException
Base exception class for all service exceptions from PinpointEmail service.