- 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.
DeleteReceiptRuleSetCommand
Deletes the specified receipt rule set and all of the receipt rules it contains.
The currently active rule set cannot be deleted.
For information about managing receipt rule sets, see the Amazon SES Developer Guide .
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 { SESClient, DeleteReceiptRuleSetCommand } from "@aws-sdk/client-ses"; // ES Modules import
// const { SESClient, DeleteReceiptRuleSetCommand } = require("@aws-sdk/client-ses"); // CommonJS import
const client = new SESClient(config);
const input = { // DeleteReceiptRuleSetRequest
RuleSetName: "STRING_VALUE", // required
};
const command = new DeleteReceiptRuleSetCommand(input);
const response = await client.send(command);
// {};
Example Usage
Loading code editor
DeleteReceiptRuleSetCommand Input
See DeleteReceiptRuleSetCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
RuleSetName Required | string | undefined | The name of the receipt rule set to delete. |
DeleteReceiptRuleSetCommand Output
See DeleteReceiptRuleSetCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
CannotDeleteException | client | Indicates that the delete operation could not be completed. |
SESServiceException | Base exception class for all service exceptions from SES service. |