- 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.
PutConfigurationSetVdmOptionsCommand
Specify VDM preferences for email that you send using the configuration set.
You can execute this operation no more than once per second.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { SESv2Client, PutConfigurationSetVdmOptionsCommand } from "@aws-sdk/client-sesv2"; // ES Modules import
// const { SESv2Client, PutConfigurationSetVdmOptionsCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import
const client = new SESv2Client(config);
const input = { // PutConfigurationSetVdmOptionsRequest
ConfigurationSetName: "STRING_VALUE", // required
VdmOptions: { // VdmOptions
DashboardOptions: { // DashboardOptions
EngagementMetrics: "ENABLED" || "DISABLED",
},
GuardianOptions: { // GuardianOptions
OptimizedSharedDelivery: "ENABLED" || "DISABLED",
},
},
};
const command = new PutConfigurationSetVdmOptionsCommand(input);
const response = await client.send(command);
// {};
PutConfigurationSetVdmOptionsCommand Input
See PutConfigurationSetVdmOptionsCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
ConfigurationSetNameRequired | string | undefined | The name of the configuration set. |
VdmOptions | VdmOptions | undefined | The VDM options to apply to the configuration set. |
PutConfigurationSetVdmOptionsCommand Output
See PutConfigurationSetVdmOptionsCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
|---|
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. |
| SESv2ServiceException | Base exception class for all service exceptions from SESv2 service. |