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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates information in a component type.

Synopsis

data UpdateComponentType = UpdateComponentType' {
- 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)
- workspaceId :: Text
- componentTypeId :: Text
}
newUpdateComponentType :: Text -> Text -> UpdateComponentType
updateComponentType_componentTypeName :: Lens' UpdateComponentType (Maybe Text)
updateComponentType_description :: Lens' UpdateComponentType (Maybe Text)
updateComponentType_extendsFrom :: Lens' UpdateComponentType (Maybe [Text])
updateComponentType_functions :: Lens' UpdateComponentType (Maybe (HashMap Text FunctionRequest))
updateComponentType_isSingleton :: Lens' UpdateComponentType (Maybe Bool)
updateComponentType_propertyDefinitions :: Lens' UpdateComponentType (Maybe (HashMap Text PropertyDefinitionRequest))
updateComponentType_propertyGroups :: Lens' UpdateComponentType (Maybe (HashMap Text PropertyGroupRequest))
updateComponentType_workspaceId :: Lens' UpdateComponentType Text
updateComponentType_componentTypeId :: Lens' UpdateComponentType Text
data UpdateComponentTypeResponse = UpdateComponentTypeResponse' {
- httpStatus :: Int
- workspaceId :: Text
- arn :: Text
- componentTypeId :: Text
- state :: State
}
newUpdateComponentTypeResponse :: Int -> Text -> Text -> Text -> State -> UpdateComponentTypeResponse
updateComponentTypeResponse_httpStatus :: Lens' UpdateComponentTypeResponse Int
updateComponentTypeResponse_workspaceId :: Lens' UpdateComponentTypeResponse Text
updateComponentTypeResponse_arn :: Lens' UpdateComponentTypeResponse Text
updateComponentTypeResponse_componentTypeId :: Lens' UpdateComponentTypeResponse Text
updateComponentTypeResponse_state :: Lens' UpdateComponentTypeResponse State

Creating a Request

data UpdateComponentType Source #

See: newUpdateComponentType smart constructor.

Constructors

UpdateComponentType'

Fields

componentTypeName :: Maybe Text
The component type name.
description :: Maybe Text
The description of the component type.
extendsFrom :: Maybe [Text]
Specifies the component type that this component type extends.
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)
The property groups
workspaceId :: Text
The ID of the workspace.
componentTypeId :: Text
The ID of the component type.

Instances

Instances details

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

newUpdateComponentType Source #

Arguments

:: Text	`UpdateComponentType`
-> Text	`UpdateComponentType`
-> UpdateComponentType

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

UpdateComponentType, updateComponentType_componentTypeName - The component type name.

UpdateComponentType, updateComponentType_description - The description of the component type.

UpdateComponentType, updateComponentType_extendsFrom - Specifies the component type that this component type extends.

$sel:functions:UpdateComponentType', updateComponentType_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:UpdateComponentType', updateComponentType_isSingleton - A Boolean value that specifies whether an entity can have more than one component of this type.

$sel:propertyDefinitions:UpdateComponentType', updateComponentType_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.

UpdateComponentType, updateComponentType_propertyGroups - The property groups

UpdateComponentType, updateComponentType_workspaceId - The ID of the workspace.

UpdateComponentType, updateComponentType_componentTypeId - The ID of the component type.

Request Lenses

updateComponentType_componentTypeName :: Lens' UpdateComponentType (Maybe Text) Source #

The component type name.

updateComponentType_description :: Lens' UpdateComponentType (Maybe Text) Source #

The description of the component type.

updateComponentType_extendsFrom :: Lens' UpdateComponentType (Maybe [Text]) Source #

Specifies the component type that this component type extends.

updateComponentType_functions :: Lens' UpdateComponentType (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.

updateComponentType_isSingleton :: Lens' UpdateComponentType (Maybe Bool) Source #

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

updateComponentType_propertyDefinitions :: Lens' UpdateComponentType (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.

updateComponentType_propertyGroups :: Lens' UpdateComponentType (Maybe (HashMap Text PropertyGroupRequest)) Source #

The property groups

updateComponentType_workspaceId :: Lens' UpdateComponentType Text Source #

The ID of the workspace.

updateComponentType_componentTypeId :: Lens' UpdateComponentType Text Source #

The ID of the component type.

Destructuring the Response

data UpdateComponentTypeResponse Source #

See: newUpdateComponentTypeResponse smart constructor.

Constructors

UpdateComponentTypeResponse'
Fields httpStatus :: Int The response's http status code. workspaceId :: Text The ID of the workspace that contains the component type. arn :: Text The ARN of the component type. componentTypeId :: Text The ID of the component type. state :: State The current state of the component type.

Instances

Instances details

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

newUpdateComponentTypeResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateComponentTypeResponse'`
-> Text	`UpdateComponentType`
-> Text	`UpdateComponentTypeResponse`
-> Text	`UpdateComponentType`
-> State	`UpdateComponentTypeResponse`
-> UpdateComponentTypeResponse

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

UpdateComponentType, updateComponentTypeResponse_workspaceId - The ID of the workspace that contains the component type.

UpdateComponentTypeResponse, updateComponentTypeResponse_arn - The ARN of the component type.

UpdateComponentType, updateComponentTypeResponse_componentTypeId - The ID of the component type.

UpdateComponentTypeResponse, updateComponentTypeResponse_state - The current state of the component type.

Response Lenses

updateComponentTypeResponse_httpStatus :: Lens' UpdateComponentTypeResponse Int Source #

The response's http status code.

updateComponentTypeResponse_workspaceId :: Lens' UpdateComponentTypeResponse Text Source #

The ID of the workspace that contains the component type.

updateComponentTypeResponse_arn :: Lens' UpdateComponentTypeResponse Text Source #

The ARN of the component type.

updateComponentTypeResponse_componentTypeId :: Lens' UpdateComponentTypeResponse Text Source #

The ID of the component type.

updateComponentTypeResponse_state :: Lens' UpdateComponentTypeResponse State Source #

The current state of the component type.