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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the attributes of an existing template. The template attributes that can be modified include name, description, layoutConfiguration, requiredFields, and status. At least one of these attributes must not be null. If a null value is provided for a given attribute, that attribute is ignored and its current value is preserved.

Synopsis

data UpdateTemplate = UpdateTemplate' {
- description :: Maybe Text
- layoutConfiguration :: Maybe LayoutConfiguration
- name :: Maybe Text
- requiredFields :: Maybe [RequiredField]
- status :: Maybe TemplateStatus
- domainId :: Text
- templateId :: Text
}
newUpdateTemplate :: Text -> Text -> UpdateTemplate
updateTemplate_description :: Lens' UpdateTemplate (Maybe Text)
updateTemplate_layoutConfiguration :: Lens' UpdateTemplate (Maybe LayoutConfiguration)
updateTemplate_name :: Lens' UpdateTemplate (Maybe Text)
updateTemplate_requiredFields :: Lens' UpdateTemplate (Maybe [RequiredField])
updateTemplate_status :: Lens' UpdateTemplate (Maybe TemplateStatus)
updateTemplate_domainId :: Lens' UpdateTemplate Text
updateTemplate_templateId :: Lens' UpdateTemplate Text
data UpdateTemplateResponse = UpdateTemplateResponse' {
- httpStatus :: Int
}
newUpdateTemplateResponse :: Int -> UpdateTemplateResponse
updateTemplateResponse_httpStatus :: Lens' UpdateTemplateResponse Int

Creating a Request

data UpdateTemplate Source #

See: newUpdateTemplate smart constructor.

Constructors

UpdateTemplate'

Fields

description :: Maybe Text
A brief description of the template.
layoutConfiguration :: Maybe LayoutConfiguration
Configuration of layouts associated to the template.
name :: Maybe Text
The name of the template. It must be unique per domain.
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.
templateId :: Text
A unique identifier for the template.

Instances

Instances details

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

newUpdateTemplate Source #

Arguments

:: Text	`UpdateTemplate`
-> Text	`UpdateTemplate`
-> UpdateTemplate

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

UpdateTemplate, updateTemplate_description - A brief description of the template.

$sel:layoutConfiguration:UpdateTemplate', updateTemplate_layoutConfiguration - Configuration of layouts associated to the template.

UpdateTemplate, updateTemplate_name - The name of the template. It must be unique per domain.

$sel:requiredFields:UpdateTemplate', updateTemplate_requiredFields - A list of fields that must contain a value for a case to be successfully created with this template.

UpdateTemplate, updateTemplate_status - The status of the template.

UpdateTemplate, updateTemplate_domainId - The unique identifier of the Cases domain.

UpdateTemplate, updateTemplate_templateId - A unique identifier for the template.

Request Lenses

updateTemplate_description :: Lens' UpdateTemplate (Maybe Text) Source #

A brief description of the template.

updateTemplate_layoutConfiguration :: Lens' UpdateTemplate (Maybe LayoutConfiguration) Source #

Configuration of layouts associated to the template.

updateTemplate_name :: Lens' UpdateTemplate (Maybe Text) Source #

The name of the template. It must be unique per domain.

updateTemplate_requiredFields :: Lens' UpdateTemplate (Maybe [RequiredField]) Source #

A list of fields that must contain a value for a case to be successfully created with this template.

updateTemplate_status :: Lens' UpdateTemplate (Maybe TemplateStatus) Source #

The status of the template.

updateTemplate_domainId :: Lens' UpdateTemplate Text Source #

The unique identifier of the Cases domain.

updateTemplate_templateId :: Lens' UpdateTemplate Text Source #

A unique identifier for the template.

Destructuring the Response

data UpdateTemplateResponse Source #

See: newUpdateTemplateResponse smart constructor.

Constructors

UpdateTemplateResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

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

newUpdateTemplateResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateTemplateResponse'`
-> UpdateTemplateResponse

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

Response Lenses

updateTemplateResponse_httpStatus :: Lens' UpdateTemplateResponse Int Source #

The response's http status code.