Skip to content

List Task Templates

connect_list_task_templates R Documentation

Lists task templates for the specified Amazon Connect instance

Description

Lists task templates for the specified Amazon Connect instance.

Usage

connect_list_task_templates(InstanceId, NextToken, MaxResults, Status,
  Name)

Arguments

InstanceId

[required] The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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.

MaxResults

The maximum number of results to return per page.

It is not expected that you set this.

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.

Name

The name of the task template.

Value

A list with the following syntax: 

list(
  TaskTemplates = list(
    list(
      Id = "string",
      Arn = "string",
      Name = "string",
      Description = "string",
      Status = "ACTIVE"|"INACTIVE",
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      ),
      CreatedTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_task_templates(
  InstanceId = "string",
  NextToken = "string",
  MaxResults = 123,
  Status = "ACTIVE"|"INACTIVE",
  Name = "string"
)