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.IoT.Types.SnsAction

Description

Synopsis

data SnsAction = SnsAction' {
- messageFormat :: Maybe MessageFormat
- targetArn :: Text
- roleArn :: Text
}
newSnsAction :: Text -> Text -> SnsAction
snsAction_messageFormat :: Lens' SnsAction (Maybe MessageFormat)
snsAction_targetArn :: Lens' SnsAction Text
snsAction_roleArn :: Lens' SnsAction Text

Documentation

data SnsAction Source #

Describes an action to publish to an Amazon SNS topic.

See: newSnsAction smart constructor.

Constructors

SnsAction'

Fields

messageFormat :: Maybe MessageFormat
(Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.
targetArn :: Text
The ARN of the SNS topic.
roleArn :: Text
The ARN of the IAM role that grants access.

Instances

Instances details

Eq SnsAction Source #
Instance details Defined in Amazonka.IoT.Types.SnsAction Methods (==) :: SnsAction -> SnsAction -> Bool # (/=) :: SnsAction -> SnsAction -> Bool #
Read SnsAction Source #
Instance details Defined in Amazonka.IoT.Types.SnsAction Methods readsPrec :: Int -> ReadS SnsAction # readList :: ReadS [SnsAction] # readPrec :: ReadPrec SnsAction # readListPrec :: ReadPrec [SnsAction] #
Show SnsAction Source #
Instance details Defined in Amazonka.IoT.Types.SnsAction Methods showsPrec :: Int -> SnsAction -> ShowS # show :: SnsAction -> String # showList :: [SnsAction] -> ShowS #
Generic SnsAction Source #
Instance details Defined in Amazonka.IoT.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.IoT.Types.SnsAction Methods rnf :: SnsAction -> () #
Hashable SnsAction Source #
Instance details Defined in Amazonka.IoT.Types.SnsAction Methods hashWithSalt :: Int -> SnsAction -> Int # hash :: SnsAction -> Int #
ToJSON SnsAction Source #
Instance details Defined in Amazonka.IoT.Types.SnsAction Methods toJSON :: SnsAction -> Value # toEncoding :: SnsAction -> Encoding # toJSONList :: [SnsAction] -> Value # toEncodingList :: [SnsAction] -> Encoding #
FromJSON SnsAction Source #
Instance details Defined in Amazonka.IoT.Types.SnsAction Methods parseJSON :: Value -> Parser SnsAction # parseJSONList :: Value -> Parser [SnsAction] #
type Rep SnsAction Source #
Instance details Defined in Amazonka.IoT.Types.SnsAction type Rep SnsAction = D1 ('MetaData "SnsAction" "Amazonka.IoT.Types.SnsAction" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "SnsAction'" 'PrefixI 'True) (S1 ('MetaSel ('Just "messageFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MessageFormat)) :: (S1 ('MetaSel ('Just "targetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newSnsAction Source #

Arguments

:: Text	`$sel:targetArn:SnsAction'`
-> Text	`$sel:roleArn: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:messageFormat:SnsAction', snsAction_messageFormat - (Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.

$sel:targetArn:SnsAction', snsAction_targetArn - The ARN of the SNS topic.

$sel:roleArn:SnsAction', snsAction_roleArn - The ARN of the IAM role that grants access.

snsAction_messageFormat :: Lens' SnsAction (Maybe MessageFormat) Source #

(Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.

snsAction_targetArn :: Lens' SnsAction Text Source #

The ARN of the SNS topic.

snsAction_roleArn :: Lens' SnsAction Text Source #

The ARN of the IAM role that grants access.