GetDeliverabilityDashboardOptionsCommand

Suggest an Edit

Retrieve information about the status of the Deliverability dashboard for your 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. 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 SES and other Amazon Web Services services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon SES Pricing .

Example Syntax

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

import { SESv2Client, GetDeliverabilityDashboardOptionsCommand } from "@aws-sdk/client-sesv2"; // ES Modules import
// const { SESv2Client, GetDeliverabilityDashboardOptionsCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import
const client = new SESv2Client(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",
//         ],
//       },
//     },
//   ],
// };

GetDeliverabilityDashboardOptionsCommand Input

See GetDeliverabilityDashboardOptionsCommandInput for more details
GetDeliverabilityDashboardOptionsCommandInput extends GetDeliverabilityDashboardOptionsRequest

GetDeliverabilityDashboardOptionsCommand Output

See GetDeliverabilityDashboardOptionsCommandOutput for details

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

Specifies whether the Deliverability dashboard is enabled. If this value is true, the dashboard is enabled.

AccountStatus
DeliverabilityDashboardAccountStatus | undefined

The current status of your Deliverability dashboard subscription. If this value is PENDING_EXPIRATION, your subscription is scheduled to expire at the end of the current calendar month.

ActiveSubscribedDomains
DomainDeliverabilityTrackingOption[] | undefined

An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that isn’t scheduled to expire at the end of the current calendar month.

PendingExpirationSubscribedDomains
DomainDeliverabilityTrackingOption[] | undefined

An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that's scheduled to expire at the end of the current calendar month.

SubscriptionExpiryDate
Date | undefined

The date when your current subscription to the Deliverability dashboard is scheduled to expire, if your subscription is scheduled to expire at the end of the current calendar month. This value is null if you have an active subscription that isn’t due to expire at the end of the month.

Throws

Name
Fault
Details
BadRequestException
client

The input you provided is invalid.

LimitExceededException
client

There are too many instances of the specified resource type.

TooManyRequestsException
client

Too many requests have been made to the operation.

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