libZSservicesZSamazonka-iotZSamazonka-iot
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

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
Eq AttributePayload Source # 
Instance details

Defined in Amazonka.IoT.Types.AttributePayload

Read AttributePayload Source # 
Instance details

Defined in Amazonka.IoT.Types.AttributePayload

Show AttributePayload Source # 
Instance details

Defined in Amazonka.IoT.Types.AttributePayload

Generic AttributePayload Source # 
Instance details

Defined in Amazonka.IoT.Types.AttributePayload

Associated Types

type Rep AttributePayload :: Type -> Type #

NFData AttributePayload Source # 
Instance details

Defined in Amazonka.IoT.Types.AttributePayload

Methods

rnf :: AttributePayload -> () #

Hashable AttributePayload Source # 
Instance details

Defined in Amazonka.IoT.Types.AttributePayload

ToJSON AttributePayload Source # 
Instance details

Defined in Amazonka.IoT.Types.AttributePayload

FromJSON AttributePayload Source # 
Instance details

Defined in Amazonka.IoT.Types.AttributePayload

type Rep AttributePayload Source # 
Instance details

Defined in Amazonka.IoT.Types.AttributePayload

type Rep AttributePayload = D1 ('MetaData "AttributePayload" "Amazonka.IoT.Types.AttributePayload" "libZSservicesZSamazonka-iotZSamazonka-iot" '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.