Amazonka.IotTwinMaker.CreateEntity

Creates an entity.

Creating a Request

data CreateEntity

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

ToJSON CreateEntity

Defined in Amazonka.IotTwinMaker.CreateEntity

Methods

toJSON :: CreateEntity -> Value

toEncoding :: CreateEntity -> Encoding

toJSONList :: [CreateEntity] -> Value

toEncodingList :: [CreateEntity] -> Encoding

ToHeaders CreateEntity

Defined in Amazonka.IotTwinMaker.CreateEntity

Methods

toHeaders :: CreateEntity -> [Header]

ToPath CreateEntity

Defined in Amazonka.IotTwinMaker.CreateEntity

Methods

toPath :: CreateEntity -> ByteString

ToQuery CreateEntity

Defined in Amazonka.IotTwinMaker.CreateEntity

Methods

toQuery :: CreateEntity -> QueryString

AWSRequest CreateEntity

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

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

Defined in Amazonka.IotTwinMaker.CreateEntity

Methods

readsPrec :: Int -> ReadS CreateEntity

readList :: ReadS [CreateEntity]

readPrec :: ReadPrec CreateEntity

readListPrec :: ReadPrec [CreateEntity]

Show CreateEntity

Defined in Amazonka.IotTwinMaker.CreateEntity

Methods

showsPrec :: Int -> CreateEntity -> ShowS

show :: CreateEntity -> String

showList :: [CreateEntity] -> ShowS

NFData CreateEntity

Defined in Amazonka.IotTwinMaker.CreateEntity

Methods

rnf :: CreateEntity -> ()

Eq CreateEntity

Defined in Amazonka.IotTwinMaker.CreateEntity

Methods

(==) :: CreateEntity -> CreateEntity -> Bool

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

Hashable CreateEntity

Defined in Amazonka.IotTwinMaker.CreateEntity

Methods

hashWithSalt :: Int -> CreateEntity -> Int

hash :: CreateEntity -> Int

type AWSResponse CreateEntity

Defined in Amazonka.IotTwinMaker.CreateEntity

type AWSResponse CreateEntity = CreateEntityResponse

type Rep CreateEntity

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

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))

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)

The description of the entity.

createEntity_entityId :: Lens' CreateEntity (Maybe Text)

The ID of the entity.

createEntity_parentEntityId :: Lens' CreateEntity (Maybe Text)

The ID of the entity's parent entity.

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

Metadata that you can use to manage the entity.

createEntity_workspaceId :: Lens' CreateEntity Text

The ID of the workspace that contains the entity.

createEntity_entityName :: Lens' CreateEntity Text

The name of the entity.

Destructuring the Response

data CreateEntityResponse

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

Generic CreateEntityResponse

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

Defined in Amazonka.IotTwinMaker.CreateEntity

Methods

readsPrec :: Int -> ReadS CreateEntityResponse

readList :: ReadS [CreateEntityResponse]

readPrec :: ReadPrec CreateEntityResponse

readListPrec :: ReadPrec [CreateEntityResponse]

Show CreateEntityResponse

Defined in Amazonka.IotTwinMaker.CreateEntity

Methods

showsPrec :: Int -> CreateEntityResponse -> ShowS

show :: CreateEntityResponse -> String

showList :: [CreateEntityResponse] -> ShowS

NFData CreateEntityResponse

Defined in Amazonka.IotTwinMaker.CreateEntity

Methods

rnf :: CreateEntityResponse -> ()

Eq CreateEntityResponse

Defined in Amazonka.IotTwinMaker.CreateEntity

Methods

(==) :: CreateEntityResponse -> CreateEntityResponse -> Bool

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

type Rep CreateEntityResponse

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

Arguments

:: Int

$sel:httpStatus:CreateEntityResponse'

-> Text

CreateEntity

-> Text

CreateEntityResponse

-> UTCTime

CreateEntityResponse

-> State

CreateEntityResponse

-> CreateEntityResponse

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

CreateEntity, createEntityResponse_entityId - The ID of the entity.

CreateEntityResponse, createEntityResponse_arn - The ARN of the entity.

CreateEntityResponse, createEntityResponse_creationDateTime - The date and time when the entity was created.

CreateEntityResponse, createEntityResponse_state - The current state of the entity.

Response Lenses

createEntityResponse_httpStatus :: Lens' CreateEntityResponse Int

The response's http status code.

createEntityResponse_entityId :: Lens' CreateEntityResponse Text

The ID of the entity.

createEntityResponse_arn :: Lens' CreateEntityResponse Text

The ARN of the entity.

createEntityResponse_creationDateTime :: Lens' CreateEntityResponse UTCTime

The date and time when the entity was created.

createEntityResponse_state :: Lens' CreateEntityResponse State

The current state of the entity.