Jump to Content

Class ReorderReceiptRuleSetCommandProtected

Reorders the receipt rules within a receipt rule set.

All of the rules in the rule set must be represented in this request. That is, this API will return an error if the reorder request doesn't explicitly position all of the rules.

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

Use a bare-bones client and the command you need to make an API call.

import { SESClient, ReorderReceiptRuleSetCommand } from "@aws-sdk/client-ses"; // ES Modules import
// const { SESClient, ReorderReceiptRuleSetCommand } = require("@aws-sdk/client-ses"); // CommonJS import
const client = new SESClient(config);
const input = { // ReorderReceiptRuleSetRequest
RuleSetName: "STRING_VALUE", // required
RuleNames: [ // ReceiptRuleNamesList // required
"STRING_VALUE",
],
};
const command = new ReorderReceiptRuleSetCommand(input);
const response = await client.send(command);

Param

ReorderReceiptRuleSetCommandInput

Returns

ReorderReceiptRuleSetCommandOutput

See

Throws

RuleDoesNotExistException (client fault)

Indicates that the provided receipt rule does not exist.

Throws

RuleSetDoesNotExistException (client fault)

Indicates that the provided receipt rule set does not exist.

Example

ReorderReceiptRuleSet

// The following example reorders the receipt rules within a receipt rule set:
const input = {
"RuleNames": [
"MyRule",
"MyOtherRule"
],
"RuleSetName": "MyRuleSet"
};
const command = new ReorderReceiptRuleSetCommand(input);
await client.send(command);
// example id: reorderreceiptruleset-1469058156806

Hierarchy

Constructors

Properties

Methods