Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SES.Types.StopAction

Description

Synopsis

data StopAction = StopAction' {
- topicArn :: Maybe Text
- scope :: StopScope
}
newStopAction :: StopScope -> StopAction
stopAction_topicArn :: Lens' StopAction (Maybe Text)
stopAction_scope :: Lens' StopAction StopScope

Documentation

data StopAction Source #

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

Instances details

Eq StopAction Source #
Instance details Defined in Amazonka.SES.Types.StopAction Methods (==) :: StopAction -> StopAction -> Bool # (/=) :: StopAction -> StopAction -> Bool #
Read StopAction Source #
Instance details Defined in Amazonka.SES.Types.StopAction Methods readsPrec :: Int -> ReadS StopAction # readList :: ReadS [StopAction] # readPrec :: ReadPrec StopAction # readListPrec :: ReadPrec [StopAction] #
Show StopAction Source #
Instance details Defined in Amazonka.SES.Types.StopAction Methods showsPrec :: Int -> StopAction -> ShowS # show :: StopAction -> String # showList :: [StopAction] -> ShowS #
Generic StopAction Source #
Instance details Defined in Amazonka.SES.Types.StopAction Associated Types type Rep StopAction :: Type -> Type # Methods from :: StopAction -> Rep StopAction x # to :: Rep StopAction x -> StopAction #
NFData StopAction Source #
Instance details Defined in Amazonka.SES.Types.StopAction Methods rnf :: StopAction -> () #
Hashable StopAction Source #
Instance details Defined in Amazonka.SES.Types.StopAction Methods hashWithSalt :: Int -> StopAction -> Int # hash :: StopAction -> Int #
ToQuery StopAction Source #
Instance details Defined in Amazonka.SES.Types.StopAction Methods toQuery :: StopAction -> QueryString #
FromXML StopAction Source #
Instance details Defined in Amazonka.SES.Types.StopAction Methods parseXML :: [Node] -> Either String StopAction #
type Rep StopAction Source #
Instance details Defined in Amazonka.SES.Types.StopAction type Rep StopAction = D1 ('MetaData "StopAction" "Amazonka.SES.Types.StopAction" "libZSservicesZSamazonka-sesZSamazonka-ses" '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 Source #

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) Source #

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 Source #

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