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

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

Overview

Note:

When making an API call, you may pass StopAction data as a 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].

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#scope ⇒ String

The name of the RuleSet that is being stopped.

Returns:

  • (String) 


5123
5124
5125
5126
5127
 
# File 'lib/aws-sdk-ses/types.rb', line 5123

class StopAction < Struct.new(
  :scope,
  :topic_arn)
  include Aws::Structure
end

#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].

[1]: docs.aws.amazon.com/sns/latest/dg/CreateTopic.html

Returns:

  • (String) 


5123
5124
5125
5126
5127
 
# File 'lib/aws-sdk-ses/types.rb', line 5123

class StopAction < Struct.new(
  :scope,
  :topic_arn)
  include Aws::Structure
end