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.ConnectCases.CreateTemplate

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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' {
- description :: Maybe Text
- layoutConfiguration :: Maybe LayoutConfiguration
- requiredFields :: Maybe [RequiredField]
- status :: Maybe TemplateStatus
- domainId :: Text
- name :: Text
}
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.

Constructors

CreateTemplate'

Fields

description :: Maybe Text
A brief description of the template.
layoutConfiguration :: Maybe LayoutConfiguration
Configuration of layouts associated to the template.
requiredFields :: Maybe [RequiredField]
A list of fields that must contain a value for a case to be successfully created with this template.
status :: Maybe TemplateStatus
The status of the template.
domainId :: Text
The unique identifier of the Cases domain.
name :: Text
A name for the template. It must be unique per domain.

Instances

Instances details

ToJSON CreateTemplate Source #
Instance details Defined in Amazonka.ConnectCases.CreateTemplate Methods toJSON :: CreateTemplate -> Value # toEncoding :: CreateTemplate -> Encoding # toJSONList :: [CreateTemplate] -> Value # toEncodingList :: [CreateTemplate] -> Encoding #
ToHeaders CreateTemplate Source #
Instance details Defined in Amazonka.ConnectCases.CreateTemplate Methods toHeaders :: CreateTemplate -> [Header] #
ToPath CreateTemplate Source #
Instance details Defined in Amazonka.ConnectCases.CreateTemplate Methods toPath :: CreateTemplate -> ByteString #
ToQuery CreateTemplate Source #
Instance details Defined in Amazonka.ConnectCases.CreateTemplate Methods toQuery :: CreateTemplate -> QueryString #
AWSRequest CreateTemplate Source #
Instance details Defined in Amazonka.ConnectCases.CreateTemplate Associated Types type AWSResponse CreateTemplate # Methods request :: (Service -> Service) -> CreateTemplate -> Request CreateTemplate # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateTemplate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateTemplate))) #
Generic CreateTemplate Source #
Instance details Defined in Amazonka.ConnectCases.CreateTemplate Associated Types type Rep CreateTemplate :: Type -> Type # Methods from :: CreateTemplate -> Rep CreateTemplate x # to :: Rep CreateTemplate x -> CreateTemplate #
Read CreateTemplate Source #
Instance details Defined in Amazonka.ConnectCases.CreateTemplate Methods readsPrec :: Int -> ReadS CreateTemplate # readList :: ReadS [CreateTemplate] # readPrec :: ReadPrec CreateTemplate # readListPrec :: ReadPrec [CreateTemplate] #
Show CreateTemplate Source #
Instance details Defined in Amazonka.ConnectCases.CreateTemplate Methods showsPrec :: Int -> CreateTemplate -> ShowS # show :: CreateTemplate -> String # showList :: [CreateTemplate] -> ShowS #
NFData CreateTemplate Source #
Instance details Defined in Amazonka.ConnectCases.CreateTemplate Methods rnf :: CreateTemplate -> () #
Eq CreateTemplate Source #
Instance details Defined in Amazonka.ConnectCases.CreateTemplate Methods (==) :: CreateTemplate -> CreateTemplate -> Bool # (/=) :: CreateTemplate -> CreateTemplate -> Bool #
Hashable CreateTemplate Source #
Instance details Defined in Amazonka.ConnectCases.CreateTemplate Methods hashWithSalt :: Int -> CreateTemplate -> Int # hash :: CreateTemplate -> Int #
type AWSResponse CreateTemplate Source #
Instance details Defined in Amazonka.ConnectCases.CreateTemplate type AWSResponse CreateTemplate = CreateTemplateResponse
type Rep CreateTemplate Source #
Instance details Defined in Amazonka.ConnectCases.CreateTemplate type Rep CreateTemplate = D1 ('MetaData "CreateTemplate" "Amazonka.ConnectCases.CreateTemplate" "amazonka-connectcases-2.0-9RA5jvVYRVL9KmD8hfMfHn" 'False) (C1 ('MetaCons "CreateTemplate'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "layoutConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LayoutConfiguration)) :: S1 ('MetaSel ('Just "requiredFields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RequiredField])))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TemplateStatus)) :: (S1 ('MetaSel ('Just "domainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateTemplate Source #

Arguments

:: Text	`CreateTemplate`
-> Text	`CreateTemplate`
-> CreateTemplate

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.

Constructors

CreateTemplateResponse'
Fields httpStatus :: Int The response's http status code. templateArn :: Text The Amazon Resource Name (ARN) of the newly created template. templateId :: Text A unique identifier of a template.

Instances

Instances details

Generic CreateTemplateResponse Source #
Instance details Defined in Amazonka.ConnectCases.CreateTemplate Associated Types type Rep CreateTemplateResponse :: Type -> Type # Methods from :: CreateTemplateResponse -> Rep CreateTemplateResponse x # to :: Rep CreateTemplateResponse x -> CreateTemplateResponse #
Read CreateTemplateResponse Source #
Instance details Defined in Amazonka.ConnectCases.CreateTemplate Methods readsPrec :: Int -> ReadS CreateTemplateResponse # readList :: ReadS [CreateTemplateResponse] # readPrec :: ReadPrec CreateTemplateResponse # readListPrec :: ReadPrec [CreateTemplateResponse] #
Show CreateTemplateResponse Source #
Instance details Defined in Amazonka.ConnectCases.CreateTemplate Methods showsPrec :: Int -> CreateTemplateResponse -> ShowS # show :: CreateTemplateResponse -> String # showList :: [CreateTemplateResponse] -> ShowS #
NFData CreateTemplateResponse Source #
Instance details Defined in Amazonka.ConnectCases.CreateTemplate Methods rnf :: CreateTemplateResponse -> () #
Eq CreateTemplateResponse Source #
Instance details Defined in Amazonka.ConnectCases.CreateTemplate Methods (==) :: CreateTemplateResponse -> CreateTemplateResponse -> Bool # (/=) :: CreateTemplateResponse -> CreateTemplateResponse -> Bool #
type Rep CreateTemplateResponse Source #
Instance details Defined in Amazonka.ConnectCases.CreateTemplate type Rep CreateTemplateResponse = D1 ('MetaData "CreateTemplateResponse" "Amazonka.ConnectCases.CreateTemplate" "amazonka-connectcases-2.0-9RA5jvVYRVL9KmD8hfMfHn" 'False) (C1 ('MetaCons "CreateTemplateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "templateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "templateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateTemplateResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateTemplateResponse'`
-> Text	`CreateTemplateResponse`
-> Text	`CreateTemplateResponse`
-> 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.