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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new task template in the specified Amazon Connect instance.

Synopsis

data CreateTaskTemplate = CreateTaskTemplate' {
- clientToken :: Maybe Text
- constraints :: Maybe TaskTemplateConstraints
- contactFlowId :: Maybe Text
- defaults :: Maybe TaskTemplateDefaults
- description :: Maybe Text
- status :: Maybe TaskTemplateStatus
- instanceId :: Text
- name :: Text
- fields :: [TaskTemplateField]
}
newCreateTaskTemplate :: Text -> Text -> CreateTaskTemplate
createTaskTemplate_clientToken :: Lens' CreateTaskTemplate (Maybe Text)
createTaskTemplate_constraints :: Lens' CreateTaskTemplate (Maybe TaskTemplateConstraints)
createTaskTemplate_contactFlowId :: Lens' CreateTaskTemplate (Maybe Text)
createTaskTemplate_defaults :: Lens' CreateTaskTemplate (Maybe TaskTemplateDefaults)
createTaskTemplate_description :: Lens' CreateTaskTemplate (Maybe Text)
createTaskTemplate_status :: Lens' CreateTaskTemplate (Maybe TaskTemplateStatus)
createTaskTemplate_instanceId :: Lens' CreateTaskTemplate Text
createTaskTemplate_name :: Lens' CreateTaskTemplate Text
createTaskTemplate_fields :: Lens' CreateTaskTemplate [TaskTemplateField]
data CreateTaskTemplateResponse = CreateTaskTemplateResponse' {
- httpStatus :: Int
- id :: Text
- arn :: Text
}
newCreateTaskTemplateResponse :: Int -> Text -> Text -> CreateTaskTemplateResponse
createTaskTemplateResponse_httpStatus :: Lens' CreateTaskTemplateResponse Int
createTaskTemplateResponse_id :: Lens' CreateTaskTemplateResponse Text
createTaskTemplateResponse_arn :: Lens' CreateTaskTemplateResponse Text

Creating a Request

data CreateTaskTemplate Source #

See: newCreateTaskTemplate smart constructor.

Constructors

CreateTaskTemplate'

Fields

clientToken :: Maybe Text
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
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.
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.
instanceId :: Text
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
name :: Text
The name of the task template.
fields :: [TaskTemplateField]
Fields that are part of the template.

Instances

Instances details

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

newCreateTaskTemplate Source #

Arguments

:: Text	`CreateTaskTemplate`
-> Text	`CreateTaskTemplate`
-> CreateTaskTemplate

Create a value of CreateTaskTemplate 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:clientToken:CreateTaskTemplate', createTaskTemplate_clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

$sel:constraints:CreateTaskTemplate', createTaskTemplate_constraints - Constraints that are applicable to the fields listed.

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

$sel:defaults:CreateTaskTemplate', createTaskTemplate_defaults - The default values for fields when a task is created by referencing this template.

CreateTaskTemplate, createTaskTemplate_description - The description of the task template.

CreateTaskTemplate, createTaskTemplate_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.

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

CreateTaskTemplate, createTaskTemplate_name - The name of the task template.

$sel:fields:CreateTaskTemplate', createTaskTemplate_fields - Fields that are part of the template.

Request Lenses

createTaskTemplate_clientToken :: Lens' CreateTaskTemplate (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

createTaskTemplate_constraints :: Lens' CreateTaskTemplate (Maybe TaskTemplateConstraints) Source #

Constraints that are applicable to the fields listed.

createTaskTemplate_contactFlowId :: Lens' CreateTaskTemplate (Maybe Text) Source #

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

createTaskTemplate_defaults :: Lens' CreateTaskTemplate (Maybe TaskTemplateDefaults) Source #

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

createTaskTemplate_description :: Lens' CreateTaskTemplate (Maybe Text) Source #

The description of the task template.

createTaskTemplate_status :: Lens' CreateTaskTemplate (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.

createTaskTemplate_instanceId :: Lens' CreateTaskTemplate Text Source #

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

createTaskTemplate_name :: Lens' CreateTaskTemplate Text Source #

The name of the task template.

createTaskTemplate_fields :: Lens' CreateTaskTemplate [TaskTemplateField] Source #

Fields that are part of the template.

Destructuring the Response

data CreateTaskTemplateResponse Source #

See: newCreateTaskTemplateResponse smart constructor.

Constructors

CreateTaskTemplateResponse'
Fields httpStatus :: Int The response's http status code. id :: Text The identifier of the task template resource. arn :: Text The Amazon Resource Name (ARN) for the task template resource.

Instances

Instances details

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

newCreateTaskTemplateResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateTaskTemplateResponse'`
-> Text	`CreateTaskTemplateResponse`
-> Text	`CreateTaskTemplateResponse`
-> CreateTaskTemplateResponse

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

CreateTaskTemplateResponse, createTaskTemplateResponse_id - The identifier of the task template resource.

CreateTaskTemplateResponse, createTaskTemplateResponse_arn - The Amazon Resource Name (ARN) for the task template resource.

Response Lenses

createTaskTemplateResponse_httpStatus :: Lens' CreateTaskTemplateResponse Int Source #

The response's http status code.

createTaskTemplateResponse_id :: Lens' CreateTaskTemplateResponse Text Source #

The identifier of the task template resource.

createTaskTemplateResponse_arn :: Lens' CreateTaskTemplateResponse Text Source #

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