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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists task templates for the specified Amazon Connect instance.

This operation returns paginated results.

Synopsis

data ListTaskTemplates = ListTaskTemplates' {
- maxResults :: Maybe Natural
- name :: Maybe Text
- nextToken :: Maybe Text
- status :: Maybe TaskTemplateStatus
- instanceId :: Text
}
newListTaskTemplates :: Text -> ListTaskTemplates
listTaskTemplates_maxResults :: Lens' ListTaskTemplates (Maybe Natural)
listTaskTemplates_name :: Lens' ListTaskTemplates (Maybe Text)
listTaskTemplates_nextToken :: Lens' ListTaskTemplates (Maybe Text)
listTaskTemplates_status :: Lens' ListTaskTemplates (Maybe TaskTemplateStatus)
listTaskTemplates_instanceId :: Lens' ListTaskTemplates Text
data ListTaskTemplatesResponse = ListTaskTemplatesResponse' {
- nextToken :: Maybe Text
- taskTemplates :: Maybe [TaskTemplateMetadata]
- httpStatus :: Int
}
newListTaskTemplatesResponse :: Int -> ListTaskTemplatesResponse
listTaskTemplatesResponse_nextToken :: Lens' ListTaskTemplatesResponse (Maybe Text)
listTaskTemplatesResponse_taskTemplates :: Lens' ListTaskTemplatesResponse (Maybe [TaskTemplateMetadata])
listTaskTemplatesResponse_httpStatus :: Lens' ListTaskTemplatesResponse Int

Creating a Request

data ListTaskTemplates Source #

See: newListTaskTemplates smart constructor.

Constructors

ListTaskTemplates'

Fields

maxResults :: Maybe Natural
The maximum number of results to return per page.
It is not expected that you set this.
name :: Maybe Text
The name of the task template.
nextToken :: Maybe Text
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
It is not expected that you set this because the value returned in the previous response is always null.
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.

Instances

Instances details

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

newListTaskTemplates Source #

Arguments

:: Text	`ListTaskTemplates`
-> ListTaskTemplates

Create a value of ListTaskTemplates 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:maxResults:ListTaskTemplates', listTaskTemplates_maxResults - The maximum number of results to return per page.

It is not expected that you set this.

ListTaskTemplates, listTaskTemplates_name - The name of the task template.

ListTaskTemplates, listTaskTemplates_nextToken - The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

It is not expected that you set this because the value returned in the previous response is always null.

ListTaskTemplates, listTaskTemplates_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.

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

Request Lenses

listTaskTemplates_maxResults :: Lens' ListTaskTemplates (Maybe Natural) Source #

The maximum number of results to return per page.

It is not expected that you set this.

listTaskTemplates_name :: Lens' ListTaskTemplates (Maybe Text) Source #

The name of the task template.

listTaskTemplates_nextToken :: Lens' ListTaskTemplates (Maybe Text) Source #

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

It is not expected that you set this because the value returned in the previous response is always null.

listTaskTemplates_status :: Lens' ListTaskTemplates (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.

listTaskTemplates_instanceId :: Lens' ListTaskTemplates Text Source #

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

Destructuring the Response

data ListTaskTemplatesResponse Source #

See: newListTaskTemplatesResponse smart constructor.

Constructors

ListTaskTemplatesResponse'
Fields nextToken :: Maybe Text If there are additional results, this is the token for the next set of results. This is always returned as a null in the response. taskTemplates :: Maybe [TaskTemplateMetadata] Provides details about a list of task templates belonging to an instance. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListTaskTemplatesResponse Source #

Arguments

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

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

ListTaskTemplates, listTaskTemplatesResponse_nextToken - If there are additional results, this is the token for the next set of results.

This is always returned as a null in the response.

$sel:taskTemplates:ListTaskTemplatesResponse', listTaskTemplatesResponse_taskTemplates - Provides details about a list of task templates belonging to an instance.

$sel:httpStatus:ListTaskTemplatesResponse', listTaskTemplatesResponse_httpStatus - The response's http status code.

Response Lenses

listTaskTemplatesResponse_nextToken :: Lens' ListTaskTemplatesResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

This is always returned as a null in the response.

listTaskTemplatesResponse_taskTemplates :: Lens' ListTaskTemplatesResponse (Maybe [TaskTemplateMetadata]) Source #

Provides details about a list of task templates belonging to an instance.

listTaskTemplatesResponse_httpStatus :: Lens' ListTaskTemplatesResponse Int Source #

The response's http status code.