- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
PutDeliverabilityDashboardOptionCommand
Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, 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, PutDeliverabilityDashboardOptionCommand } from "@aws-sdk/client-sesv2"; // ES Modules import
// const { SESv2Client, PutDeliverabilityDashboardOptionCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import
const client = new SESv2Client(config);
const input = { // PutDeliverabilityDashboardOptionRequest
DashboardEnabled: true || false, // required
SubscribedDomains: [ // DomainDeliverabilityTrackingOptions
{ // DomainDeliverabilityTrackingOption
Domain: "STRING_VALUE",
SubscriptionStartDate: new Date("TIMESTAMP"),
InboxPlacementTrackingOption: { // InboxPlacementTrackingOption
Global: true || false,
TrackedIsps: [ // IspNameList
"STRING_VALUE",
],
},
},
],
};
const command = new PutDeliverabilityDashboardOptionCommand(input);
const response = await client.send(command);
// {};
PutDeliverabilityDashboardOptionCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
DashboardEnabledRequired | boolean | undefined | Specifies whether to enable the Deliverability dashboard. To enable the dashboard, set this value to |
SubscribedDomains | DomainDeliverabilityTrackingOption[] | undefined | An array of objects, one for each verified domain that you use to send email and enabled the Deliverability dashboard for. |
PutDeliverabilityDashboardOptionCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AlreadyExistsException | client | The resource specified in your request already exists. |
| BadRequestException | client | The input you provided is invalid. |
| LimitExceededException | client | There are too many instances of the specified resource type. |
| NotFoundException | client | The resource you attempted to access doesn't exist. |
| TooManyRequestsException | client | Too many requests have been made to the operation. |
| SESv2ServiceException | Base exception class for all service exceptions from SESv2 service. |