Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetTaskTemplate

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

Request Syntax


GET /instance/InstanceId/task/template/TaskTemplateId?snapshotVersion=SnapshotVersion HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

InstanceId

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

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

SnapshotVersion

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

TaskTemplateId

A unique identifier for the task template.

Length Constraints: Minimum length of 1. Maximum length of 500.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "Constraints": { 
      "InvisibleFields": [ 
         { 
            "Id": { 
               "Name": "string"
            }
         }
      ],
      "ReadOnlyFields": [ 
         { 
            "Id": { 
               "Name": "string"
            }
         }
      ],
      "RequiredFields": [ 
         { 
            "Id": { 
               "Name": "string"
            }
         }
      ]
   },
   "ContactFlowId": "string",
   "CreatedTime": number,
   "Defaults": { 
      "DefaultFieldValues": [ 
         { 
            "DefaultValue": "string",
            "Id": { 
               "Name": "string"
            }
         }
      ]
   },
   "Description": "string",
   "Fields": [ 
      { 
         "Description": "string",
         "Id": { 
            "Name": "string"
         },
         "SingleSelectOptions": [ "string" ],
         "Type": "string"
      }
   ],
   "Id": "string",
   "InstanceId": "string",
   "LastModifiedTime": number,
   "Name": "string",
   "SelfAssignFlowId": "string",
   "Status": "string",
   "Tags": { 
      "string" : "string" 
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Arn

The Amazon Resource Name (ARN).

Type: String

Length Constraints: Minimum length of 1. Maximum length of 500.

Constraints

Constraints that are applicable to the fields listed. Although this parameter is marked as optional in the API model, the service requires it when calling CreateTaskTemplate or UpdateTaskTemplate. The RequiredFields array must contain at least one element, and the field of type NAME must be included in RequiredFields.

Type: TaskTemplateConstraints object

ContactFlowId

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

Type: String

Length Constraints: Maximum length of 500.

CreatedTime

The timestamp when the task template was created.

Type: Timestamp

Defaults

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

Type: TaskTemplateDefaults object

Description

The description of the task template.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Fields

Fields that are part of the template.

Type: Array of TaskTemplateField objects

Id

A unique identifier for the task template.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 500.

InstanceId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

LastModifiedTime

The timestamp when the task template was last modified.

Type: Timestamp

Name

The name of the task template.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

SelfAssignFlowId

The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.

Type: String

Length Constraints: Maximum length of 500.

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.

Type: String

Valid Values: ACTIVE | INACTIVE

Tags

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

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$

Value Length Constraints: Maximum length of 256.

Errors

For information about the errors that are common to all actions, see Common Error Types.

InternalServiceException

Request processing failed because of an error or failure with the service.

Message: The message.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

Message: The message about the parameters.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

Message: The message about the request.
Reason: Reason why the request was invalid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

Message: The message about the resource.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429