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

Inherits:

Struct

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

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-ses/types.rb

Overview

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/dg/receiving-email-action-stop.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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`.

Returns:

• (String)

# File 'lib/aws-sdk-ses/types.rb', line 4886

class StopAction < Struct.new(
  :scope,
  :topic_arn)
  SENSITIVE = []
  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. You can find the ARN of a topic by using the [ListTopics] Amazon SNS operation.

For more information about Amazon SNS topics, see the [Amazon SNS Developer Guide].

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

Returns:

• (String)

# File 'lib/aws-sdk-ses/types.rb', line 4886

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