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 |
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' {}
- 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.
ListTaskTemplates' | |
|
Instances
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.
ListTaskTemplatesResponse' | |
|
Instances
newListTaskTemplatesResponse Source #
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.