- 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.
PutConfigurationSetSendingOptionsCommand
Enable or disable email sending for messages that use a particular configuration set in a specific Amazon Web Services Region.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { SESv2Client, PutConfigurationSetSendingOptionsCommand } from "@aws-sdk/client-sesv2"; // ES Modules import
// const { SESv2Client, PutConfigurationSetSendingOptionsCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import
const client = new SESv2Client(config);
const input = { // PutConfigurationSetSendingOptionsRequest
ConfigurationSetName: "STRING_VALUE", // required
SendingEnabled: true || false,
};
const command = new PutConfigurationSetSendingOptionsCommand(input);
const response = await client.send(command);
// {};
PutConfigurationSetSendingOptionsCommand Input
See PutConfigurationSetSendingOptionsCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
ConfigurationSetNameRequired | string | undefined | The name of the configuration set to enable or disable email sending for. |
SendingEnabled | boolean | undefined | If |
PutConfigurationSetSendingOptionsCommand Output
See PutConfigurationSetSendingOptionsCommandOutput 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. |