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.IotTwinMaker.GetEntity

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves information about an entity.

Synopsis

data GetEntity = GetEntity' {
- workspaceId :: Text
- entityId :: Text
}
newGetEntity :: Text -> Text -> GetEntity
getEntity_workspaceId :: Lens' GetEntity Text
getEntity_entityId :: Lens' GetEntity Text
data GetEntityResponse = GetEntityResponse' {
- components :: Maybe (HashMap Text ComponentResponse)
- description :: Maybe Text
- syncSource :: Maybe Text
- httpStatus :: Int
- entityId :: Text
- entityName :: Text
- arn :: Text
- status :: Status
- workspaceId :: Text
- parentEntityId :: Text
- hasChildEntities :: Bool
- creationDateTime :: POSIX
- updateDateTime :: POSIX
}
newGetEntityResponse :: Int -> Text -> Text -> Text -> Status -> Text -> Text -> Bool -> UTCTime -> UTCTime -> GetEntityResponse
getEntityResponse_components :: Lens' GetEntityResponse (Maybe (HashMap Text ComponentResponse))
getEntityResponse_description :: Lens' GetEntityResponse (Maybe Text)
getEntityResponse_syncSource :: Lens' GetEntityResponse (Maybe Text)
getEntityResponse_httpStatus :: Lens' GetEntityResponse Int
getEntityResponse_entityId :: Lens' GetEntityResponse Text
getEntityResponse_entityName :: Lens' GetEntityResponse Text
getEntityResponse_arn :: Lens' GetEntityResponse Text
getEntityResponse_status :: Lens' GetEntityResponse Status
getEntityResponse_workspaceId :: Lens' GetEntityResponse Text
getEntityResponse_parentEntityId :: Lens' GetEntityResponse Text
getEntityResponse_hasChildEntities :: Lens' GetEntityResponse Bool
getEntityResponse_creationDateTime :: Lens' GetEntityResponse UTCTime
getEntityResponse_updateDateTime :: Lens' GetEntityResponse UTCTime

Creating a Request

data GetEntity Source #

See: newGetEntity smart constructor.

Constructors

GetEntity'
Fields workspaceId :: Text The ID of the workspace. entityId :: Text The ID of the entity.

Instances

Instances details

ToHeaders GetEntity Source #
Instance details Defined in Amazonka.IotTwinMaker.GetEntity Methods toHeaders :: GetEntity -> [Header] #
ToPath GetEntity Source #
Instance details Defined in Amazonka.IotTwinMaker.GetEntity Methods toPath :: GetEntity -> ByteString #
ToQuery GetEntity Source #
Instance details Defined in Amazonka.IotTwinMaker.GetEntity Methods toQuery :: GetEntity -> QueryString #
AWSRequest GetEntity Source #
Instance details Defined in Amazonka.IotTwinMaker.GetEntity Associated Types type AWSResponse GetEntity # Methods request :: (Service -> Service) -> GetEntity -> Request GetEntity # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetEntity -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetEntity))) #
Generic GetEntity Source #
Instance details Defined in Amazonka.IotTwinMaker.GetEntity Associated Types type Rep GetEntity :: Type -> Type # Methods from :: GetEntity -> Rep GetEntity x # to :: Rep GetEntity x -> GetEntity #
Read GetEntity Source #
Instance details Defined in Amazonka.IotTwinMaker.GetEntity Methods readsPrec :: Int -> ReadS GetEntity # readList :: ReadS [GetEntity] # readPrec :: ReadPrec GetEntity # readListPrec :: ReadPrec [GetEntity] #
Show GetEntity Source #
Instance details Defined in Amazonka.IotTwinMaker.GetEntity Methods showsPrec :: Int -> GetEntity -> ShowS # show :: GetEntity -> String # showList :: [GetEntity] -> ShowS #
NFData GetEntity Source #
Instance details Defined in Amazonka.IotTwinMaker.GetEntity Methods rnf :: GetEntity -> () #
Eq GetEntity Source #
Instance details Defined in Amazonka.IotTwinMaker.GetEntity Methods (==) :: GetEntity -> GetEntity -> Bool # (/=) :: GetEntity -> GetEntity -> Bool #
Hashable GetEntity Source #
Instance details Defined in Amazonka.IotTwinMaker.GetEntity Methods hashWithSalt :: Int -> GetEntity -> Int # hash :: GetEntity -> Int #
type AWSResponse GetEntity Source #
Instance details Defined in Amazonka.IotTwinMaker.GetEntity type AWSResponse GetEntity = GetEntityResponse
type Rep GetEntity Source #
Instance details Defined in Amazonka.IotTwinMaker.GetEntity type Rep GetEntity = D1 ('MetaData "GetEntity" "Amazonka.IotTwinMaker.GetEntity" "amazonka-iottwinmaker-2.0-F9krWmdiZsuIxDlP9hNtjs" 'False) (C1 ('MetaCons "GetEntity'" 'PrefixI 'True) (S1 ('MetaSel ('Just "workspaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetEntity Source #

Arguments

:: Text	`GetEntity`
-> Text	`GetEntity`
-> GetEntity

Create a value of GetEntity 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:

GetEntity, getEntity_workspaceId - The ID of the workspace.

GetEntity, getEntity_entityId - The ID of the entity.

Request Lenses

getEntity_workspaceId :: Lens' GetEntity Text Source #

The ID of the workspace.

getEntity_entityId :: Lens' GetEntity Text Source #

The ID of the entity.

Destructuring the Response

data GetEntityResponse Source #

See: newGetEntityResponse smart constructor.

Constructors

GetEntityResponse'

Fields

components :: Maybe (HashMap Text ComponentResponse)
An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.
description :: Maybe Text
The description of the entity.
syncSource :: Maybe Text
The syncSource of the sync job, if this entity was created by a sync job.
httpStatus :: Int
The response's http status code.
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.
workspaceId :: Text
The ID of the workspace.
parentEntityId :: Text
The ID of the parent entity for this entity.
hasChildEntities :: Bool
A Boolean value that specifies whether the entity has associated child entities.
creationDateTime :: POSIX
The date and time when the entity was created.
updateDateTime :: POSIX
The date and time when the entity was last updated.

Instances

Instances details

Generic GetEntityResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.GetEntity Associated Types type Rep GetEntityResponse :: Type -> Type # Methods from :: GetEntityResponse -> Rep GetEntityResponse x # to :: Rep GetEntityResponse x -> GetEntityResponse #
Read GetEntityResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.GetEntity Methods readsPrec :: Int -> ReadS GetEntityResponse # readList :: ReadS [GetEntityResponse] # readPrec :: ReadPrec GetEntityResponse # readListPrec :: ReadPrec [GetEntityResponse] #
Show GetEntityResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.GetEntity Methods showsPrec :: Int -> GetEntityResponse -> ShowS # show :: GetEntityResponse -> String # showList :: [GetEntityResponse] -> ShowS #
NFData GetEntityResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.GetEntity Methods rnf :: GetEntityResponse -> () #
Eq GetEntityResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.GetEntity Methods (==) :: GetEntityResponse -> GetEntityResponse -> Bool # (/=) :: GetEntityResponse -> GetEntityResponse -> Bool #
type Rep GetEntityResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.GetEntity type Rep GetEntityResponse = D1 ('MetaData "GetEntityResponse" "Amazonka.IotTwinMaker.GetEntity" "amazonka-iottwinmaker-2.0-F9krWmdiZsuIxDlP9hNtjs" 'False) (C1 ('MetaCons "GetEntityResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "components") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text ComponentResponse))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "syncSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (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 "workspaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: ((S1 ('MetaSel ('Just "parentEntityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "hasChildEntities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :: (S1 ('MetaSel ('Just "creationDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :: S1 ('MetaSel ('Just "updateDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))))

newGetEntityResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetEntityResponse'`
-> Text	`GetEntity`
-> Text	`GetEntityResponse`
-> Text	`GetEntityResponse`
-> Status	`GetEntityResponse`
-> Text	`GetEntity`
-> Text	`GetEntityResponse`
-> Bool	`GetEntityResponse`
-> UTCTime	`GetEntityResponse`
-> UTCTime	`GetEntityResponse`
-> GetEntityResponse

Create a value of GetEntityResponse 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:components:GetEntityResponse', getEntityResponse_components - An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.

GetEntityResponse, getEntityResponse_description - The description of the entity.

GetEntityResponse, getEntityResponse_syncSource - The syncSource of the sync job, if this entity was created by a sync job.

$sel:httpStatus:GetEntityResponse', getEntityResponse_httpStatus - The response's http status code.

GetEntity, getEntityResponse_entityId - The ID of the entity.

GetEntityResponse, getEntityResponse_entityName - The name of the entity.

GetEntityResponse, getEntityResponse_arn - The ARN of the entity.

GetEntityResponse, getEntityResponse_status - The current status of the entity.

GetEntity, getEntityResponse_workspaceId - The ID of the workspace.

GetEntityResponse, getEntityResponse_parentEntityId - The ID of the parent entity for this entity.

GetEntityResponse, getEntityResponse_hasChildEntities - A Boolean value that specifies whether the entity has associated child entities.

GetEntityResponse, getEntityResponse_creationDateTime - The date and time when the entity was created.

GetEntityResponse, getEntityResponse_updateDateTime - The date and time when the entity was last updated.

Response Lenses

getEntityResponse_components :: Lens' GetEntityResponse (Maybe (HashMap Text ComponentResponse)) Source #

An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.

getEntityResponse_description :: Lens' GetEntityResponse (Maybe Text) Source #

The description of the entity.

getEntityResponse_syncSource :: Lens' GetEntityResponse (Maybe Text) Source #

The syncSource of the sync job, if this entity was created by a sync job.

getEntityResponse_httpStatus :: Lens' GetEntityResponse Int Source #

The response's http status code.

getEntityResponse_entityId :: Lens' GetEntityResponse Text Source #

The ID of the entity.

getEntityResponse_entityName :: Lens' GetEntityResponse Text Source #

The name of the entity.

getEntityResponse_arn :: Lens' GetEntityResponse Text Source #

The ARN of the entity.

getEntityResponse_status :: Lens' GetEntityResponse Status Source #

The current status of the entity.

getEntityResponse_workspaceId :: Lens' GetEntityResponse Text Source #

The ID of the workspace.

getEntityResponse_parentEntityId :: Lens' GetEntityResponse Text Source #

The ID of the parent entity for this entity.

getEntityResponse_hasChildEntities :: Lens' GetEntityResponse Bool Source #

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

getEntityResponse_creationDateTime :: Lens' GetEntityResponse UTCTime Source #

The date and time when the entity was created.

getEntityResponse_updateDateTime :: Lens' GetEntityResponse UTCTime Source #

The date and time when the entity was last updated.