Class UpdateReceiptRuleCommandProtected

Updates a 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

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

import { SESClient, UpdateReceiptRuleCommand } from "@aws-sdk/client-ses"; // ES Modules import
// const { SESClient, UpdateReceiptRuleCommand } = require("@aws-sdk/client-ses"); // CommonJS import
const client = new SESClient(config);
const command = new UpdateReceiptRuleCommand(input);
const response = await client.send(command);

See

• UpdateReceiptRuleCommandInput for command's input shape.
• UpdateReceiptRuleCommandOutput for command's response shape.
• config for SESClient's config shape.

Throws

InvalidLambdaFunctionException (client fault)

Indicates that the provided AWS Lambda function is invalid, or that Amazon SES could not execute the provided function, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.

Throws

InvalidS3ConfigurationException (client fault)

Indicates that the provided Amazon S3 bucket or AWS KMS encryption key is invalid, or that Amazon SES could not publish to the bucket, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.

Throws

InvalidSnsTopicException (client fault)

Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES could not publish to the topic, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.

Throws

LimitExceededException (client fault)

Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.

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

UpdateReceiptRule

// The following example updates a receipt rule to use an Amazon S3 action:
const input = {
  "Rule": {
    "Actions": [
      {
        "S3Action": {
          "BucketName": "MyBucket",
          "ObjectKeyPrefix": "email"
        }
      }
    ],
    "Enabled": true,
    "Name": "MyRule",
    "ScanEnabled": true,
    "TlsPolicy": "Optional"
  },
  "RuleSetName": "MyRuleSet"
};
const command = new UpdateReceiptRuleCommand(input);
await client.send(command);
// example id: updatereceiptrule-1469051756940