Amazon Connect Connect Task API
The Connect Task API from Amazon Connect — 2 operation(s) for connect task.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-connect:amazon-connect-task-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.1.0
info:
title: Amazon Connect Service Task API
version: '2017-08-08'
description: Generated from AWS's published Smithy model for Amazon Connect Service. 5 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://connect.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
paths:
/instance/{InstanceId}/task/template:
put:
operationId: CreateTaskTemplate
summary: Create Task Template
description: Creates a new task template in the specified Connect Customer instance.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTaskTemplateResponse'
'500':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
'400':
description: InvalidParameterException; PropertyValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'402':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTaskTemplateRequest'
tags:
- Task
get:
operationId: ListTaskTemplates
summary: List Task Templates
description: Lists task templates for the specified Connect Customer instance.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListTaskTemplatesResponse'
'500':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
'400':
description: InvalidParameterException; InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListTaskTemplatesRequest'
tags:
- Task
/instance/{InstanceId}/task/template/{TaskTemplateId}:
delete:
operationId: DeleteTaskTemplate
summary: Delete Task Template
description: Deletes the task template.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteTaskTemplateResponse'
'500':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
'400':
description: InvalidParameterException; InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteTaskTemplateRequest'
tags:
- Task
get:
operationId: GetTaskTemplate
summary: Get Task Template
description: Gets details about a specific task template in the specified Connect Customer instance.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetTaskTemplateResponse'
'500':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
'400':
description: InvalidParameterException; InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetTaskTemplateRequest'
tags:
- Task
post:
operationId: UpdateTaskTemplate
summary: Update Task Template
description: Updates details about a specific task template in the specified Connect Customer instance. This operation
does not support partial updates. Instead it does a full update of template content.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTaskTemplateResponse'
'500':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
'400':
description: InvalidParameterException; PropertyValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'402':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTaskTemplateRequest'
tags:
- Task
components:
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: connect
schemas:
CreateTaskTemplateRequest:
type: object
properties:
InstanceId:
type: string
description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
Name (ARN) of the instance.
Name:
type: string
description: The name of the task template.
Description:
type: string
description: The description of the task template.
ContactFlowId:
type: string
description: The identifier of the flow that runs by default when a task is created by referencing this template.
Although this parameter is marked as optional, the request must contain either a ContactFlowId or a field of type
QUICK_CONNECT.
SelfAssignFlowId:
type: string
description: The ContactFlowId for the flow that will be run if this template is used to create a self-assigned
task.
Constraints:
$ref: '#/components/schemas/TaskTemplateConstraints'
Defaults:
$ref: '#/components/schemas/TaskTemplateDefaults'
Status:
type: string
enum:
- ACTIVE
- INACTIVE
description: 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.
Fields:
type: array
items:
$ref: '#/components/schemas/TaskTemplateField'
description: Fields that are part of the template. The request must contain exactly one field of type NAME. This
field must also be listed in the RequiredFields array within the Constraints parameter.
ClientToken:
type: string
description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not
provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making
retries safe with idempotent APIs.
required:
- InstanceId
- Name
- Fields
CreateTaskTemplateResponse:
type: object
properties:
Id:
type: string
description: The identifier of the task template resource.
Arn:
type: string
description: The Amazon Resource Name (ARN) for the task template resource.
required:
- Id
- Arn
DeleteTaskTemplateRequest:
type: object
properties:
InstanceId:
type: string
description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
Name (ARN) of the instance.
TaskTemplateId:
type: string
description: A unique identifier for the task template.
required:
- InstanceId
- TaskTemplateId
DeleteTaskTemplateResponse:
type: object
properties: {}
GetTaskTemplateRequest:
type: object
properties:
InstanceId:
type: string
description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
Name (ARN) of the instance.
TaskTemplateId:
type: string
description: A unique identifier for the task template.
SnapshotVersion:
type: string
description: The system generated version of a task template that is associated with a task, when the task is created.
required:
- InstanceId
- TaskTemplateId
GetTaskTemplateResponse:
type: object
properties:
InstanceId:
type: string
description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
Name (ARN) of the instance.
Id:
type: string
description: A unique identifier for the task template.
Arn:
type: string
description: The Amazon Resource Name (ARN).
Name:
type: string
description: The name of the task template.
Description:
type: string
description: The description of the task template.
ContactFlowId:
type: string
description: The identifier of the flow that runs by default when a task is created by referencing this template.
SelfAssignFlowId:
type: string
description: The ContactFlowId for the flow that will be run if this template is used to create a self-assigned
task.
Constraints:
$ref: '#/components/schemas/TaskTemplateConstraints'
Defaults:
$ref: '#/components/schemas/TaskTemplateDefaults'
Fields:
type: array
items:
$ref: '#/components/schemas/TaskTemplateField'
description: Fields that are part of the template.
Status:
type: string
enum:
- ACTIVE
- INACTIVE
description: 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:
type: string
format: date-time
description: The timestamp when the task template was last modified.
CreatedTime:
type: string
format: date-time
description: The timestamp when the task template was created.
Tags:
type: object
additionalProperties:
type: string
description: 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1",
"key2":"value2"} }.'
required:
- Id
- Arn
- Name
InternalServiceException:
type: object
properties:
Message:
type: string
description: The message.
InvalidParameterException:
type: object
properties:
Message:
type: string
description: The message about the parameters.
InvisibleFieldInfo:
type: object
properties:
Id:
$ref: '#/components/schemas/TaskTemplateFieldIdentifier'
ListTaskTemplatesRequest:
type: object
properties:
InstanceId:
type: string
description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
Name (ARN) of the instance.
NextToken:
type: string
description: 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:
type: integer
description: The maximum number of results to return per page. It is not expected that you set this.
Status:
type: string
enum:
- ACTIVE
- INACTIVE
description: 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:
type: string
description: The name of the task template.
required:
- InstanceId
ListTaskTemplatesResponse:
type: object
properties:
TaskTemplates:
type: array
items:
$ref: '#/components/schemas/TaskTemplateMetadata'
description: Provides details about a list of task templates belonging to an instance.
NextToken:
type: string
description: 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.
ReadOnlyFieldInfo:
type: object
properties:
Id:
$ref: '#/components/schemas/TaskTemplateFieldIdentifier'
RequiredFieldInfo:
type: object
properties:
Id:
$ref: '#/components/schemas/TaskTemplateFieldIdentifier'
ResourceNotFoundException:
type: object
properties:
Message:
type: string
description: The message about the resource.
ServiceQuotaExceededException:
type: object
properties:
Message:
type: string
Reason:
$ref: '#/components/schemas/ServiceQuotaExceededExceptionReason'
ServiceQuotaExceededExceptionReason:
type: object
properties:
AttachedFileServiceQuotaExceededExceptionReason:
type: string
enum:
- TOTAL_FILE_SIZE_EXCEEDED
- TOTAL_FILE_COUNT_EXCEEDED
description: Total file size of all files or total number of files exceeds the service quota
description: Exactly one member is set.
TaskTemplateConstraints:
type: object
properties:
RequiredFields:
type: array
items:
$ref: '#/components/schemas/RequiredFieldInfo'
description: Lists the fields that are required to be filled by agents.
ReadOnlyFields:
type: array
items:
$ref: '#/components/schemas/ReadOnlyFieldInfo'
description: Lists the fields that are read-only to agents, and cannot be edited.
InvisibleFields:
type: array
items:
$ref: '#/components/schemas/InvisibleFieldInfo'
description: Lists the fields that are invisible to agents.
TaskTemplateDefaultFieldValue:
type: object
properties:
Id:
$ref: '#/components/schemas/TaskTemplateFieldIdentifier'
DefaultValue:
type: string
description: Default value for the field.
TaskTemplateDefaults:
type: object
properties:
DefaultFieldValues:
type: array
items:
$ref: '#/components/schemas/TaskTemplateDefaultFieldValue'
description: Default value for the field.
TaskTemplateField:
type: object
properties:
Id:
$ref: '#/components/schemas/TaskTemplateFieldIdentifier'
Description:
type: string
description: The description of the field.
Type:
type: string
enum:
- NAME
- DESCRIPTION
- SCHEDULED_TIME
- QUICK_CONNECT
- URL
- NUMBER
- TEXT
- TEXT_AREA
- DATE_TIME
- BOOLEAN
- SINGLE_SELECT
- EMAIL
- SELF_ASSIGN
- EXPIRY_DURATION
description: Indicates the type of field.
SingleSelectOptions:
type: array
items:
type: string
description: A list of options for a single select field.
required:
- Id
TaskTemplateFieldIdentifier:
type: object
properties:
Name:
type: string
description: The name of the task template field.
TaskTemplateMetadata:
type: object
properties:
Id:
type: string
description: A unique identifier for the task template.
Arn:
type: string
description: The Amazon Resource Name (ARN) of the task template.
Name:
type: string
description: The name of the task template.
Description:
type: string
description: The description of the task template.
Status:
type: string
enum:
- ACTIVE
- INACTIVE
description: 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:
type: string
format: date-time
description: The timestamp when the task template was last modified.
CreatedTime:
type: string
format: date-time
description: The timestamp when the task template was created.
ThrottlingException:
type: object
properties:
Message:
type: string
UpdateTaskTemplateRequest:
type: object
properties:
TaskTemplateId:
type: string
description: A unique identifier for the task template.
InstanceId:
type: string
description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
Name (ARN) of the instance.
Name:
type: string
description: The name of the task template.
Description:
type: string
description: The description of the task template.
ContactFlowId:
type: string
description: The identifier of the flow that runs by default when a task is created by referencing this template.
Although this parameter is marked as optional, the request must contain either a ContactFlowId or a field of type
QUICK_CONNECT.
SelfAssignFlowId:
type: string
description: The ContactFlowId for the flow that will be run if this template is used to create a self-assigned
task.
Constraints:
$ref: '#/components/schemas/TaskTemplateConstraints'
Defaults:
$ref: '#/components/schemas/TaskTemplateDefaults'
Status:
type: string
enum:
- ACTIVE
- INACTIVE
description: 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. Although
this parameter is marked as optional, the service requires it when calling UpdateTaskTemplate.
Fields:
type: array
items:
$ref: '#/components/schemas/TaskTemplateField'
description: Fields that are part of the template. The request must contain exactly one field of type NAME. This
field must also be listed in the RequiredFields array within the Constraints parameter.
required:
- TaskTemplateId
- InstanceId
UpdateTaskTemplateResponse:
type: object
properties:
InstanceId:
type: string
description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
Name (ARN) of the instance.
Id:
type: string
description: The identifier of the task template resource.
Arn:
type: string
description: The Amazon Resource Name (ARN) for the task template resource.
Name:
type: string
description: The name of the task template.
Description:
type: string
description: The description of the task template.
ContactFlowId:
type: string
description: The identifier of the flow that runs by default when a task is created by referencing this template.
SelfAssignFlowId:
type: string
description: The ContactFlowId for the flow that will be run if this template is used to create a self-assigned
task.
Constraints:
$ref: '#/components/schemas/TaskTemplateConstraints'
Defaults:
$ref: '#/components/schemas/TaskTemplateDefaults'
Fields:
type: array
items:
$ref: '#/components/schemas/TaskTemplateField'
description: Fields that are part of the template.
Status:
type: string
enum:
- ACTIVE
- INACTIVE
description: 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:
type: string
format: date-time
description: The timestamp when the task template was last modified.
CreatedTime:
type: string
format: date-time
description: The timestamp when the task template was created.
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/connect/service/2017-08-08/connect-2017-08-08.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)