Amazonka.IoT.Types.ThingDocument

Documentation

data ThingDocument

The thing search index document.

See: newThingDocument smart constructor.

Constructors

ThingDocument'

Fields

• attributes :: Maybe (HashMap Text Text)

  The attributes.

• connectivity :: Maybe ThingConnectivity

  Indicates whether the thing is connected to the Amazon Web Services IoT Core service.

• deviceDefender :: Maybe Text

  Contains Device Defender data.

  For more information about Device Defender, see Device Defender.

• shadow :: Maybe Text

  The unnamed shadow and named shadow.

  For more information about shadows, see IoT Device Shadow service.

• thingGroupNames :: Maybe [Text]

  Thing group names.

• thingId :: Maybe Text

  The thing ID.

• thingName :: Maybe Text

  The thing name.

• thingTypeName :: Maybe Text

  The thing type name.

Instances

FromJSON ThingDocument

Defined in Amazonka.IoT.Types.ThingDocument

Methods

parseJSON :: Value -> Parser ThingDocument

parseJSONList :: Value -> Parser [ThingDocument]

Generic ThingDocument

Defined in Amazonka.IoT.Types.ThingDocument

Associated Types

type Rep ThingDocument :: Type -> Type

Methods

from :: ThingDocument -> Rep ThingDocument x

to :: Rep ThingDocument x -> ThingDocument

Read ThingDocument

Defined in Amazonka.IoT.Types.ThingDocument

Methods

readsPrec :: Int -> ReadS ThingDocument

readList :: ReadS [ThingDocument]

readPrec :: ReadPrec ThingDocument

readListPrec :: ReadPrec [ThingDocument]

Show ThingDocument

Defined in Amazonka.IoT.Types.ThingDocument

Methods

showsPrec :: Int -> ThingDocument -> ShowS

show :: ThingDocument -> String

showList :: [ThingDocument] -> ShowS

NFData ThingDocument

Defined in Amazonka.IoT.Types.ThingDocument

Methods

rnf :: ThingDocument -> ()

Eq ThingDocument

Defined in Amazonka.IoT.Types.ThingDocument

Methods

(==) :: ThingDocument -> ThingDocument -> Bool

(/=) :: ThingDocument -> ThingDocument -> Bool

Hashable ThingDocument

Defined in Amazonka.IoT.Types.ThingDocument

Methods

hashWithSalt :: Int -> ThingDocument -> Int

hash :: ThingDocument -> Int

type Rep ThingDocument

Defined in Amazonka.IoT.Types.ThingDocument

type Rep ThingDocument = D1 ('MetaData "ThingDocument" "Amazonka.IoT.Types.ThingDocument" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "ThingDocument'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "connectivity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ThingConnectivity))) :*: (S1 ('MetaSel ('Just "deviceDefender") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "shadow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "thingGroupNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "thingId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "thingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "thingTypeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newThingDocument :: ThingDocument

Create a value of ThingDocument 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:ThingDocument', thingDocument_attributes - The attributes.

$sel:connectivity:ThingDocument', thingDocument_connectivity - Indicates whether the thing is connected to the Amazon Web Services IoT Core service.

$sel:deviceDefender:ThingDocument', thingDocument_deviceDefender - Contains Device Defender data.

For more information about Device Defender, see Device Defender.

$sel:shadow:ThingDocument', thingDocument_shadow - The unnamed shadow and named shadow.

For more information about shadows, see IoT Device Shadow service.

$sel:thingGroupNames:ThingDocument', thingDocument_thingGroupNames - Thing group names.

$sel:thingId:ThingDocument', thingDocument_thingId - The thing ID.

$sel:thingName:ThingDocument', thingDocument_thingName - The thing name.

$sel:thingTypeName:ThingDocument', thingDocument_thingTypeName - The thing type name.

thingDocument_attributes :: Lens' ThingDocument (Maybe (HashMap Text Text))

The attributes.

thingDocument_connectivity :: Lens' ThingDocument (Maybe ThingConnectivity)

Indicates whether the thing is connected to the Amazon Web Services IoT Core service.

thingDocument_deviceDefender :: Lens' ThingDocument (Maybe Text)

Contains Device Defender data.

For more information about Device Defender, see Device Defender.

thingDocument_shadow :: Lens' ThingDocument (Maybe Text)

The unnamed shadow and named shadow.

For more information about shadows, see IoT Device Shadow service.

thingDocument_thingGroupNames :: Lens' ThingDocument (Maybe [Text])

Thing group names.

thingDocument_thingId :: Lens' ThingDocument (Maybe Text)

The thing ID.

thingDocument_thingName :: Lens' ThingDocument (Maybe Text)

The thing name.

thingDocument_thingTypeName :: Lens' ThingDocument (Maybe Text)

The thing type name.