Class GetDeliverabilityDashboardOptionsCommandProtected

Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.

When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.

Example

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

import { PinpointEmailClient, GetDeliverabilityDashboardOptionsCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import
// const { PinpointEmailClient, GetDeliverabilityDashboardOptionsCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import
const client = new PinpointEmailClient(config);
const input = {};
const command = new GetDeliverabilityDashboardOptionsCommand(input);
const response = await client.send(command);
// { // GetDeliverabilityDashboardOptionsResponse
//   DashboardEnabled: true || false, // required
//   SubscriptionExpiryDate: new Date("TIMESTAMP"),
//   AccountStatus: "ACTIVE" || "PENDING_EXPIRATION" || "DISABLED",
//   ActiveSubscribedDomains: [ // DomainDeliverabilityTrackingOptions
//     { // DomainDeliverabilityTrackingOption
//       Domain: "STRING_VALUE",
//       SubscriptionStartDate: new Date("TIMESTAMP"),
//       InboxPlacementTrackingOption: { // InboxPlacementTrackingOption
//         Global: true || false,
//         TrackedIsps: [ // IspNameList
//           "STRING_VALUE",
//         ],
//       },
//     },
//   ],
//   PendingExpirationSubscribedDomains: [
//     {
//       Domain: "STRING_VALUE",
//       SubscriptionStartDate: new Date("TIMESTAMP"),
//       InboxPlacementTrackingOption: {
//         Global: true || false,
//         TrackedIsps: [
//           "STRING_VALUE",
//         ],
//       },
//     },
//   ],
// };

Param

GetDeliverabilityDashboardOptionsCommandInput

Returns

GetDeliverabilityDashboardOptionsCommandOutput

See

• GetDeliverabilityDashboardOptionsCommandInput for command's input shape.
• GetDeliverabilityDashboardOptionsCommandOutput for command's response shape.
• config for PinpointEmailClient's config shape.

Throws

BadRequestException (client fault)

The input you provided is invalid.

Throws

LimitExceededException (client fault)

There are too many instances of the specified resource type.

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.