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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets details about a specific task template in the specified Amazon Connect instance.

Synopsis

data GetTaskTemplate = GetTaskTemplate' {
- snapshotVersion :: Maybe Text
- instanceId :: Text
- taskTemplateId :: Text
}
newGetTaskTemplate :: Text -> Text -> GetTaskTemplate
getTaskTemplate_snapshotVersion :: Lens' GetTaskTemplate (Maybe Text)
getTaskTemplate_instanceId :: Lens' GetTaskTemplate Text
getTaskTemplate_taskTemplateId :: Lens' GetTaskTemplate Text
data GetTaskTemplateResponse = GetTaskTemplateResponse' {
- constraints :: Maybe TaskTemplateConstraints
- contactFlowId :: Maybe Text
- createdTime :: Maybe POSIX
- defaults :: Maybe TaskTemplateDefaults
- description :: Maybe Text
- fields :: Maybe [TaskTemplateField]
- instanceId :: Maybe Text
- lastModifiedTime :: Maybe POSIX
- status :: Maybe TaskTemplateStatus
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
- id :: Text
- arn :: Text
- name :: Text
}
newGetTaskTemplateResponse :: Int -> Text -> Text -> Text -> GetTaskTemplateResponse
getTaskTemplateResponse_constraints :: Lens' GetTaskTemplateResponse (Maybe TaskTemplateConstraints)
getTaskTemplateResponse_contactFlowId :: Lens' GetTaskTemplateResponse (Maybe Text)
getTaskTemplateResponse_createdTime :: Lens' GetTaskTemplateResponse (Maybe UTCTime)
getTaskTemplateResponse_defaults :: Lens' GetTaskTemplateResponse (Maybe TaskTemplateDefaults)
getTaskTemplateResponse_description :: Lens' GetTaskTemplateResponse (Maybe Text)
getTaskTemplateResponse_fields :: Lens' GetTaskTemplateResponse (Maybe [TaskTemplateField])
getTaskTemplateResponse_instanceId :: Lens' GetTaskTemplateResponse (Maybe Text)
getTaskTemplateResponse_lastModifiedTime :: Lens' GetTaskTemplateResponse (Maybe UTCTime)
getTaskTemplateResponse_status :: Lens' GetTaskTemplateResponse (Maybe TaskTemplateStatus)
getTaskTemplateResponse_tags :: Lens' GetTaskTemplateResponse (Maybe (HashMap Text Text))
getTaskTemplateResponse_httpStatus :: Lens' GetTaskTemplateResponse Int
getTaskTemplateResponse_id :: Lens' GetTaskTemplateResponse Text
getTaskTemplateResponse_arn :: Lens' GetTaskTemplateResponse Text
getTaskTemplateResponse_name :: Lens' GetTaskTemplateResponse Text

Creating a Request

data GetTaskTemplate Source #

See: newGetTaskTemplate smart constructor.

Constructors

GetTaskTemplate'
Fields snapshotVersion :: Maybe Text The system generated version of a task template that is associated with a task, when the task is created. instanceId :: Text The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. taskTemplateId :: Text A unique identifier for the task template.

Instances

Instances details

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

newGetTaskTemplate Source #

Arguments

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

Create a value of GetTaskTemplate 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:snapshotVersion:GetTaskTemplate', getTaskTemplate_snapshotVersion - The system generated version of a task template that is associated with a task, when the task is created.

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

$sel:taskTemplateId:GetTaskTemplate', getTaskTemplate_taskTemplateId - A unique identifier for the task template.

Request Lenses

getTaskTemplate_snapshotVersion :: Lens' GetTaskTemplate (Maybe Text) Source #

The system generated version of a task template that is associated with a task, when the task is created.

getTaskTemplate_instanceId :: Lens' GetTaskTemplate Text Source #

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

getTaskTemplate_taskTemplateId :: Lens' GetTaskTemplate Text Source #

A unique identifier for the task template.

Destructuring the Response

data GetTaskTemplateResponse Source #

See: newGetTaskTemplateResponse smart constructor.

Constructors

GetTaskTemplateResponse'

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.
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.
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.
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.
tags :: Maybe (HashMap Text Text)
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
httpStatus :: Int
The response's http status code.
id :: Text
A unique identifier for the task template.
arn :: Text
The Amazon Resource Name (ARN).
name :: Text
The name of the task template.

Instances

Instances details

Generic GetTaskTemplateResponse Source #
Instance details Defined in Amazonka.Connect.GetTaskTemplate Associated Types type Rep GetTaskTemplateResponse :: Type -> Type # Methods from :: GetTaskTemplateResponse -> Rep GetTaskTemplateResponse x # to :: Rep GetTaskTemplateResponse x -> GetTaskTemplateResponse #
Read GetTaskTemplateResponse Source #
Instance details Defined in Amazonka.Connect.GetTaskTemplate Methods readsPrec :: Int -> ReadS GetTaskTemplateResponse # readList :: ReadS [GetTaskTemplateResponse] # readPrec :: ReadPrec GetTaskTemplateResponse # readListPrec :: ReadPrec [GetTaskTemplateResponse] #
Show GetTaskTemplateResponse Source #
Instance details Defined in Amazonka.Connect.GetTaskTemplate Methods showsPrec :: Int -> GetTaskTemplateResponse -> ShowS # show :: GetTaskTemplateResponse -> String # showList :: [GetTaskTemplateResponse] -> ShowS #
NFData GetTaskTemplateResponse Source #
Instance details Defined in Amazonka.Connect.GetTaskTemplate Methods rnf :: GetTaskTemplateResponse -> () #
Eq GetTaskTemplateResponse Source #
Instance details Defined in Amazonka.Connect.GetTaskTemplate Methods (==) :: GetTaskTemplateResponse -> GetTaskTemplateResponse -> Bool # (/=) :: GetTaskTemplateResponse -> GetTaskTemplateResponse -> Bool #
type Rep GetTaskTemplateResponse Source #
Instance details Defined in Amazonka.Connect.GetTaskTemplate type Rep GetTaskTemplateResponse = D1 ('MetaData "GetTaskTemplateResponse" "Amazonka.Connect.GetTaskTemplate" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "GetTaskTemplateResponse'" '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 "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 "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaskTemplateStatus)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :: ((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) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newGetTaskTemplateResponse Source #

Arguments

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

Create a value of GetTaskTemplateResponse 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:constraints:GetTaskTemplateResponse', getTaskTemplateResponse_constraints - Constraints that are applicable to the fields listed.

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

GetTaskTemplateResponse, getTaskTemplateResponse_createdTime - The timestamp when the task template was created.

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

GetTaskTemplateResponse, getTaskTemplateResponse_description - The description of the task template.

$sel:fields:GetTaskTemplateResponse', getTaskTemplateResponse_fields - Fields that are part of the template.

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

GetTaskTemplateResponse, getTaskTemplateResponse_lastModifiedTime - The timestamp when the task template was last modified.

GetTaskTemplateResponse, getTaskTemplateResponse_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.

GetTaskTemplateResponse, getTaskTemplateResponse_tags - The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

$sel:httpStatus:GetTaskTemplateResponse', getTaskTemplateResponse_httpStatus - The response's http status code.

GetTaskTemplateResponse, getTaskTemplateResponse_id - A unique identifier for the task template.

GetTaskTemplateResponse, getTaskTemplateResponse_arn - The Amazon Resource Name (ARN).

GetTaskTemplateResponse, getTaskTemplateResponse_name - The name of the task template.

Response Lenses

getTaskTemplateResponse_constraints :: Lens' GetTaskTemplateResponse (Maybe TaskTemplateConstraints) Source #

Constraints that are applicable to the fields listed.

getTaskTemplateResponse_contactFlowId :: Lens' GetTaskTemplateResponse (Maybe Text) Source #

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

getTaskTemplateResponse_createdTime :: Lens' GetTaskTemplateResponse (Maybe UTCTime) Source #

The timestamp when the task template was created.

getTaskTemplateResponse_defaults :: Lens' GetTaskTemplateResponse (Maybe TaskTemplateDefaults) Source #

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

getTaskTemplateResponse_description :: Lens' GetTaskTemplateResponse (Maybe Text) Source #

The description of the task template.

getTaskTemplateResponse_fields :: Lens' GetTaskTemplateResponse (Maybe [TaskTemplateField]) Source #

Fields that are part of the template.

getTaskTemplateResponse_instanceId :: Lens' GetTaskTemplateResponse (Maybe Text) Source #

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

getTaskTemplateResponse_lastModifiedTime :: Lens' GetTaskTemplateResponse (Maybe UTCTime) Source #

The timestamp when the task template was last modified.

getTaskTemplateResponse_status :: Lens' GetTaskTemplateResponse (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.

getTaskTemplateResponse_tags :: Lens' GetTaskTemplateResponse (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

getTaskTemplateResponse_httpStatus :: Lens' GetTaskTemplateResponse Int Source #

The response's http status code.

getTaskTemplateResponse_id :: Lens' GetTaskTemplateResponse Text Source #

A unique identifier for the task template.

getTaskTemplateResponse_arn :: Lens' GetTaskTemplateResponse Text Source #

The Amazon Resource Name (ARN).

getTaskTemplateResponse_name :: Lens' GetTaskTemplateResponse Text Source #

The name of the task template.