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 template in the Cases domain. This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases.
Synopsis
- data CreateTemplate = CreateTemplate' {}
- newCreateTemplate :: Text -> Text -> CreateTemplate
- createTemplate_description :: Lens' CreateTemplate (Maybe Text)
- createTemplate_layoutConfiguration :: Lens' CreateTemplate (Maybe LayoutConfiguration)
- createTemplate_requiredFields :: Lens' CreateTemplate (Maybe [RequiredField])
- createTemplate_status :: Lens' CreateTemplate (Maybe TemplateStatus)
- createTemplate_domainId :: Lens' CreateTemplate Text
- createTemplate_name :: Lens' CreateTemplate Text
- data CreateTemplateResponse = CreateTemplateResponse' {
- httpStatus :: Int
- templateArn :: Text
- templateId :: Text
- newCreateTemplateResponse :: Int -> Text -> Text -> CreateTemplateResponse
- createTemplateResponse_httpStatus :: Lens' CreateTemplateResponse Int
- createTemplateResponse_templateArn :: Lens' CreateTemplateResponse Text
- createTemplateResponse_templateId :: Lens' CreateTemplateResponse Text
Creating a Request
data CreateTemplate Source #
See: newCreateTemplate
smart constructor.
CreateTemplate' | |
|
Instances
Create a value of CreateTemplate
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:
CreateTemplate
, createTemplate_description
- A brief description of the template.
$sel:layoutConfiguration:CreateTemplate'
, createTemplate_layoutConfiguration
- Configuration of layouts associated to the template.
$sel:requiredFields:CreateTemplate'
, createTemplate_requiredFields
- A list of fields that must contain a value for a case to be successfully
created with this template.
CreateTemplate
, createTemplate_status
- The status of the template.
CreateTemplate
, createTemplate_domainId
- The unique identifier of the Cases domain.
CreateTemplate
, createTemplate_name
- A name for the template. It must be unique per domain.
Request Lenses
createTemplate_description :: Lens' CreateTemplate (Maybe Text) Source #
A brief description of the template.
createTemplate_layoutConfiguration :: Lens' CreateTemplate (Maybe LayoutConfiguration) Source #
Configuration of layouts associated to the template.
createTemplate_requiredFields :: Lens' CreateTemplate (Maybe [RequiredField]) Source #
A list of fields that must contain a value for a case to be successfully created with this template.
createTemplate_status :: Lens' CreateTemplate (Maybe TemplateStatus) Source #
The status of the template.
createTemplate_domainId :: Lens' CreateTemplate Text Source #
The unique identifier of the Cases domain.
createTemplate_name :: Lens' CreateTemplate Text Source #
A name for the template. It must be unique per domain.
Destructuring the Response
data CreateTemplateResponse Source #
See: newCreateTemplateResponse
smart constructor.
CreateTemplateResponse' | |
|
Instances
newCreateTemplateResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> CreateTemplateResponse |
Create a value of CreateTemplateResponse
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:CreateTemplateResponse'
, createTemplateResponse_httpStatus
- The response's http status code.
CreateTemplateResponse
, createTemplateResponse_templateArn
- The Amazon Resource Name (ARN) of the newly created template.
CreateTemplateResponse
, createTemplateResponse_templateId
- A unique identifier of a template.
Response Lenses
createTemplateResponse_httpStatus :: Lens' CreateTemplateResponse Int Source #
The response's http status code.
createTemplateResponse_templateArn :: Lens' CreateTemplateResponse Text Source #
The Amazon Resource Name (ARN) of the newly created template.
createTemplateResponse_templateId :: Lens' CreateTemplateResponse Text Source #
A unique identifier of a template.