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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves information about a component type.

Synopsis

data GetComponentType = GetComponentType' {
- workspaceId :: Text
- componentTypeId :: Text
}
newGetComponentType :: Text -> Text -> GetComponentType
getComponentType_workspaceId :: Lens' GetComponentType Text
getComponentType_componentTypeId :: Lens' GetComponentType Text
data GetComponentTypeResponse = GetComponentTypeResponse' {
- componentTypeName :: Maybe Text
- description :: Maybe Text
- extendsFrom :: Maybe [Text]
- functions :: Maybe (HashMap Text FunctionResponse)
- isAbstract :: Maybe Bool
- isSchemaInitialized :: Maybe Bool
- isSingleton :: Maybe Bool
- propertyDefinitions :: Maybe (HashMap Text PropertyDefinitionResponse)
- propertyGroups :: Maybe (HashMap Text PropertyGroupResponse)
- status :: Maybe Status
- syncSource :: Maybe Text
- httpStatus :: Int
- workspaceId :: Text
- componentTypeId :: Text
- creationDateTime :: POSIX
- updateDateTime :: POSIX
- arn :: Text
}
newGetComponentTypeResponse :: Int -> Text -> Text -> UTCTime -> UTCTime -> Text -> GetComponentTypeResponse
getComponentTypeResponse_componentTypeName :: Lens' GetComponentTypeResponse (Maybe Text)
getComponentTypeResponse_description :: Lens' GetComponentTypeResponse (Maybe Text)
getComponentTypeResponse_extendsFrom :: Lens' GetComponentTypeResponse (Maybe [Text])
getComponentTypeResponse_functions :: Lens' GetComponentTypeResponse (Maybe (HashMap Text FunctionResponse))
getComponentTypeResponse_isAbstract :: Lens' GetComponentTypeResponse (Maybe Bool)
getComponentTypeResponse_isSchemaInitialized :: Lens' GetComponentTypeResponse (Maybe Bool)
getComponentTypeResponse_isSingleton :: Lens' GetComponentTypeResponse (Maybe Bool)
getComponentTypeResponse_propertyDefinitions :: Lens' GetComponentTypeResponse (Maybe (HashMap Text PropertyDefinitionResponse))
getComponentTypeResponse_propertyGroups :: Lens' GetComponentTypeResponse (Maybe (HashMap Text PropertyGroupResponse))
getComponentTypeResponse_status :: Lens' GetComponentTypeResponse (Maybe Status)
getComponentTypeResponse_syncSource :: Lens' GetComponentTypeResponse (Maybe Text)
getComponentTypeResponse_httpStatus :: Lens' GetComponentTypeResponse Int
getComponentTypeResponse_workspaceId :: Lens' GetComponentTypeResponse Text
getComponentTypeResponse_componentTypeId :: Lens' GetComponentTypeResponse Text
getComponentTypeResponse_creationDateTime :: Lens' GetComponentTypeResponse UTCTime
getComponentTypeResponse_updateDateTime :: Lens' GetComponentTypeResponse UTCTime
getComponentTypeResponse_arn :: Lens' GetComponentTypeResponse Text

Creating a Request

data GetComponentType Source #

See: newGetComponentType smart constructor.

Constructors

GetComponentType'
Fields workspaceId :: Text The ID of the workspace that contains the component type. componentTypeId :: Text The ID of the component type.

Instances

Instances details

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

newGetComponentType Source #

Arguments

:: Text	`GetComponentType`
-> Text	`GetComponentType`
-> GetComponentType

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

GetComponentType, getComponentType_workspaceId - The ID of the workspace that contains the component type.

GetComponentType, getComponentType_componentTypeId - The ID of the component type.

Request Lenses

getComponentType_workspaceId :: Lens' GetComponentType Text Source #

The ID of the workspace that contains the component type.

getComponentType_componentTypeId :: Lens' GetComponentType Text Source #

The ID of the component type.

Destructuring the Response

data GetComponentTypeResponse Source #

See: newGetComponentTypeResponse smart constructor.

Constructors

GetComponentTypeResponse'

Fields

componentTypeName :: Maybe Text
The component type name.
description :: Maybe Text
The description of the component type.
extendsFrom :: Maybe [Text]
The name of the parent component type that this component type extends.
functions :: Maybe (HashMap Text FunctionResponse)
An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.
isAbstract :: Maybe Bool
A Boolean value that specifies whether the component type is abstract.
isSchemaInitialized :: Maybe Bool
A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
isSingleton :: Maybe Bool
A Boolean value that specifies whether an entity can have more than one component of this type.
propertyDefinitions :: Maybe (HashMap Text PropertyDefinitionResponse)
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 PropertyGroupResponse)
The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
status :: Maybe Status
The current status of the component type.
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.
workspaceId :: Text
The ID of the workspace that contains the component type.
componentTypeId :: Text
The ID of the component type.
creationDateTime :: POSIX
The date and time when the component type was created.
updateDateTime :: POSIX
The date and time when the component was last updated.
arn :: Text
The ARN of the component type.

Instances

Instances details

Generic GetComponentTypeResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.GetComponentType Associated Types type Rep GetComponentTypeResponse :: Type -> Type # Methods from :: GetComponentTypeResponse -> Rep GetComponentTypeResponse x # to :: Rep GetComponentTypeResponse x -> GetComponentTypeResponse #
Read GetComponentTypeResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.GetComponentType Methods readsPrec :: Int -> ReadS GetComponentTypeResponse # readList :: ReadS [GetComponentTypeResponse] # readPrec :: ReadPrec GetComponentTypeResponse # readListPrec :: ReadPrec [GetComponentTypeResponse] #
Show GetComponentTypeResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.GetComponentType Methods showsPrec :: Int -> GetComponentTypeResponse -> ShowS # show :: GetComponentTypeResponse -> String # showList :: [GetComponentTypeResponse] -> ShowS #
NFData GetComponentTypeResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.GetComponentType Methods rnf :: GetComponentTypeResponse -> () #
Eq GetComponentTypeResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.GetComponentType Methods (==) :: GetComponentTypeResponse -> GetComponentTypeResponse -> Bool # (/=) :: GetComponentTypeResponse -> GetComponentTypeResponse -> Bool #
type Rep GetComponentTypeResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.GetComponentType type Rep GetComponentTypeResponse = D1 ('MetaData "GetComponentTypeResponse" "Amazonka.IotTwinMaker.GetComponentType" "amazonka-iottwinmaker-2.0-F9krWmdiZsuIxDlP9hNtjs" 'False) (C1 ('MetaCons "GetComponentTypeResponse'" '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 FunctionResponse))))) :: ((S1 ('MetaSel ('Just "isAbstract") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "isSchemaInitialized") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "isSingleton") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "propertyDefinitions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text PropertyDefinitionResponse)))))) :: (((S1 ('MetaSel ('Just "propertyGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text PropertyGroupResponse))) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Status))) :: (S1 ('MetaSel ('Just "syncSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) :: ((S1 ('MetaSel ('Just "workspaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "componentTypeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "creationDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :: (S1 ('MetaSel ('Just "updateDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newGetComponentTypeResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetComponentTypeResponse'`
-> Text	`GetComponentType`
-> Text	`GetComponentType`
-> UTCTime	`GetComponentTypeResponse`
-> UTCTime	`GetComponentTypeResponse`
-> Text	`GetComponentTypeResponse`
-> GetComponentTypeResponse

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

GetComponentTypeResponse, getComponentTypeResponse_componentTypeName - The component type name.

GetComponentTypeResponse, getComponentTypeResponse_description - The description of the component type.

GetComponentTypeResponse, getComponentTypeResponse_extendsFrom - The name of the parent component type that this component type extends.

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

GetComponentTypeResponse, getComponentTypeResponse_isAbstract - A Boolean value that specifies whether the component type is abstract.

$sel:isSchemaInitialized:GetComponentTypeResponse', getComponentTypeResponse_isSchemaInitialized - A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.

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

$sel:propertyDefinitions:GetComponentTypeResponse', getComponentTypeResponse_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.

GetComponentTypeResponse, getComponentTypeResponse_propertyGroups - The maximum number of results to return at one time. The default is 25.

Valid Range: Minimum value of 1. Maximum value of 250.

GetComponentTypeResponse, getComponentTypeResponse_status - The current status of the component type.

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

$sel:httpStatus:GetComponentTypeResponse', getComponentTypeResponse_httpStatus - The response's http status code.

GetComponentType, getComponentTypeResponse_workspaceId - The ID of the workspace that contains the component type.

GetComponentType, getComponentTypeResponse_componentTypeId - The ID of the component type.

GetComponentTypeResponse, getComponentTypeResponse_creationDateTime - The date and time when the component type was created.

GetComponentTypeResponse, getComponentTypeResponse_updateDateTime - The date and time when the component was last updated.

GetComponentTypeResponse, getComponentTypeResponse_arn - The ARN of the component type.

Response Lenses

getComponentTypeResponse_componentTypeName :: Lens' GetComponentTypeResponse (Maybe Text) Source #

The component type name.

getComponentTypeResponse_description :: Lens' GetComponentTypeResponse (Maybe Text) Source #

The description of the component type.

getComponentTypeResponse_extendsFrom :: Lens' GetComponentTypeResponse (Maybe [Text]) Source #

The name of the parent component type that this component type extends.

getComponentTypeResponse_functions :: Lens' GetComponentTypeResponse (Maybe (HashMap Text FunctionResponse)) Source #

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

getComponentTypeResponse_isAbstract :: Lens' GetComponentTypeResponse (Maybe Bool) Source #

A Boolean value that specifies whether the component type is abstract.

getComponentTypeResponse_isSchemaInitialized :: Lens' GetComponentTypeResponse (Maybe Bool) Source #

A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.

getComponentTypeResponse_isSingleton :: Lens' GetComponentTypeResponse (Maybe Bool) Source #

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

getComponentTypeResponse_propertyDefinitions :: Lens' GetComponentTypeResponse (Maybe (HashMap Text PropertyDefinitionResponse)) 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.

getComponentTypeResponse_propertyGroups :: Lens' GetComponentTypeResponse (Maybe (HashMap Text PropertyGroupResponse)) Source #

The maximum number of results to return at one time. The default is 25.

Valid Range: Minimum value of 1. Maximum value of 250.

getComponentTypeResponse_status :: Lens' GetComponentTypeResponse (Maybe Status) Source #

The current status of the component type.

getComponentTypeResponse_syncSource :: Lens' GetComponentTypeResponse (Maybe Text) Source #

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

getComponentTypeResponse_httpStatus :: Lens' GetComponentTypeResponse Int Source #

The response's http status code.

getComponentTypeResponse_workspaceId :: Lens' GetComponentTypeResponse Text Source #

The ID of the workspace that contains the component type.

getComponentTypeResponse_componentTypeId :: Lens' GetComponentTypeResponse Text Source #

The ID of the component type.

getComponentTypeResponse_creationDateTime :: Lens' GetComponentTypeResponse UTCTime Source #

The date and time when the component type was created.

getComponentTypeResponse_updateDateTime :: Lens' GetComponentTypeResponse UTCTime Source #

The date and time when the component was last updated.

getComponentTypeResponse_arn :: Lens' GetComponentTypeResponse Text Source #

The ARN of the component type.