You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SES::Types::UpdateReceiptRuleRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb

Overview

Note:

When making an API call, you may pass UpdateReceiptRuleRequest data as a hash:

{
  rule_set_name: "ReceiptRuleSetName", # required
  rule: { # required
    name: "ReceiptRuleName", # required
    enabled: false,
    tls_policy: "Require", # accepts Require, Optional
    recipients: ["Recipient"],
    actions: [
      {
        s3_action: {
          topic_arn: "AmazonResourceName",
          bucket_name: "S3BucketName", # required
          object_key_prefix: "S3KeyPrefix",
          kms_key_arn: "AmazonResourceName",
        },
        bounce_action: {
          topic_arn: "AmazonResourceName",
          smtp_reply_code: "BounceSmtpReplyCode", # required
          status_code: "BounceStatusCode",
          message: "BounceMessage", # required
          sender: "Address", # required
        },
        workmail_action: {
          topic_arn: "AmazonResourceName",
          organization_arn: "AmazonResourceName", # required
        },
        lambda_action: {
          topic_arn: "AmazonResourceName",
          function_arn: "AmazonResourceName", # required
          invocation_type: "Event", # accepts Event, RequestResponse
        },
        stop_action: {
          scope: "RuleSet", # required, accepts RuleSet
          topic_arn: "AmazonResourceName",
        },
        add_header_action: {
          header_name: "HeaderName", # required
          header_value: "HeaderValue", # required
        },
        sns_action: {
          topic_arn: "AmazonResourceName", # required
          encoding: "UTF-8", # accepts UTF-8, Base64
        },
      },
    ],
    scan_enabled: false,
  },
}

Represents a request to update a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

Instance Attribute Summary collapse

Instance Attribute Details

#ruleTypes::ReceiptRule

A data structure that contains the updated receipt rule information.

Returns:



4119
4120
4121
4122
4123
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 4119

class UpdateReceiptRuleRequest < Struct.new(
  :rule_set_name,
  :rule)
  include Aws::Structure
end

#rule_set_nameString

The name of the receipt rule set to which the receipt rule belongs.

Returns:

  • (String)


4119
4120
4121
4122
4123
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 4119

class UpdateReceiptRuleRequest < Struct.new(
  :rule_set_name,
  :rule)
  include Aws::Structure
end