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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an entity.

Synopsis

data CreateEntity = CreateEntity' {
- components :: Maybe (HashMap Text ComponentRequest)
- description :: Maybe Text
- entityId :: Maybe Text
- parentEntityId :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- workspaceId :: Text
- entityName :: Text
}
newCreateEntity :: Text -> Text -> CreateEntity
createEntity_components :: Lens' CreateEntity (Maybe (HashMap Text ComponentRequest))
createEntity_description :: Lens' CreateEntity (Maybe Text)
createEntity_entityId :: Lens' CreateEntity (Maybe Text)
createEntity_parentEntityId :: Lens' CreateEntity (Maybe Text)
createEntity_tags :: Lens' CreateEntity (Maybe (HashMap Text Text))
createEntity_workspaceId :: Lens' CreateEntity Text
createEntity_entityName :: Lens' CreateEntity Text
data CreateEntityResponse = CreateEntityResponse' {
- httpStatus :: Int
- entityId :: Text
- arn :: Text
- creationDateTime :: POSIX
- state :: State
}
newCreateEntityResponse :: Int -> Text -> Text -> UTCTime -> State -> CreateEntityResponse
createEntityResponse_httpStatus :: Lens' CreateEntityResponse Int
createEntityResponse_entityId :: Lens' CreateEntityResponse Text
createEntityResponse_arn :: Lens' CreateEntityResponse Text
createEntityResponse_creationDateTime :: Lens' CreateEntityResponse UTCTime
createEntityResponse_state :: Lens' CreateEntityResponse State

Creating a Request

data CreateEntity Source #

See: newCreateEntity smart constructor.

Constructors

CreateEntity'

Fields

components :: Maybe (HashMap Text ComponentRequest)
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.
entityId :: Maybe Text
The ID of the entity.
parentEntityId :: Maybe Text
The ID of the entity's parent entity.
tags :: Maybe (HashMap Text Text)
Metadata that you can use to manage the entity.
workspaceId :: Text
The ID of the workspace that contains the entity.
entityName :: Text
The name of the entity.

Instances

Instances details

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

newCreateEntity Source #

Arguments

:: Text	`CreateEntity`
-> Text	`CreateEntity`
-> CreateEntity

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

CreateEntity, createEntity_description - The description of the entity.

CreateEntity, createEntity_entityId - The ID of the entity.

CreateEntity, createEntity_parentEntityId - The ID of the entity's parent entity.

$sel:tags:CreateEntity', createEntity_tags - Metadata that you can use to manage the entity.

CreateEntity, createEntity_workspaceId - The ID of the workspace that contains the entity.

CreateEntity, createEntity_entityName - The name of the entity.

Request Lenses

createEntity_components :: Lens' CreateEntity (Maybe (HashMap Text ComponentRequest)) Source #

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

createEntity_description :: Lens' CreateEntity (Maybe Text) Source #

The description of the entity.

createEntity_entityId :: Lens' CreateEntity (Maybe Text) Source #

The ID of the entity.

createEntity_parentEntityId :: Lens' CreateEntity (Maybe Text) Source #

The ID of the entity's parent entity.

createEntity_tags :: Lens' CreateEntity (Maybe (HashMap Text Text)) Source #

Metadata that you can use to manage the entity.

createEntity_workspaceId :: Lens' CreateEntity Text Source #

The ID of the workspace that contains the entity.

createEntity_entityName :: Lens' CreateEntity Text Source #

The name of the entity.

Destructuring the Response

data CreateEntityResponse Source #

See: newCreateEntityResponse smart constructor.

Constructors

CreateEntityResponse'
Fields httpStatus :: Int The response's http status code. entityId :: Text The ID of the entity. arn :: Text The ARN of the entity. creationDateTime :: POSIX The date and time when the entity was created. state :: State The current state of the entity.

Instances

Instances details

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

newCreateEntityResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateEntityResponse'`
-> Text	`CreateEntity`
-> Text	`CreateEntityResponse`
-> UTCTime	`CreateEntityResponse`
-> State	`CreateEntityResponse`
-> CreateEntityResponse