Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.IoTEvents.Types.Payload

Description

Synopsis

data Payload = Payload' {
- contentExpression :: Text
- type' :: PayloadType
}
newPayload :: Text -> PayloadType -> Payload
payload_contentExpression :: Lens' Payload Text
payload_type :: Lens' Payload PayloadType

Documentation

data Payload Source #

Information needed to configure the payload.

By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.

See: newPayload smart constructor.

Constructors

Payload'

Fields

contentExpression :: Text
The content of the payload. You can use a string expression that includes quoted strings ('<string>'), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
type' :: PayloadType
The value of the payload type can be either STRING or JSON.

Instances

Instances details

FromJSON Payload Source #
Instance details Defined in Amazonka.IoTEvents.Types.Payload Methods parseJSON :: Value -> Parser Payload # parseJSONList :: Value -> Parser [Payload] #
ToJSON Payload Source #
Instance details Defined in Amazonka.IoTEvents.Types.Payload Methods toJSON :: Payload -> Value # toEncoding :: Payload -> Encoding # toJSONList :: [Payload] -> Value # toEncodingList :: [Payload] -> Encoding #
Generic Payload Source #
Instance details Defined in Amazonka.IoTEvents.Types.Payload Associated Types type Rep Payload :: Type -> Type # Methods from :: Payload -> Rep Payload x # to :: Rep Payload x -> Payload #
Read Payload Source #
Instance details Defined in Amazonka.IoTEvents.Types.Payload Methods readsPrec :: Int -> ReadS Payload # readList :: ReadS [Payload] # readPrec :: ReadPrec Payload # readListPrec :: ReadPrec [Payload] #
Show Payload Source #
Instance details Defined in Amazonka.IoTEvents.Types.Payload Methods showsPrec :: Int -> Payload -> ShowS # show :: Payload -> String # showList :: [Payload] -> ShowS #
NFData Payload Source #
Instance details Defined in Amazonka.IoTEvents.Types.Payload Methods rnf :: Payload -> () #
Eq Payload Source #
Instance details Defined in Amazonka.IoTEvents.Types.Payload Methods (==) :: Payload -> Payload -> Bool # (/=) :: Payload -> Payload -> Bool #
Hashable Payload Source #
Instance details Defined in Amazonka.IoTEvents.Types.Payload Methods hashWithSalt :: Int -> Payload -> Int # hash :: Payload -> Int #
type Rep Payload Source #
Instance details Defined in Amazonka.IoTEvents.Types.Payload type Rep Payload = D1 ('MetaData "Payload" "Amazonka.IoTEvents.Types.Payload" "amazonka-iotevents-2.0-6xKaLx5KciSK3LEs0FyRYn" 'False) (C1 ('MetaCons "Payload'" 'PrefixI 'True) (S1 ('MetaSel ('Just "contentExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PayloadType)))

newPayload Source #

Arguments

:: Text	`$sel:contentExpression:Payload'`
-> PayloadType	`$sel:type':Payload'`
-> Payload

Create a value of Payload 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:contentExpression:Payload', payload_contentExpression - The content of the payload. You can use a string expression that includes quoted strings ('<string>'), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.

$sel:type':Payload', payload_type - The value of the payload type can be either STRING or JSON.

payload_contentExpression :: Lens' Payload Text Source #

The content of the payload. You can use a string expression that includes quoted strings ('<string>'), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.

payload_type :: Lens' Payload PayloadType Source #

The value of the payload type can be either STRING or JSON.