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

Description

Synopsis

data SNSAction = SNSAction' {
- encoding :: Maybe SNSActionEncoding
- topicArn :: Text
}
newSNSAction :: Text -> SNSAction
sNSAction_encoding :: Lens' SNSAction (Maybe SNSActionEncoding)
sNSAction_topicArn :: Lens' SNSAction Text

Documentation

data SNSAction Source #

When included in a receipt rule, this action publishes a notification to Amazon Simple Notification Service (Amazon SNS). This action includes a complete copy of the email content in the Amazon SNS notifications. Amazon SNS notifications for all other actions simply provide information about the email. They do not include the email content itself.

If you own the Amazon SNS topic, you don't need to do anything to give Amazon SES permission to publish emails to it. However, if you don't own the Amazon SNS topic, you need to attach a policy to the topic to give Amazon SES permissions to access it. For information about giving permissions, see the Amazon SES Developer Guide.

You can only publish emails that are 150 KB or less (including the header) to Amazon SNS. Larger emails will bounce. If you anticipate emails larger than 150 KB, use the S3 action instead.

For information about using a receipt rule to publish an Amazon SNS notification, see the Amazon SES Developer Guide.

See: newSNSAction smart constructor.

Constructors

SNSAction'

Fields

encoding :: Maybe SNSActionEncoding
The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8.
topicArn :: Text
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. 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.

Instances

Instances details

Eq SNSAction Source #
Instance details Defined in Amazonka.SES.Types.SNSAction Methods (==) :: SNSAction -> SNSAction -> Bool # (/=) :: SNSAction -> SNSAction -> Bool #
Read SNSAction Source #
Instance details Defined in Amazonka.SES.Types.SNSAction Methods readsPrec :: Int -> ReadS SNSAction # readList :: ReadS [SNSAction] # readPrec :: ReadPrec SNSAction # readListPrec :: ReadPrec [SNSAction] #
Show SNSAction Source #
Instance details Defined in Amazonka.SES.Types.SNSAction Methods showsPrec :: Int -> SNSAction -> ShowS # show :: SNSAction -> String # showList :: [SNSAction] -> ShowS #
Generic SNSAction Source #
Instance details Defined in Amazonka.SES.Types.SNSAction Associated Types type Rep SNSAction :: Type -> Type # Methods from :: SNSAction -> Rep SNSAction x # to :: Rep SNSAction x -> SNSAction #
NFData SNSAction Source #
Instance details Defined in Amazonka.SES.Types.SNSAction Methods rnf :: SNSAction -> () #
Hashable SNSAction Source #
Instance details Defined in Amazonka.SES.Types.SNSAction Methods hashWithSalt :: Int -> SNSAction -> Int # hash :: SNSAction -> Int #
ToQuery SNSAction Source #
Instance details Defined in Amazonka.SES.Types.SNSAction Methods toQuery :: SNSAction -> QueryString #
FromXML SNSAction Source #
Instance details Defined in Amazonka.SES.Types.SNSAction Methods parseXML :: [Node] -> Either String SNSAction #
type Rep SNSAction Source #
Instance details Defined in Amazonka.SES.Types.SNSAction type Rep SNSAction = D1 ('MetaData "SNSAction" "Amazonka.SES.Types.SNSAction" "libZSservicesZSamazonka-sesZSamazonka-ses" 'False) (C1 ('MetaCons "SNSAction'" 'PrefixI 'True) (S1 ('MetaSel ('Just "encoding") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SNSActionEncoding)) :*: S1 ('MetaSel ('Just "topicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newSNSAction Source #

Arguments

:: Text	`$sel:topicArn:SNSAction'`
-> SNSAction

Create a value of SNSAction 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:encoding:SNSAction', sNSAction_encoding - The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8.

$sel:topicArn:SNSAction', sNSAction_topicArn - The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. 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.

sNSAction_encoding :: Lens' SNSAction (Maybe SNSActionEncoding) Source #

The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8.

sNSAction_topicArn :: Lens' SNSAction Text Source #

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. 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.