- 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.
PutConfigurationSetSuppressionOptionsCommand
Specify the account suppression list preferences for a configuration set.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { SESv2Client, PutConfigurationSetSuppressionOptionsCommand } from "@aws-sdk/client-sesv2"; // ES Modules import
// const { SESv2Client, PutConfigurationSetSuppressionOptionsCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import
const client = new SESv2Client(config);
const input = { // PutConfigurationSetSuppressionOptionsRequest
ConfigurationSetName: "STRING_VALUE", // required
SuppressedReasons: [ // SuppressionListReasons
"BOUNCE" || "COMPLAINT",
],
};
const command = new PutConfigurationSetSuppressionOptionsCommand(input);
const response = await client.send(command);
// {};
PutConfigurationSetSuppressionOptionsCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
ConfigurationSetNameRequired | string | undefined | The name of the configuration set to change the suppression list preferences for. |
SuppressedReasons | SuppressionListReason[] | undefined | A list that contains the reasons that email addresses are automatically added to the suppression list for your account. This list can contain any or all of the following:
|
PutConfigurationSetSuppressionOptionsCommand Output
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. |