Studio Project workflows for Amazon Connect agents, queues, routing profiles, and contact flows
Amazon Connect is AWS's cloud-based contact center service, providing telephony, chat, and task management along with the agents, queues, routing profiles, and contact flows used to run a customer contact center.
This project provides OpenAPI specs for automating against the Amazon Connect API via an Integration Model. The -latest spec is a curated subset covering common CRUD for contact center automation — see OpenAPIs below.
| Asset | Description |
|---|---|
| OpenAPIs/ | Amazon Connect API OpenAPI specs — curated -latest plus the full dated spec |
| Studio Projects/Amazon Connect | 25 workflows covering common CRUD automation |
| Requirement | Version |
|---|---|
| Itential Platform | 6.x |
| Amazon Connect | API version 2017-08-08 |
| Amazon Connect Integration Model | Required to build automation against the OpenAPI specs |
Import one of the OpenAPI specs from OpenAPIs/ as an Integration Model in Admin > Integrations, then create an integration pointing at the Amazon Connect API endpoint for your AWS region.
Authentication is AWS Signature Version 4 — requests are signed using an AWS access key ID and secret access key:
Authorization: AWS4-HMAC-SHA256 Credential=<access-key-id>/<date>/<region>/connect/aws4_request, SignedHeaders=..., Signature=... Generate an access key ID and secret access key for an IAM user or role with the required Amazon Connect permissions in the AWS IAM console.
The instance's authentication/server properties should look like this once configured:
{
"authentication": {
"hmac": {
"accessKeyId": "<your-aws-access-key-id>",
"secretAccessKey": "<your-aws-secret-access-key>",
"sessionToken": ""
}
},
"server": {
"protocol": "https",
"host": "connect.us-east-1.amazonaws.com",
"base_path": ""
}
} | Spec | Version | Operations | Description |
|---|---|---|---|
amazon_connect-latest.json | latest (curated) | 96 | Actively-maintained, trimmed to 96 of 255 upstream operations covering common CRUD for automation — see breakdown below |
amazon_connect-2017-08-08.json | 2017-08-08 | 255 | Full spec for Amazon Connect API version 2017-08-08 (255 operations). |
amazon_connect-latest.jsonActively-maintained spec (x-vendor-api-version: 2017-08-08). Trimmed to 96 of 255 upstream operations covering common CRUD for automation.
Resources included, by category:
Not included: real-time and historical metrics/reporting, custom vocabularies (Contact Lens transcription), traffic distribution groups (multi-region resiliency), contact automation rules, Lex/Amazon Lex V2 bot and Lambda function associations, instance storage/security-key/approved-origin/integration-association configuration, task templates, chat participant and contact-monitoring/recording/streaming controls, federation tokens, and the Search* filtering variants of the list operations above. Pull the full spec below if you need one of these.
amazon_connect-2017-08-08.jsonFull spec for Amazon Connect API version 2017-08-08 (255 operations) — the entire upstream API surface as AWS defines it. See amazon_connect-latest.json above for the curated subset if you just need common CRUD automation.
Backed by the Amazon Connect:latest Integration Model (see amazon_connect-latest.json above). The project contains 25 workflows organized into 6 folders, one atomic workflow per API operation, covering the common-CRUD subset of the curated spec.
| Folder | Workflows | Scope |
|---|---|---|
| Instances | List, Create, Describe, Delete Instance | Instance lifecycle |
| Users | List, Create, Describe, Update Identity Info, Delete User | User lifecycle |
| Queues | List, Create, Describe, Update Name | Queue management |
| Routing Profiles | List, Create, Describe, Update Name | Routing profile management |
| Contact Flows | List, Create, Describe, Update Content, Delete Contact Flow | Contact flow lifecycle |
| Contact Lifecycle | Start Task Contact, Stop Contact, Transfer Contact | Core contact operations |
| Dependency | Notes |
|---|---|
Amazon Connect:latest Integration Model | Import from amazon_connect-latest.json before importing the project |
Amazon Connect integration instance | Create in Admin > Integrations with the connection properties above. Workflows are wired to an integration instance named Amazon Connect — update the adapter_id value in each workflow task if yours is named differently |