Amazonka.SES.Types.StopAction

Documentation

data StopAction

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.

See: newStopAction smart constructor.

Constructors

StopAction'

Fields

• topicArn :: Maybe Text

  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.

• scope :: StopScope

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

Instances

ToQuery StopAction

Defined in Amazonka.SES.Types.StopAction

Methods

toQuery :: StopAction -> QueryString

FromXML StopAction

Defined in Amazonka.SES.Types.StopAction

Methods

parseXML :: [Node] -> Either String StopAction

Generic StopAction

Defined in Amazonka.SES.Types.StopAction

Associated Types

type Rep StopAction :: Type -> Type

Methods

from :: StopAction -> Rep StopAction x

to :: Rep StopAction x -> StopAction

Read StopAction

Defined in Amazonka.SES.Types.StopAction

Methods

readsPrec :: Int -> ReadS StopAction

readList :: ReadS [StopAction]

readPrec :: ReadPrec StopAction

readListPrec :: ReadPrec [StopAction]

Show StopAction

Defined in Amazonka.SES.Types.StopAction

Methods

showsPrec :: Int -> StopAction -> ShowS

show :: StopAction -> String

showList :: [StopAction] -> ShowS

NFData StopAction

Defined in Amazonka.SES.Types.StopAction

Methods

rnf :: StopAction -> ()

Eq StopAction

Defined in Amazonka.SES.Types.StopAction

Methods

(==) :: StopAction -> StopAction -> Bool

(/=) :: StopAction -> StopAction -> Bool

Hashable StopAction

Defined in Amazonka.SES.Types.StopAction

Methods

hashWithSalt :: Int -> StopAction -> Int

hash :: StopAction -> Int

type Rep StopAction

Defined in Amazonka.SES.Types.StopAction

type Rep StopAction = D1 ('MetaData "StopAction" "Amazonka.SES.Types.StopAction" "amazonka-ses-2.0-Gc6VkOIX7Sd2eunWehphuf" 'False) (C1 ('MetaCons "StopAction'" 'PrefixI 'True) (S1 ('MetaSel ('Just "topicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "scope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 StopScope)))

newStopAction

Arguments

:: StopScope

$sel:scope:StopAction'

-> StopAction

Create a value of StopAction with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:topicArn:StopAction', stopAction_topicArn - 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.

$sel:scope:StopAction', stopAction_scope - The scope of the StopAction. The only acceptable value is RuleSet.

stopAction_topicArn :: Lens' StopAction (Maybe Text)

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.

stopAction_scope :: Lens' StopAction StopScope

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