2022/06/02 - Amazon Connect Service - 6 new 3 updated api methods
Changes This release adds the following features: 1) New APIs to manage (create, list, update) task template resources, 2) Updates to startTaskContact API to support task templates, and 3) new TransferContact API to programmatically transfer in-progress tasks via a contact flow.
Gets details about a specific task template in the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
client.get_task_template(
InstanceId='string',
TaskTemplateId='string',
SnapshotVersion='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
string
[REQUIRED]
A unique identifier for the task template.
string
The system generated version of a task template that is associated with a task, when the task is created.
dict
Response Syntax
{
'InstanceId': 'string',
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'Description': 'string',
'ContactFlowId': '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',
'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 instanceId in the 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.
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 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.
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.
(string) --
(string) --
Updates details about a specific task template in the specified Amazon Connect instance. This operation does not support partial updates. Instead it does a full update of template content.
See also: AWS API Documentation
Request Syntax
client.update_task_template(
TaskTemplateId='string',
InstanceId='string',
Name='string',
Description='string',
ContactFlowId='string',
Constraints={
'RequiredFields': [
{
'Id': {
'Name': 'string'
}
},
],
'ReadOnlyFields': [
{
'Id': {
'Name': 'string'
}
},
],
'InvisibleFields': [
{
'Id': {
'Name': 'string'
}
},
]
},
Defaults={
'DefaultFieldValues': [
{
'Id': {
'Name': 'string'
},
'DefaultValue': 'string'
},
]
},
Status='ACTIVE'|'INACTIVE',
Fields=[
{
'Id': {
'Name': 'string'
},
'Description': 'string',
'Type': 'NAME'|'DESCRIPTION'|'SCHEDULED_TIME'|'QUICK_CONNECT'|'URL'|'NUMBER'|'TEXT'|'TEXT_AREA'|'DATE_TIME'|'BOOLEAN'|'SINGLE_SELECT'|'EMAIL',
'SingleSelectOptions': [
'string',
]
},
]
)
string
[REQUIRED]
A unique identifier for the task template.
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
string
The name of the task template.
string
The description of the task template.
string
The identifier of the flow that runs by default when a task is created by referencing this template.
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.
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.
string
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.
list
Fields that are part of the template.
(dict) --
Describes a single task template field.
Id (dict) -- [REQUIRED]
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) --
dict
Response Syntax
{
'InstanceId': 'string',
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'Description': 'string',
'ContactFlowId': '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',
'SingleSelectOptions': [
'string',
]
},
],
'Status': 'ACTIVE'|'INACTIVE',
'LastModifiedTime': datetime(2015, 1, 1),
'CreatedTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
InstanceId (string) --
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Id (string) --
The identifier of the task template resource.
Arn (string) --
The Amazon Resource Name (ARN) for the task template resource.
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.
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 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.
LastModifiedTime (datetime) --
The timestamp when the task template was last modified.
CreatedTime (datetime) --
The timestamp when the task template was created.
Lists task templates for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
client.list_task_templates(
InstanceId='string',
NextToken='string',
MaxResults=123,
Status='ACTIVE'|'INACTIVE',
Name='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
string
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.
Warning
It is not expected that you set this because the value returned in the previous response is always null.
integer
The maximum number of results to return per page.
Warning
It is not expected that you set this.
string
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.
string
The name of the task template.
dict
Response Syntax
{
'TaskTemplates': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'Description': 'string',
'Status': 'ACTIVE'|'INACTIVE',
'LastModifiedTime': datetime(2015, 1, 1),
'CreatedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TaskTemplates (list) --
Provides details about a list of task templates belonging to an instance.
(dict) --
Contains summary information about the task template.
Id (string) --
A unique identifier for the task template.
Arn (string) --
The Amazon Resource Name (ARN) of the task template.
Name (string) --
The name of the task template.
Description (string) --
The description of the task template.
Status (string) --
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.
LastModifiedTime (datetime) --
The timestamp when the task template was last modified.
CreatedTime (datetime) --
The timestamp when the task template was created.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Warning
This is always returned as a null in the response.
Creates a new task template in the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
client.create_task_template(
InstanceId='string',
Name='string',
Description='string',
ContactFlowId='string',
Constraints={
'RequiredFields': [
{
'Id': {
'Name': 'string'
}
},
],
'ReadOnlyFields': [
{
'Id': {
'Name': 'string'
}
},
],
'InvisibleFields': [
{
'Id': {
'Name': 'string'
}
},
]
},
Defaults={
'DefaultFieldValues': [
{
'Id': {
'Name': 'string'
},
'DefaultValue': 'string'
},
]
},
Status='ACTIVE'|'INACTIVE',
Fields=[
{
'Id': {
'Name': 'string'
},
'Description': 'string',
'Type': 'NAME'|'DESCRIPTION'|'SCHEDULED_TIME'|'QUICK_CONNECT'|'URL'|'NUMBER'|'TEXT'|'TEXT_AREA'|'DATE_TIME'|'BOOLEAN'|'SINGLE_SELECT'|'EMAIL',
'SingleSelectOptions': [
'string',
]
},
],
ClientToken='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
string
[REQUIRED]
The name of the task template.
string
The description of the task template.
string
The identifier of the flow that runs by default when a task is created by referencing this template.
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.
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.
string
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.
list
[REQUIRED]
Fields that are part of the template.
(dict) --
Describes a single task template field.
Id (dict) -- [REQUIRED]
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) --
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'Id': 'string',
'Arn': 'string'
}
Response Structure
(dict) --
Id (string) --
The identifier of the task template resource.
Arn (string) --
The Amazon Resource Name (ARN) for the task template resource.
Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the contact flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers.
Note the following requirements:
Transfer is supported for only TASK contacts.
Do not use both QueueId and UserId in the same call.
The following contact flow types are supported: Inbound contact flow, Transfer to agent flow, and Transfer to queue flow.
The TransferContact API can be called only on active contacts.
A contact cannot be transferred more than 11 times.
See also: AWS API Documentation
Request Syntax
client.transfer_contact(
InstanceId='string',
ContactId='string',
QueueId='string',
UserId='string',
ContactFlowId='string',
ClientToken='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
string
[REQUIRED]
The identifier of the contact in this instance of Amazon Connect
string
The identifier for the queue.
string
The identifier for the user.
string
[REQUIRED]
The identifier of the contact flow.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ContactId': 'string',
'ContactArn': 'string'
}
Response Structure
(dict) --
ContactId (string) --
The identifier of the contact in this instance of Amazon Connect
ContactArn (string) --
The Amazon Resource Name (ARN) of the contact.
Deletes the task template.
See also: AWS API Documentation
Request Syntax
client.delete_task_template(
InstanceId='string',
TaskTemplateId='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
string
[REQUIRED]
A unique identifier for the task template.
dict
Response Syntax
{}
Response Structure
(dict) --
{'ReferenceTypes': {'NUMBER', 'DATE', 'EMAIL', 'STRING'}}
Response {'ReferenceSummaryList': {'Date': {'Name': 'string', 'Value': 'string'},
'Email': {'Name': 'string', 'Value': 'string'},
'Number': {'Name': 'string', 'Value': 'string'},
'String': {'Name': 'string', 'Value': 'string'}}}
This API is in preview release for Amazon Connect and is subject to change.
For the specified referenceTypes , returns a list of references associated with the contact.
See also: AWS API Documentation
Request Syntax
client.list_contact_references(
InstanceId='string',
ContactId='string',
ReferenceTypes=[
'URL'|'ATTACHMENT'|'NUMBER'|'STRING'|'DATE'|'EMAIL',
],
NextToken='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
string
[REQUIRED]
The identifier of the initial contact.
list
[REQUIRED]
The type of reference.
(string) --
string
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.
Warning
This is not expected to be set, because the value returned in the previous response is always null.
dict
Response Syntax
{
'ReferenceSummaryList': [
{
'Url': {
'Name': 'string',
'Value': 'string'
},
'Attachment': {
'Name': 'string',
'Value': 'string',
'Status': 'APPROVED'|'REJECTED'
},
'String': {
'Name': 'string',
'Value': 'string'
},
'Number': {
'Name': 'string',
'Value': 'string'
},
'Date': {
'Name': 'string',
'Value': 'string'
},
'Email': {
'Name': 'string',
'Value': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ReferenceSummaryList (list) --
Information about the contact flows.
(dict) --
Contains summary information about a reference. ReferenceSummary contains only one non null field between the URL and attachment based on the reference type.
Url (dict) --
Information about the reference when the referenceType is URL . Otherwise, null.
Name (string) --
Identifier of the URL reference.
Value (string) --
A valid URL.
Attachment (dict) --
Information about the reference when the referenceType is ATTACHMENT . Otherwise, null.
Name (string) --
Identifier of the attachment reference.
Value (string) --
The location path of the attachment reference.
Status (string) --
Status of the attachment reference type.
String (dict) --
Information about a reference when the referenceType is STRING . Otherwise, null.
Name (string) --
Identifier of the string reference.
Value (string) --
A valid string.
Number (dict) --
Information about a reference when the referenceType is NUMBER . Otherwise, null.
Name (string) --
Identifier of the number reference.
Value (string) --
A valid number.
Date (dict) --
Information about a reference when the referenceType is DATE . Otherwise, null.
Name (string) --
Identifier of the date reference.
Value (string) --
A valid date.
Email (dict) --
Information about a reference when the referenceType is EMAIL . Otherwise, null.
Name (string) --
Identifier of the email reference.
Value (string) --
A valid email address.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Warning
This is always returned as null in the response.
{'QuickConnectId': 'string',
'References': {'Type': {'NUMBER', 'DATE', 'EMAIL', 'STRING'}},
'TaskTemplateId': 'string'}
Initiates a contact flow to start a new task.
See also: AWS API Documentation
Request Syntax
client.start_task_contact(
InstanceId='string',
PreviousContactId='string',
ContactFlowId='string',
Attributes={
'string': 'string'
},
Name='string',
References={
'string': {
'Value': 'string',
'Type': 'URL'|'ATTACHMENT'|'NUMBER'|'STRING'|'DATE'|'EMAIL'
}
},
Description='string',
ClientToken='string',
ScheduledTime=datetime(2015, 1, 1),
TaskTemplateId='string',
QuickConnectId='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
string
The identifier of the previous chat, voice, or task contact.
string
The identifier of the contact flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing , Contact Flows . Choose the contact flow. On the contact flow page, under the name of the contact flow, choose Show additional flow information . The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
dict
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
(string) --
(string) --
string
[REQUIRED]
The name of a task that is shown to an agent in the Contact Control Panel (CCP).
dict
A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
(string) --
(dict) --
Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.
Value (string) -- [REQUIRED]
A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).
Type (string) -- [REQUIRED]
The type of the reference.
string
A description of the task that is shown to an agent in the Contact Control Panel (CCP).
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
datetime
The timestamp, in Unix Epoch seconds format, at which to start running the inbound contact flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.
string
A unique identifier for the task template.
string
The identifier for the quick connect.
dict
Response Syntax
{
'ContactId': 'string'
}
Response Structure
(dict) --
ContactId (string) --
The identifier of this contact within the Amazon Connect instance.
{'References': {'Type': {'NUMBER', 'DATE', 'EMAIL', 'STRING'}}}
This API is in preview release for Amazon Connect and is subject to change.
Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.
Warning
You can add or update user-defined contact information for both ongoing and completed contacts.
See also: AWS API Documentation
Request Syntax
client.update_contact(
InstanceId='string',
ContactId='string',
Name='string',
Description='string',
References={
'string': {
'Value': 'string',
'Type': 'URL'|'ATTACHMENT'|'NUMBER'|'STRING'|'DATE'|'EMAIL'
}
}
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
string
[REQUIRED]
The identifier of the contact. This is the identifier of the contact associated with the first interaction with your contact center.
string
The name of the contact.
string
The description of the contact.
dict
Well-formed data on contact, shown to agents on Contact Control Panel (CCP).
(string) --
(dict) --
Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.
Value (string) -- [REQUIRED]
A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).
Type (string) -- [REQUIRED]
The type of the reference.
dict
Response Syntax
{}
Response Structure
(dict) --