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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a component type.

Synopsis

data CreateComponentType = CreateComponentType' {
- componentTypeName :: Maybe Text
- description :: Maybe Text
- extendsFrom :: Maybe [Text]
- functions :: Maybe (HashMap Text FunctionRequest)
- isSingleton :: Maybe Bool
- propertyDefinitions :: Maybe (HashMap Text PropertyDefinitionRequest)
- propertyGroups :: Maybe (HashMap Text PropertyGroupRequest)
- tags :: Maybe (HashMap Text Text)
- workspaceId :: Text
- componentTypeId :: Text
}
newCreateComponentType :: Text -> Text -> CreateComponentType
createComponentType_componentTypeName :: Lens' CreateComponentType (Maybe Text)
createComponentType_description :: Lens' CreateComponentType (Maybe Text)
createComponentType_extendsFrom :: Lens' CreateComponentType (Maybe [Text])
createComponentType_functions :: Lens' CreateComponentType (Maybe (HashMap Text FunctionRequest))
createComponentType_isSingleton :: Lens' CreateComponentType (Maybe Bool)
createComponentType_propertyDefinitions :: Lens' CreateComponentType (Maybe (HashMap Text PropertyDefinitionRequest))
createComponentType_propertyGroups :: Lens' CreateComponentType (Maybe (HashMap Text PropertyGroupRequest))
createComponentType_tags :: Lens' CreateComponentType (Maybe (HashMap Text Text))
createComponentType_workspaceId :: Lens' CreateComponentType Text
createComponentType_componentTypeId :: Lens' CreateComponentType Text
data CreateComponentTypeResponse = CreateComponentTypeResponse' {
- httpStatus :: Int
- arn :: Text
- creationDateTime :: POSIX
- state :: State
}
newCreateComponentTypeResponse :: Int -> Text -> UTCTime -> State -> CreateComponentTypeResponse
createComponentTypeResponse_httpStatus :: Lens' CreateComponentTypeResponse Int
createComponentTypeResponse_arn :: Lens' CreateComponentTypeResponse Text
createComponentTypeResponse_creationDateTime :: Lens' CreateComponentTypeResponse UTCTime
createComponentTypeResponse_state :: Lens' CreateComponentTypeResponse State

Creating a Request

data CreateComponentType Source #

See: newCreateComponentType smart constructor.

Constructors

CreateComponentType'

Fields

componentTypeName :: Maybe Text
A friendly name for the component type.
description :: Maybe Text
The description of the component type.
extendsFrom :: Maybe [Text]
Specifies the parent component type to extend.
functions :: Maybe (HashMap Text FunctionRequest)
An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.
isSingleton :: Maybe Bool
A Boolean value that specifies whether an entity can have more than one component of this type.
propertyDefinitions :: Maybe (HashMap Text PropertyDefinitionRequest)
An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.
propertyGroups :: Maybe (HashMap Text PropertyGroupRequest)
tags :: Maybe (HashMap Text Text)
Metadata that you can use to manage the component type.
workspaceId :: Text
The ID of the workspace that contains the component type.
componentTypeId :: Text
The ID of the component type.

Instances

Instances details

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

newCreateComponentType Source #

Arguments

:: Text	`CreateComponentType`
-> Text	`CreateComponentType`
-> CreateComponentType

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

CreateComponentType, createComponentType_componentTypeName - A friendly name for the component type.

CreateComponentType, createComponentType_description - The description of the component type.

CreateComponentType, createComponentType_extendsFrom - Specifies the parent component type to extend.

$sel:functions:CreateComponentType', createComponentType_functions - An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.

$sel:isSingleton:CreateComponentType', createComponentType_isSingleton - A Boolean value that specifies whether an entity can have more than one component of this type.

$sel:propertyDefinitions:CreateComponentType', createComponentType_propertyDefinitions - An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.

CreateComponentType, createComponentType_propertyGroups -

$sel:tags:CreateComponentType', createComponentType_tags - Metadata that you can use to manage the component type.

CreateComponentType, createComponentType_workspaceId - The ID of the workspace that contains the component type.

CreateComponentType, createComponentType_componentTypeId - The ID of the component type.

Request Lenses

createComponentType_componentTypeName :: Lens' CreateComponentType (Maybe Text) Source #

A friendly name for the component type.

createComponentType_description :: Lens' CreateComponentType (Maybe Text) Source #

The description of the component type.

createComponentType_extendsFrom :: Lens' CreateComponentType (Maybe [Text]) Source #

Specifies the parent component type to extend.

createComponentType_functions :: Lens' CreateComponentType (Maybe (HashMap Text FunctionRequest)) Source #

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

createComponentType_isSingleton :: Lens' CreateComponentType (Maybe Bool) Source #

A Boolean value that specifies whether an entity can have more than one component of this type.

createComponentType_propertyDefinitions :: Lens' CreateComponentType (Maybe (HashMap Text PropertyDefinitionRequest)) Source #

An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.

createComponentType_propertyGroups :: Lens' CreateComponentType (Maybe (HashMap Text PropertyGroupRequest)) Source #

createComponentType_tags :: Lens' CreateComponentType (Maybe (HashMap Text Text)) Source #

Metadata that you can use to manage the component type.

createComponentType_workspaceId :: Lens' CreateComponentType Text Source #

The ID of the workspace that contains the component type.

createComponentType_componentTypeId :: Lens' CreateComponentType Text Source #

The ID of the component type.

Destructuring the Response

data CreateComponentTypeResponse Source #

See: newCreateComponentTypeResponse smart constructor.

Constructors

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

Instances

Instances details

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

newCreateComponentTypeResponse Source #

Arguments

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

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

CreateComponentTypeResponse, createComponentTypeResponse_arn - The ARN of the component type.

CreateComponentTypeResponse, createComponentTypeResponse_creationDateTime - The date and time when the entity was created.

CreateComponentTypeResponse, createComponentTypeResponse_state - The current state of the component type.

Response Lenses

createComponentTypeResponse_httpStatus :: Lens' CreateComponentTypeResponse Int Source #

The response's http status code.

createComponentTypeResponse_arn :: Lens' CreateComponentTypeResponse Text Source #

The ARN of the component type.

createComponentTypeResponse_creationDateTime :: Lens' CreateComponentTypeResponse UTCTime Source #

The date and time when the entity was created.

createComponentTypeResponse_state :: Lens' CreateComponentTypeResponse State Source #

The current state of the component type.