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.UpdateEntity

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates an entity.

Synopsis

data UpdateEntity = UpdateEntity' {
- componentUpdates :: Maybe (HashMap Text ComponentUpdateRequest)
- description :: Maybe Text
- entityName :: Maybe Text
- parentEntityUpdate :: Maybe ParentEntityUpdateRequest
- workspaceId :: Text
- entityId :: Text
}
newUpdateEntity :: Text -> Text -> UpdateEntity
updateEntity_componentUpdates :: Lens' UpdateEntity (Maybe (HashMap Text ComponentUpdateRequest))
updateEntity_description :: Lens' UpdateEntity (Maybe Text)
updateEntity_entityName :: Lens' UpdateEntity (Maybe Text)
updateEntity_parentEntityUpdate :: Lens' UpdateEntity (Maybe ParentEntityUpdateRequest)
updateEntity_workspaceId :: Lens' UpdateEntity Text
updateEntity_entityId :: Lens' UpdateEntity Text
data UpdateEntityResponse = UpdateEntityResponse' {
- httpStatus :: Int
- updateDateTime :: POSIX
- state :: State
}
newUpdateEntityResponse :: Int -> UTCTime -> State -> UpdateEntityResponse
updateEntityResponse_httpStatus :: Lens' UpdateEntityResponse Int
updateEntityResponse_updateDateTime :: Lens' UpdateEntityResponse UTCTime
updateEntityResponse_state :: Lens' UpdateEntityResponse State

Creating a Request

data UpdateEntity Source #

See: newUpdateEntity smart constructor.

Constructors

UpdateEntity'

Fields

componentUpdates :: Maybe (HashMap Text ComponentUpdateRequest)
An object that maps strings to the component updates in the request. Each string in the mapping must be unique to this object.
description :: Maybe Text
The description of the entity.
entityName :: Maybe Text
The name of the entity.
parentEntityUpdate :: Maybe ParentEntityUpdateRequest
An object that describes the update request for a parent entity.
workspaceId :: Text
The ID of the workspace that contains the entity.
entityId :: Text
The ID of the entity.

Instances

Instances details

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

newUpdateEntity Source #

Arguments

:: Text	`UpdateEntity`
-> Text	`UpdateEntity`
-> UpdateEntity

Create a value of UpdateEntity 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:componentUpdates:UpdateEntity', updateEntity_componentUpdates - An object that maps strings to the component updates in the request. Each string in the mapping must be unique to this object.

UpdateEntity, updateEntity_description - The description of the entity.

UpdateEntity, updateEntity_entityName - The name of the entity.

$sel:parentEntityUpdate:UpdateEntity', updateEntity_parentEntityUpdate - An object that describes the update request for a parent entity.

UpdateEntity, updateEntity_workspaceId - The ID of the workspace that contains the entity.

UpdateEntity, updateEntity_entityId - The ID of the entity.

Request Lenses

updateEntity_componentUpdates :: Lens' UpdateEntity (Maybe (HashMap Text ComponentUpdateRequest)) Source #

An object that maps strings to the component updates in the request. Each string in the mapping must be unique to this object.

updateEntity_description :: Lens' UpdateEntity (Maybe Text) Source #

The description of the entity.

updateEntity_entityName :: Lens' UpdateEntity (Maybe Text) Source #

The name of the entity.

updateEntity_parentEntityUpdate :: Lens' UpdateEntity (Maybe ParentEntityUpdateRequest) Source #

An object that describes the update request for a parent entity.

updateEntity_workspaceId :: Lens' UpdateEntity Text Source #

The ID of the workspace that contains the entity.

updateEntity_entityId :: Lens' UpdateEntity Text Source #

The ID of the entity.

Destructuring the Response

data UpdateEntityResponse Source #

See: newUpdateEntityResponse smart constructor.

Constructors

UpdateEntityResponse'
Fields httpStatus :: Int The response's http status code. updateDateTime :: POSIX The date and time when the entity was last updated. state :: State The current state of the entity update.

Instances

Instances details

Generic UpdateEntityResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.UpdateEntity Associated Types type Rep UpdateEntityResponse :: Type -> Type # Methods from :: UpdateEntityResponse -> Rep UpdateEntityResponse x # to :: Rep UpdateEntityResponse x -> UpdateEntityResponse #
Read UpdateEntityResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.UpdateEntity Methods readsPrec :: Int -> ReadS UpdateEntityResponse # readList :: ReadS [UpdateEntityResponse] # readPrec :: ReadPrec UpdateEntityResponse # readListPrec :: ReadPrec [UpdateEntityResponse] #
Show UpdateEntityResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.UpdateEntity Methods showsPrec :: Int -> UpdateEntityResponse -> ShowS # show :: UpdateEntityResponse -> String # showList :: [UpdateEntityResponse] -> ShowS #
NFData UpdateEntityResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.UpdateEntity Methods rnf :: UpdateEntityResponse -> () #
Eq UpdateEntityResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.UpdateEntity Methods (==) :: UpdateEntityResponse -> UpdateEntityResponse -> Bool # (/=) :: UpdateEntityResponse -> UpdateEntityResponse -> Bool #
type Rep UpdateEntityResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.UpdateEntity type Rep UpdateEntityResponse = D1 ('MetaData "UpdateEntityResponse" "Amazonka.IotTwinMaker.UpdateEntity" "amazonka-iottwinmaker-2.0-F9krWmdiZsuIxDlP9hNtjs" 'False) (C1 ('MetaCons "UpdateEntityResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "updateDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 State))))

newUpdateEntityResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateEntityResponse'`
-> UTCTime	`UpdateEntityResponse`
-> State	`UpdateEntityResponse`
-> UpdateEntityResponse

Create a value of UpdateEntityResponse 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:httpStatus:UpdateEntityResponse', updateEntityResponse_httpStatus - The response's http status code.

UpdateEntityResponse, updateEntityResponse_updateDateTime - The date and time when the entity was last updated.

UpdateEntityResponse, updateEntityResponse_state - The current state of the entity update.

Response Lenses

updateEntityResponse_httpStatus :: Lens' UpdateEntityResponse Int Source #

The response's http status code.

updateEntityResponse_updateDateTime :: Lens' UpdateEntityResponse UTCTime Source #

The date and time when the entity was last updated.

updateEntityResponse_state :: Lens' UpdateEntityResponse State Source #

The current state of the entity update.