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

Description

Synopsis

Documentation

data AttributePayload Source #

The attribute payload.

See: newAttributePayload smart constructor.

Constructors

AttributePayload'

Fields

attributes :: Maybe (HashMap Text Text)
A JSON string containing up to three key-value pair in JSON format. For example:
```
{\"attributes\":{\"string1\":\"string2\"}}
```
merge :: Maybe Bool
Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of overwriting them.
To remove an attribute, call UpdateThing with an empty attribute value.
The merge attribute is only valid when calling UpdateThing or UpdateThingGroup.

Instances

Instances details

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

newAttributePayload :: AttributePayload Source #

Create a value of AttributePayload 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:attributes:AttributePayload', attributePayload_attributes - A JSON string containing up to three key-value pair in JSON format. For example:

{\"attributes\":{\"string1\":\"string2\"}}

$sel:merge:AttributePayload', attributePayload_merge - Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of overwriting them.

To remove an attribute, call UpdateThing with an empty attribute value.

The merge attribute is only valid when calling UpdateThing or UpdateThingGroup.

attributePayload_attributes :: Lens' AttributePayload (Maybe (HashMap Text Text)) Source #

A JSON string containing up to three key-value pair in JSON format. For example:

{\"attributes\":{\"string1\":\"string2\"}}

attributePayload_merge :: Lens' AttributePayload (Maybe Bool) Source #

Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of overwriting them.

To remove an attribute, call UpdateThing with an empty attribute value.

The merge attribute is only valid when calling UpdateThing or UpdateThingGroup.