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.Connect.UpdateTaskTemplate

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates details about a specific task template in the specified Amazon Connect instance. This operation does not support partial updates. Instead it does a full update of template content.

Synopsis

data UpdateTaskTemplate = UpdateTaskTemplate' {
- constraints :: Maybe TaskTemplateConstraints
- contactFlowId :: Maybe Text
- defaults :: Maybe TaskTemplateDefaults
- description :: Maybe Text
- fields :: Maybe [TaskTemplateField]
- name :: Maybe Text
- status :: Maybe TaskTemplateStatus
- taskTemplateId :: Text
- instanceId :: Text
}
newUpdateTaskTemplate :: Text -> Text -> UpdateTaskTemplate
updateTaskTemplate_constraints :: Lens' UpdateTaskTemplate (Maybe TaskTemplateConstraints)
updateTaskTemplate_contactFlowId :: Lens' UpdateTaskTemplate (Maybe Text)
updateTaskTemplate_defaults :: Lens' UpdateTaskTemplate (Maybe TaskTemplateDefaults)
updateTaskTemplate_description :: Lens' UpdateTaskTemplate (Maybe Text)
updateTaskTemplate_fields :: Lens' UpdateTaskTemplate (Maybe [TaskTemplateField])
updateTaskTemplate_name :: Lens' UpdateTaskTemplate (Maybe Text)
updateTaskTemplate_status :: Lens' UpdateTaskTemplate (Maybe TaskTemplateStatus)
updateTaskTemplate_taskTemplateId :: Lens' UpdateTaskTemplate Text
updateTaskTemplate_instanceId :: Lens' UpdateTaskTemplate Text
data UpdateTaskTemplateResponse = UpdateTaskTemplateResponse' {
- arn :: Maybe Text
- constraints :: Maybe TaskTemplateConstraints
- contactFlowId :: Maybe Text
- createdTime :: Maybe POSIX
- defaults :: Maybe TaskTemplateDefaults
- description :: Maybe Text
- fields :: Maybe [TaskTemplateField]
- id :: Maybe Text
- instanceId :: Maybe Text
- lastModifiedTime :: Maybe POSIX
- name :: Maybe Text
- status :: Maybe TaskTemplateStatus
- httpStatus :: Int
}
newUpdateTaskTemplateResponse :: Int -> UpdateTaskTemplateResponse
updateTaskTemplateResponse_arn :: Lens' UpdateTaskTemplateResponse (Maybe Text)
updateTaskTemplateResponse_constraints :: Lens' UpdateTaskTemplateResponse (Maybe TaskTemplateConstraints)
updateTaskTemplateResponse_contactFlowId :: Lens' UpdateTaskTemplateResponse (Maybe Text)
updateTaskTemplateResponse_createdTime :: Lens' UpdateTaskTemplateResponse (Maybe UTCTime)
updateTaskTemplateResponse_defaults :: Lens' UpdateTaskTemplateResponse (Maybe TaskTemplateDefaults)
updateTaskTemplateResponse_description :: Lens' UpdateTaskTemplateResponse (Maybe Text)
updateTaskTemplateResponse_fields :: Lens' UpdateTaskTemplateResponse (Maybe [TaskTemplateField])
updateTaskTemplateResponse_id :: Lens' UpdateTaskTemplateResponse (Maybe Text)
updateTaskTemplateResponse_instanceId :: Lens' UpdateTaskTemplateResponse (Maybe Text)
updateTaskTemplateResponse_lastModifiedTime :: Lens' UpdateTaskTemplateResponse (Maybe UTCTime)
updateTaskTemplateResponse_name :: Lens' UpdateTaskTemplateResponse (Maybe Text)
updateTaskTemplateResponse_status :: Lens' UpdateTaskTemplateResponse (Maybe TaskTemplateStatus)
updateTaskTemplateResponse_httpStatus :: Lens' UpdateTaskTemplateResponse Int

Creating a Request

data UpdateTaskTemplate Source #

See: newUpdateTaskTemplate smart constructor.

Constructors

UpdateTaskTemplate'

Fields

constraints :: Maybe TaskTemplateConstraints
Constraints that are applicable to the fields listed.
contactFlowId :: Maybe Text
The identifier of the flow that runs by default when a task is created by referencing this template.
defaults :: Maybe TaskTemplateDefaults
The default values for fields when a task is created by referencing this template.
description :: Maybe Text
The description of the task template.
fields :: Maybe [TaskTemplateField]
Fields that are part of the template.
name :: Maybe Text
The name of the task template.
status :: Maybe TaskTemplateStatus
Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.
taskTemplateId :: Text
A unique identifier for the task template.
instanceId :: Text
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Instances

Instances details

ToJSON UpdateTaskTemplate Source #
Instance details Defined in Amazonka.Connect.UpdateTaskTemplate Methods toJSON :: UpdateTaskTemplate -> Value # toEncoding :: UpdateTaskTemplate -> Encoding # toJSONList :: [UpdateTaskTemplate] -> Value # toEncodingList :: [UpdateTaskTemplate] -> Encoding #
ToHeaders UpdateTaskTemplate Source #
Instance details Defined in Amazonka.Connect.UpdateTaskTemplate Methods toHeaders :: UpdateTaskTemplate -> [Header] #
ToPath UpdateTaskTemplate Source #
Instance details Defined in Amazonka.Connect.UpdateTaskTemplate Methods toPath :: UpdateTaskTemplate -> ByteString #
ToQuery UpdateTaskTemplate Source #
Instance details Defined in Amazonka.Connect.UpdateTaskTemplate Methods toQuery :: UpdateTaskTemplate -> QueryString #
AWSRequest UpdateTaskTemplate Source #
Instance details Defined in Amazonka.Connect.UpdateTaskTemplate Associated Types type AWSResponse UpdateTaskTemplate # Methods request :: (Service -> Service) -> UpdateTaskTemplate -> Request UpdateTaskTemplate # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateTaskTemplate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateTaskTemplate))) #
Generic UpdateTaskTemplate Source #
Instance details Defined in Amazonka.Connect.UpdateTaskTemplate Associated Types type Rep UpdateTaskTemplate :: Type -> Type # Methods from :: UpdateTaskTemplate -> Rep UpdateTaskTemplate x # to :: Rep UpdateTaskTemplate x -> UpdateTaskTemplate #
Read UpdateTaskTemplate Source #
Instance details Defined in Amazonka.Connect.UpdateTaskTemplate Methods readsPrec :: Int -> ReadS UpdateTaskTemplate # readList :: ReadS [UpdateTaskTemplate] # readPrec :: ReadPrec UpdateTaskTemplate # readListPrec :: ReadPrec [UpdateTaskTemplate] #
Show UpdateTaskTemplate Source #
Instance details Defined in Amazonka.Connect.UpdateTaskTemplate Methods showsPrec :: Int -> UpdateTaskTemplate -> ShowS # show :: UpdateTaskTemplate -> String # showList :: [UpdateTaskTemplate] -> ShowS #
NFData UpdateTaskTemplate Source #
Instance details Defined in Amazonka.Connect.UpdateTaskTemplate Methods rnf :: UpdateTaskTemplate -> () #
Eq UpdateTaskTemplate Source #
Instance details Defined in Amazonka.Connect.UpdateTaskTemplate Methods (==) :: UpdateTaskTemplate -> UpdateTaskTemplate -> Bool # (/=) :: UpdateTaskTemplate -> UpdateTaskTemplate -> Bool #
Hashable UpdateTaskTemplate Source #
Instance details Defined in Amazonka.Connect.UpdateTaskTemplate Methods hashWithSalt :: Int -> UpdateTaskTemplate -> Int # hash :: UpdateTaskTemplate -> Int #
type AWSResponse UpdateTaskTemplate Source #
Instance details Defined in Amazonka.Connect.UpdateTaskTemplate type AWSResponse UpdateTaskTemplate = UpdateTaskTemplateResponse
type Rep UpdateTaskTemplate Source #
Instance details Defined in Amazonka.Connect.UpdateTaskTemplate type Rep UpdateTaskTemplate = D1 ('MetaData "UpdateTaskTemplate" "Amazonka.Connect.UpdateTaskTemplate" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "UpdateTaskTemplate'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "constraints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaskTemplateConstraints)) :: S1 ('MetaSel ('Just "contactFlowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "defaults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaskTemplateDefaults)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "fields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TaskTemplateField])) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaskTemplateStatus)) :: (S1 ('MetaSel ('Just "taskTemplateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newUpdateTaskTemplate Source #

Arguments

:: Text	`$sel:taskTemplateId:UpdateTaskTemplate'`
-> Text	`UpdateTaskTemplate`
-> UpdateTaskTemplate

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

UpdateTaskTemplate, updateTaskTemplate_constraints - Constraints that are applicable to the fields listed.

UpdateTaskTemplate, updateTaskTemplate_contactFlowId - The identifier of the flow that runs by default when a task is created by referencing this template.

UpdateTaskTemplate, updateTaskTemplate_defaults - The default values for fields when a task is created by referencing this template.

UpdateTaskTemplate, updateTaskTemplate_description - The description of the task template.

UpdateTaskTemplate, updateTaskTemplate_fields - Fields that are part of the template.

UpdateTaskTemplate, updateTaskTemplate_name - The name of the task template.

UpdateTaskTemplate, updateTaskTemplate_status - Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

$sel:taskTemplateId:UpdateTaskTemplate', updateTaskTemplate_taskTemplateId - A unique identifier for the task template.

UpdateTaskTemplate, updateTaskTemplate_instanceId - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Request Lenses

updateTaskTemplate_constraints :: Lens' UpdateTaskTemplate (Maybe TaskTemplateConstraints) Source #

Constraints that are applicable to the fields listed.

updateTaskTemplate_contactFlowId :: Lens' UpdateTaskTemplate (Maybe Text) Source #

The identifier of the flow that runs by default when a task is created by referencing this template.

updateTaskTemplate_defaults :: Lens' UpdateTaskTemplate (Maybe TaskTemplateDefaults) Source #

The default values for fields when a task is created by referencing this template.

updateTaskTemplate_description :: Lens' UpdateTaskTemplate (Maybe Text) Source #

The description of the task template.

updateTaskTemplate_fields :: Lens' UpdateTaskTemplate (Maybe [TaskTemplateField]) Source #

Fields that are part of the template.

updateTaskTemplate_name :: Lens' UpdateTaskTemplate (Maybe Text) Source #

The name of the task template.

updateTaskTemplate_status :: Lens' UpdateTaskTemplate (Maybe TaskTemplateStatus) Source #

Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

updateTaskTemplate_taskTemplateId :: Lens' UpdateTaskTemplate Text Source #

A unique identifier for the task template.

updateTaskTemplate_instanceId :: Lens' UpdateTaskTemplate Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Destructuring the Response

data UpdateTaskTemplateResponse Source #

See: newUpdateTaskTemplateResponse smart constructor.

Constructors

UpdateTaskTemplateResponse'

Fields

arn :: Maybe Text
The Amazon Resource Name (ARN) for the task template resource.
constraints :: Maybe TaskTemplateConstraints
Constraints that are applicable to the fields listed.
contactFlowId :: Maybe Text
The identifier of the flow that runs by default when a task is created by referencing this template.
createdTime :: Maybe POSIX
The timestamp when the task template was created.
defaults :: Maybe TaskTemplateDefaults
The default values for fields when a task is created by referencing this template.
description :: Maybe Text
The description of the task template.
fields :: Maybe [TaskTemplateField]
Fields that are part of the template.
id :: Maybe Text
The identifier of the task template resource.
instanceId :: Maybe Text
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
lastModifiedTime :: Maybe POSIX
The timestamp when the task template was last modified.
name :: Maybe Text
The name of the task template.
status :: Maybe TaskTemplateStatus
Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic UpdateTaskTemplateResponse Source #
Instance details Defined in Amazonka.Connect.UpdateTaskTemplate Associated Types type Rep UpdateTaskTemplateResponse :: Type -> Type # Methods from :: UpdateTaskTemplateResponse -> Rep UpdateTaskTemplateResponse x # to :: Rep UpdateTaskTemplateResponse x -> UpdateTaskTemplateResponse #
Read UpdateTaskTemplateResponse Source #
Instance details Defined in Amazonka.Connect.UpdateTaskTemplate Methods readsPrec :: Int -> ReadS UpdateTaskTemplateResponse # readList :: ReadS [UpdateTaskTemplateResponse] # readPrec :: ReadPrec UpdateTaskTemplateResponse # readListPrec :: ReadPrec [UpdateTaskTemplateResponse] #
Show UpdateTaskTemplateResponse Source #
Instance details Defined in Amazonka.Connect.UpdateTaskTemplate Methods showsPrec :: Int -> UpdateTaskTemplateResponse -> ShowS # show :: UpdateTaskTemplateResponse -> String # showList :: [UpdateTaskTemplateResponse] -> ShowS #
NFData UpdateTaskTemplateResponse Source #
Instance details Defined in Amazonka.Connect.UpdateTaskTemplate Methods rnf :: UpdateTaskTemplateResponse -> () #
Eq UpdateTaskTemplateResponse Source #
Instance details Defined in Amazonka.Connect.UpdateTaskTemplate Methods (==) :: UpdateTaskTemplateResponse -> UpdateTaskTemplateResponse -> Bool # (/=) :: UpdateTaskTemplateResponse -> UpdateTaskTemplateResponse -> Bool #
type Rep UpdateTaskTemplateResponse Source #
Instance details Defined in Amazonka.Connect.UpdateTaskTemplate type Rep UpdateTaskTemplateResponse = D1 ('MetaData "UpdateTaskTemplateResponse" "Amazonka.Connect.UpdateTaskTemplate" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "UpdateTaskTemplateResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "constraints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaskTemplateConstraints)) :: S1 ('MetaSel ('Just "contactFlowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "createdTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "defaults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaskTemplateDefaults)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "fields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TaskTemplateField])) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaskTemplateStatus)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newUpdateTaskTemplateResponse Source #

Arguments

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

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

UpdateTaskTemplateResponse, updateTaskTemplateResponse_arn - The Amazon Resource Name (ARN) for the task template resource.

UpdateTaskTemplate, updateTaskTemplateResponse_constraints - Constraints that are applicable to the fields listed.

UpdateTaskTemplate, updateTaskTemplateResponse_contactFlowId - The identifier of the flow that runs by default when a task is created by referencing this template.

UpdateTaskTemplateResponse, updateTaskTemplateResponse_createdTime - The timestamp when the task template was created.

UpdateTaskTemplate, updateTaskTemplateResponse_defaults - The default values for fields when a task is created by referencing this template.

UpdateTaskTemplate, updateTaskTemplateResponse_description - The description of the task template.

UpdateTaskTemplate, updateTaskTemplateResponse_fields - Fields that are part of the template.

UpdateTaskTemplateResponse, updateTaskTemplateResponse_id - The identifier of the task template resource.

UpdateTaskTemplate, updateTaskTemplateResponse_instanceId - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

UpdateTaskTemplateResponse, updateTaskTemplateResponse_lastModifiedTime - The timestamp when the task template was last modified.

UpdateTaskTemplate, updateTaskTemplateResponse_name - The name of the task template.

UpdateTaskTemplate, updateTaskTemplateResponse_status - Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

$sel:httpStatus:UpdateTaskTemplateResponse', updateTaskTemplateResponse_httpStatus - The response's http status code.

Response Lenses

updateTaskTemplateResponse_arn :: Lens' UpdateTaskTemplateResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the task template resource.

updateTaskTemplateResponse_constraints :: Lens' UpdateTaskTemplateResponse (Maybe TaskTemplateConstraints) Source #

Constraints that are applicable to the fields listed.

updateTaskTemplateResponse_contactFlowId :: Lens' UpdateTaskTemplateResponse (Maybe Text) Source #

The identifier of the flow that runs by default when a task is created by referencing this template.

updateTaskTemplateResponse_createdTime :: Lens' UpdateTaskTemplateResponse (Maybe UTCTime) Source #

The timestamp when the task template was created.

updateTaskTemplateResponse_defaults :: Lens' UpdateTaskTemplateResponse (Maybe TaskTemplateDefaults) Source #

The default values for fields when a task is created by referencing this template.

updateTaskTemplateResponse_description :: Lens' UpdateTaskTemplateResponse (Maybe Text) Source #

The description of the task template.

updateTaskTemplateResponse_fields :: Lens' UpdateTaskTemplateResponse (Maybe [TaskTemplateField]) Source #

Fields that are part of the template.

updateTaskTemplateResponse_id :: Lens' UpdateTaskTemplateResponse (Maybe Text) Source #

The identifier of the task template resource.

updateTaskTemplateResponse_instanceId :: Lens' UpdateTaskTemplateResponse (Maybe Text) Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

updateTaskTemplateResponse_lastModifiedTime :: Lens' UpdateTaskTemplateResponse (Maybe UTCTime) Source #

The timestamp when the task template was last modified.

updateTaskTemplateResponse_name :: Lens' UpdateTaskTemplateResponse (Maybe Text) Source #

The name of the task template.

updateTaskTemplateResponse_status :: Lens' UpdateTaskTemplateResponse (Maybe TaskTemplateStatus) Source #

Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

updateTaskTemplateResponse_httpStatus :: Lens' UpdateTaskTemplateResponse Int Source #

The response's http status code.