Connect / Client / get_task_template
get_task_template#
- Connect.Client.get_task_template(**kwargs)#
Gets details about a specific task template in the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
response = client.get_task_template( InstanceId='string', TaskTemplateId='string', SnapshotVersion='string' )
- Parameters:
InstanceId (string) –
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
TaskTemplateId (string) –
[REQUIRED]
A unique identifier for the task template.
SnapshotVersion (string) – The system generated version of a task template that is associated with a task, when the task is created.
- Return type:
dict
- Returns:
Response Syntax
{ 'InstanceId': 'string', 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'Description': 'string', 'ContactFlowId': 'string', 'SelfAssignFlowId': 'string', 'Constraints': { 'RequiredFields': [ { 'Id': { 'Name': 'string' } }, ], 'ReadOnlyFields': [ { 'Id': { 'Name': 'string' } }, ], 'InvisibleFields': [ { 'Id': { 'Name': 'string' } }, ] }, 'Defaults': { 'DefaultFieldValues': [ { 'Id': { 'Name': 'string' }, 'DefaultValue': 'string' }, ] }, 'Fields': [ { 'Id': { 'Name': 'string' }, 'Description': 'string', 'Type': 'NAME'|'DESCRIPTION'|'SCHEDULED_TIME'|'QUICK_CONNECT'|'URL'|'NUMBER'|'TEXT'|'TEXT_AREA'|'DATE_TIME'|'BOOLEAN'|'SINGLE_SELECT'|'EMAIL'|'SELF_ASSIGN'|'EXPIRY_DURATION', 'SingleSelectOptions': [ 'string', ] }, ], 'Status': 'ACTIVE'|'INACTIVE', 'LastModifiedTime': datetime(2015, 1, 1), 'CreatedTime': datetime(2015, 1, 1), 'Tags': { 'string': 'string' } }
Response Structure
(dict) –
InstanceId (string) –
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Id (string) –
A unique identifier for the task template.
Arn (string) –
The Amazon Resource Name (ARN).
Name (string) –
The name of the task template.
Description (string) –
The description of the task template.
ContactFlowId (string) –
The identifier of the flow that runs by default when a task is created by referencing this template.
SelfAssignFlowId (string) –
Constraints (dict) –
Constraints that are applicable to the fields listed.
RequiredFields (list) –
Lists the fields that are required to be filled by agents.
(dict) –
Information about a required field.
Id (dict) –
The unique identifier for the field.
Name (string) –
The name of the task template field.
ReadOnlyFields (list) –
Lists the fields that are read-only to agents, and cannot be edited.
(dict) –
Indicates a field that is read-only to an agent.
Id (dict) –
Identifier of the read-only field.
Name (string) –
The name of the task template field.
InvisibleFields (list) –
Lists the fields that are invisible to agents.
(dict) –
A field that is invisible to an agent.
Id (dict) –
Identifier of the invisible field.
Name (string) –
The name of the task template field.
Defaults (dict) –
The default values for fields when a task is created by referencing this template.
DefaultFieldValues (list) –
Default value for the field.
(dict) –
Describes a default field and its corresponding value.
Id (dict) –
Identifier of a field.
Name (string) –
The name of the task template field.
DefaultValue (string) –
Default value for the field.
Fields (list) –
Fields that are part of the template.
(dict) –
Describes a single task template field.
Id (dict) –
The unique identifier for the field.
Name (string) –
The name of the task template field.
Description (string) –
The description of the field.
Type (string) –
Indicates the type of field.
SingleSelectOptions (list) –
A list of options for a single select field.
(string) –
Status (string) –
Marks a template as
ACTIVE
orINACTIVE
for a task to refer to it. Tasks can only be created fromACTIVE
templates. If a template is marked asINACTIVE
, then a task that refers to this template cannot be created.LastModifiedTime (datetime) –
The timestamp when the task template was last modified.
CreatedTime (datetime) –
The timestamp when the task template was created.
Tags (dict) –
The tags used to organize, track, or control access for this resource. For example, { “Tags”: {“key1”:”value1”, “key2”:”value2”} }.
(string) –
(string) –
Exceptions
Connect.Client.exceptions.InvalidRequestException
Connect.Client.exceptions.InvalidParameterException
Connect.Client.exceptions.ResourceNotFoundException
Connect.Client.exceptions.ThrottlingException
Connect.Client.exceptions.InternalServiceException