class Aws::SES::Types::ReceiptAction

An action that Amazon SES can take when it receives an email on behalf of one or more email addresses or domains that you own. An instance of this data type can represent only one action.

For information about setting up receipt rules, see the [Amazon SES Developer Guide].

[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html

@note When making an API call, you may pass ReceiptAction

data as a hash:

    {
      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
      },
    }

@!attribute [rw] s3_action

Saves the received message to an Amazon Simple Storage Service
(Amazon S3) bucket and, optionally, publishes a notification to
Amazon SNS.
@return [Types::S3Action]

@!attribute [rw] bounce_action

Rejects the received email by returning a bounce response to the
sender and, optionally, publishes a notification to Amazon Simple
Notification Service (Amazon SNS).
@return [Types::BounceAction]

@!attribute [rw] workmail_action

Calls Amazon WorkMail and, optionally, publishes a notification to
Amazon Amazon SNS.
@return [Types::WorkmailAction]

@!attribute [rw] lambda_action

Calls an AWS Lambda function, and optionally, publishes a
notification to Amazon SNS.
@return [Types::LambdaAction]

@!attribute [rw] stop_action

Terminates the evaluation of the receipt rule set and optionally
publishes a notification to Amazon SNS.
@return [Types::StopAction]

@!attribute [rw] add_header_action

Adds a header to the received email.
@return [Types::AddHeaderAction]

@!attribute [rw] sns_action

Publishes the email content within a notification to Amazon SNS.
@return [Types::SNSAction]

@see docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ReceiptAction AWS API Documentation

Constants

SENSITIVE