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

Class: Aws::SES::Types::StopAction

Inherits:

Struct

Object
Struct
Aws::SES::Types::StopAction

show all

Defined in:: (unknown)

Overview

Note:

When passing StopAction as input to an Aws::Client method, you can use a vanilla Hash:

{
  scope: "RuleSet", # required, accepts RuleSet
  topic_arn: "AmazonResourceName",
}

When included in a receipt rule, this action terminates the evaluation of the receipt rule set and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

For information about setting a stop action in a receipt rule, see the Amazon SES Developer Guide.

Returned by:

ReceiptAction#stop_action

Instance Attribute Summary collapse

#scope ⇒ String
The scope of the StopAction.
#topic_arn ⇒ String
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken.

Instance Attribute Details

#scope ⇒ `String`

The scope of the StopAction. The only acceptable value is RuleSet.

Possible values:

RuleSet

Returns:

(String) —
The scope of the StopAction.

#topic_arn ⇒ `String`

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.