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

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

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

Instance Attribute Summary collapse

Instance Attribute Details

#scopeString

The name of the RuleSet that is being stopped.

Returns:

  • (String)


4701
4702
4703
4704
4705
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 4701

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

#topic_arnString

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.

Returns:

  • (String)


4701
4702
4703
4704
4705
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 4701

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