Amazonka.IotTwinMaker.Types.EntitySummary

Documentation

data EntitySummary

An object that contains information about an entity.

See: newEntitySummary smart constructor.

Constructors

EntitySummary'

Fields

• description :: Maybe Text

  The description of the entity.

• hasChildEntities :: Maybe Bool

  A Boolean value that specifies whether the entity has child entities or not.

• parentEntityId :: Maybe Text

  The ID of the parent entity.

• entityId :: Text

  The ID of the entity.

• entityName :: Text

  The name of the entity.

• arn :: Text

  The ARN of the entity.

• status :: Status

  The current status of the entity.

• creationDateTime :: POSIX

  The date and time when the entity was created.

• updateDateTime :: POSIX

  The last date and time when the entity was updated.

Instances

FromJSON EntitySummary

Defined in Amazonka.IotTwinMaker.Types.EntitySummary

Methods

parseJSON :: Value -> Parser EntitySummary

parseJSONList :: Value -> Parser [EntitySummary]

Generic EntitySummary

Defined in Amazonka.IotTwinMaker.Types.EntitySummary

Associated Types

type Rep EntitySummary :: Type -> Type

Methods

from :: EntitySummary -> Rep EntitySummary x

to :: Rep EntitySummary x -> EntitySummary

Read EntitySummary

Defined in Amazonka.IotTwinMaker.Types.EntitySummary

Methods

readsPrec :: Int -> ReadS EntitySummary

readList :: ReadS [EntitySummary]

readPrec :: ReadPrec EntitySummary

readListPrec :: ReadPrec [EntitySummary]

Show EntitySummary

Defined in Amazonka.IotTwinMaker.Types.EntitySummary

Methods

showsPrec :: Int -> EntitySummary -> ShowS

show :: EntitySummary -> String

showList :: [EntitySummary] -> ShowS

NFData EntitySummary

Defined in Amazonka.IotTwinMaker.Types.EntitySummary

Methods

rnf :: EntitySummary -> ()

Eq EntitySummary

Defined in Amazonka.IotTwinMaker.Types.EntitySummary

Methods

(==) :: EntitySummary -> EntitySummary -> Bool

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

Hashable EntitySummary

Defined in Amazonka.IotTwinMaker.Types.EntitySummary

Methods

hashWithSalt :: Int -> EntitySummary -> Int

hash :: EntitySummary -> Int

type Rep EntitySummary

Defined in Amazonka.IotTwinMaker.Types.EntitySummary

type Rep EntitySummary = D1 ('MetaData "EntitySummary" "Amazonka.IotTwinMaker.Types.EntitySummary" "amazonka-iottwinmaker-2.0-F9krWmdiZsuIxDlP9hNtjs" 'False) (C1 ('MetaCons "EntitySummary'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "hasChildEntities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "parentEntityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "entityName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Status) :*: (S1 ('MetaSel ('Just "creationDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "updateDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))))

newEntitySummary

Arguments

:: Text

$sel:entityId:EntitySummary'

-> Text

$sel:entityName:EntitySummary'

-> Text

$sel:arn:EntitySummary'

-> Status

$sel:status:EntitySummary'

-> UTCTime

$sel:creationDateTime:EntitySummary'

-> UTCTime

$sel:updateDateTime:EntitySummary'

-> EntitySummary

Create a value of EntitySummary 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:description:EntitySummary', entitySummary_description - The description of the entity.

$sel:hasChildEntities:EntitySummary', entitySummary_hasChildEntities - A Boolean value that specifies whether the entity has child entities or not.

$sel:parentEntityId:EntitySummary', entitySummary_parentEntityId - The ID of the parent entity.

$sel:entityId:EntitySummary', entitySummary_entityId - The ID of the entity.

$sel:entityName:EntitySummary', entitySummary_entityName - The name of the entity.

$sel:arn:EntitySummary', entitySummary_arn - The ARN of the entity.

$sel:status:EntitySummary', entitySummary_status - The current status of the entity.

$sel:creationDateTime:EntitySummary', entitySummary_creationDateTime - The date and time when the entity was created.

$sel:updateDateTime:EntitySummary', entitySummary_updateDateTime - The last date and time when the entity was updated.

entitySummary_description :: Lens' EntitySummary (Maybe Text)

The description of the entity.

entitySummary_hasChildEntities :: Lens' EntitySummary (Maybe Bool)

A Boolean value that specifies whether the entity has child entities or not.

entitySummary_parentEntityId :: Lens' EntitySummary (Maybe Text)

The ID of the parent entity.

entitySummary_entityId :: Lens' EntitySummary Text

The ID of the entity.

entitySummary_entityName :: Lens' EntitySummary Text

The name of the entity.

entitySummary_arn :: Lens' EntitySummary Text

The ARN of the entity.

entitySummary_status :: Lens' EntitySummary Status

The current status of the entity.

entitySummary_creationDateTime :: Lens' EntitySummary UTCTime

The date and time when the entity was created.

entitySummary_updateDateTime :: Lens' EntitySummary UTCTime

The last date and time when the entity was updated.