- 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.
DeleteReceiptRuleCommand
Deletes the specified receipt rule.
For information about managing receipt rules, 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, DeleteReceiptRuleCommand } from "@aws-sdk/client-ses"; // ES Modules import
// const { SESClient, DeleteReceiptRuleCommand } = require("@aws-sdk/client-ses"); // CommonJS import
const client = new SESClient(config);
const input = { // DeleteReceiptRuleRequest
RuleSetName: "STRING_VALUE", // required
RuleName: "STRING_VALUE", // required
};
const command = new DeleteReceiptRuleCommand(input);
const response = await client.send(command);
// {};
Example Usage
Loading code editor
DeleteReceiptRuleCommand Input
See DeleteReceiptRuleCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
RuleName Required | string | undefined | The name of the receipt rule to delete. |
RuleSetName Required | string | undefined | The name of the receipt rule set that contains the receipt rule to delete. |
DeleteReceiptRuleCommand Output
See DeleteReceiptRuleCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
RuleSetDoesNotExistException | client | Indicates that the provided receipt rule set does not exist. |
SESServiceException | Base exception class for all service exceptions from SES service. |