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 |
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.
CreateComponentType' | |
|
Instances
newCreateComponentType Source #
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.
CreateComponentTypeResponse' | |
|
Instances
newCreateComponentTypeResponse Source #
:: Int | |
-> Text | |
-> UTCTime | |
-> State | |
-> 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.