Amazon Connect

App · 18 actions

Run your Amazon Connect contact center from workflows: place calls, create tasks, save details on contacts, check how busy queues are and add agents. Start a workflow when a contact starts or ends, a user is added, or a queue gets busy.

Actions

ActionWhat it does
Change user's routing profileMove a user to another routing profile, changing which queues and channels they take contacts from.
Create taskCreate a task for your agents, with links and details, routed by a flow like any other contact.
Create userAdd a user, such as a new agent, with a routing profile and security profiles.
Delete userDelete a user from the instance.
End contactEnd a call, chat, task or queued callback.
Get contactGet a call, chat or task: who it was with, its queue and agent, when it started and ended, and its attributes.
Get contact attributesGet the attributes saved on a contact, such as what the caller chose in a menu or a note an earlier step added.
Get queueGet a queue's settings: whether it's on, its hours and its outbound caller ID.
Get queue metricsSee how busy queues are right now: contacts waiting, the longest wait, and how many agents are online and available.
Get userGet a user's name, email, routing profile, security profiles and phone settings.
List flowsList the flows in an instance, by type.
List instancesList your Amazon Connect instances in the connection's Region.
List queuesList the queues in an instance.
List routing profilesList the routing profiles in an instance: which queues and channels agents take contacts from.
List usersList the users (agents, supervisors and admins) in an instance.
Search contactsFind calls, chats and tasks in a time range, by channel, queue, agent or how they started.
Start outbound callCall a phone number from Amazon Connect and run a flow, which can play a message or put the call in a queue for an agent.
Update contact attributesAdd or change attributes on a contact, during or after it, such as a CRM account or a reason for the call.

Change user's routing profile

Move a user to another routing profile, changing which queues and channels they take contacts from.

Inputs

Instanceinstance_idtextRequired
Your Amazon Connect instance. Pick one, or give its id or ARN.
Userconnect_user_idtextRequired
The Amazon Connect user (agent). Pick one, or give their id or ARN.
Routing profilerouting_profile_idtextRequired
Which queues and channels the user takes contacts from. Pick one, or give its id or ARN.

Outputs

routing_profile_idtext
Their routing profile now
updatedtrue/false
Always true once done
user_idtext
The user
Example output
{
  "routing_profile_id": "a1b2c3d4-5678-90ab-cdef-555555555555",
  "updated": true,
  "user_id": "a1b2c3d4-5678-90ab-cdef-444444444444"
}

Create task

Create a task for your agents, with links and details, routed by a flow like any other contact. It can be scheduled up to 6 days ahead.

Inputs

Instanceinstance_idtextRequired
Your Amazon Connect instance. Pick one, or give its id or ARN.
Task namenametextRequired
What agents see as the task's title.
Flowcontact_flow_idtextRequired
The flow to run, as published in Amazon Connect. Pick one, or give its id or ARN.
Descriptiondescriptiontext
Details agents see with the task.
Linkslinksobject
Names and web addresses agents can open, such as Order = https://shop.example.com/orders/1001.
Contact attributescontact_attributesobject
Names and values your flows and agents can read, such as account = A-1001. Names may use letters, digits, - and _.
Start atscheduled_timedate and time
When the task reaches agents. Leave blank for now.
Linked contactprevious_contact_idtext
A contact this task follows on from, by its id.

Outputs

contact_idtext
The task's contact id
nametext
The task's name
Example output
{
  "contact_id": "a1b2c3d4-5678-90ab-cdef-666666666666",
  "name": "Call back about order 1001"
}

Create user

Add a user, such as a new agent, with a routing profile and security profiles. They get the Agent security profile unless you choose others.

Inputs

Instanceinstance_idtextRequired
Your Amazon Connect instance. Pick one, or give its id or ARN.
User nameusernametextRequired
What they sign in with: letters, digits and . _ - @, up to 20 characters (64 with SAML).
Routing profilerouting_profile_idtextRequired
Which queues and channels the user takes contacts from. Pick one, or give its id or ARN.
First namefirst_nametext
Needed unless your instance signs in through a directory.
Last namelast_nametext
Needed unless your instance signs in through a directory.
Emailemailtext
Their email address.
Passwordpasswordtext
Needed when people sign in with an Amazon Connect user name and password; leave blank with SAML or a directory. 8 to 64 characters with a capital, a small letter and a digit.
Security profilessecurity_profile_idslist
What they may do in Amazon Connect. Defaults to Agent.
Phonephone_typetext
How they take calls. Defaults to softphone.One of: SOFT_PHONE (Softphone, in the browser (default)), DESK_PHONE (Desk phone). Default: SOFT_PHONE.
Desk phone numberdesk_phone_numbertext
Their desk phone, with + and the country code, for Desk phone.

Outputs

arntext
Their ARN
security_profile_idslist
The security profiles they got
user_idtext
The new user's id
usernametext
Their user name
Example output
{
  "arn": "arn:aws:connect:us-east-1:123456789012:instance/a1b2c3d4-5678-90ab-cdef-111111111111/agent/a1b2c3d4-5678-90ab-cdef-444444444444",
  "security_profile_ids": [
    "a1b2c3d4-5678-90ab-cdef-999999999999"
  ],
  "user_id": "a1b2c3d4-5678-90ab-cdef-444444444444",
  "username": "jdoe"
}

Delete user

Delete a user from the instance. They can no longer sign in; their past contacts are kept.

Inputs

Instanceinstance_idtextRequired
Your Amazon Connect instance. Pick one, or give its id or ARN.
Userconnect_user_idtextRequired
The Amazon Connect user (agent). Pick one, or give their id or ARN.

Outputs

deletedtrue/false
Always true once done
user_idtext
The user deleted
Example output
{
  "deleted": true,
  "user_id": "a1b2c3d4-5678-90ab-cdef-444444444444"
}

End contact

End a call, chat, task or queued callback. A transferred call can't be ended this way.

Inputs

Instanceinstance_idtextRequired
Your Amazon Connect instance. Pick one, or give its id or ARN.
Contactcontact_idtextRequired
The contact's id, from an earlier step or a trigger.

Outputs

contact_idtext
The contact ended
stoppedtrue/false
Always true once done
Example output
{
  "contact_id": "a1b2c3d4-5678-90ab-cdef-666666666666",
  "stopped": true
}

Get contact

Get a call, chat or task: who it was with, its queue and agent, when it started and ended, and its attributes.

Inputs

Instanceinstance_idtextRequired
Your Amazon Connect instance. Pick one, or give its id or ARN.
Contactcontact_idtextRequired
The contact's id, from an earlier step or a trigger.

Outputs

contactobject
The contact
Example output
{
  "contact": {
    "agent_id": "a1b2c3d4-5678-90ab-cdef-444444444444",
    "arn": "arn:aws:connect:us-east-1:123456789012:instance/a1b2c3d4-5678-90ab-cdef-111111111111/contact/a1b2c3d4-5678-90ab-cdef-666666666666",
    "attributes": {
      "account": "A-1001"
    },
    "channel": "VOICE",
    "connected_to_agent_at": "2026-11-18T10:01:05Z",
    "contact_id": "a1b2c3d4-5678-90ab-cdef-666666666666",
    "customer_address": "+14155550123",
    "customer_address_type": "TELEPHONE_NUMBER",
    "description": null,
    "disconnect_reason": "CUSTOMER_DISCONNECT",
    "disconnected_at": "2026-11-18T10:07:41Z",
    "enqueued_at": "2026-11-18T10:00:20Z",
    "initial_contact_id": "a1b2c3d4-5678-90ab-cdef-666666666666",
    "initiated_at": "2026-11-18T10:00:00Z",
    "initiation_method": "INBOUND",
    "last_updated_at": "2026-11-18T10:07:41Z",
    "name": null,
    "previous_contact_id": null,
    "queue_id": "a1b2c3d4-5678-90ab-cdef-222222222222",
    "scheduled_at": null,
    "system_address": "+18005550199",
    "tags": {}
  }
}

Get contact attributes

Get the attributes saved on a contact, such as what the caller chose in a menu or a note an earlier step added.

Inputs

Instanceinstance_idtextRequired
Your Amazon Connect instance. Pick one, or give its id or ARN.
Contactcontact_idtextRequired
The contact's id, from an earlier step or a trigger.

Outputs

attributesobject
Its attributes, name to value
contact_idtext
The contact
Example output
{
  "attributes": {
    "account": "A-1001"
  },
  "contact_id": "a1b2c3d4-5678-90ab-cdef-666666666666"
}

Get queue

Get a queue's settings: whether it's on, its hours and its outbound caller ID.

Inputs

Instanceinstance_idtextRequired
Your Amazon Connect instance. Pick one, or give its id or ARN.
Queuequeue_idtextRequired
The queue. Pick one, or give its id or ARN.

Outputs

queueobject
The queue
Example output
{
  "queue": {
    "arn": "arn:aws:connect:us-east-1:123456789012:instance/a1b2c3d4-5678-90ab-cdef-111111111111/queue/a1b2c3d4-5678-90ab-cdef-222222222222",
    "description": "Customer support",
    "hours_of_operation_id": "a1b2c3d4-5678-90ab-cdef-777777777777",
    "last_modified_at": "2026-10-01T12:00:00Z",
    "max_contacts": 0,
    "name": "BasicQueue",
    "outbound_caller_id_name": "Acme Support",
    "outbound_caller_id_number_id": "a1b2c3d4-5678-90ab-cdef-888888888888",
    "outbound_flow_id": null,
    "queue_id": "a1b2c3d4-5678-90ab-cdef-222222222222",
    "status": "ENABLED",
    "tags": {}
  }
}

Get queue metrics

See how busy queues are right now: contacts waiting, the longest wait, and how many agents are online and available.

Inputs

Instanceinstance_idtextRequired
Your Amazon Connect instance. Pick one, or give its id or ARN.
Queuesqueue_idslist
The queues to check. Leave blank for all (up to 100).
Channelschannelslist
Only these channels. Leave blank for all.One or more of: VOICE (Calls), CHAT (Chats), TASK (Tasks).

Outputs

checked_attext
When Amazon Connect took the figures (ISO 8601)
countnumber
How many were returned
queueslist
One row per queue
Example output
{
  "checked_at": "2026-11-18T10:05:00Z",
  "count": 1,
  "queues": [
    {
      "agents_after_contact_work": 0,
      "agents_available": 1,
      "agents_on_contact": 4,
      "agents_online": 5,
      "agents_staffed": 5,
      "contacts_scheduled": 0,
      "contacts_waiting": 3,
      "longest_wait_seconds": 145,
      "queue_id": "a1b2c3d4-5678-90ab-cdef-222222222222",
      "queue_name": "BasicQueue"
    }
  ]
}

Get user

Get a user's name, email, routing profile, security profiles and phone settings.

Inputs

Instanceinstance_idtextRequired
Your Amazon Connect instance. Pick one, or give its id or ARN.
Userconnect_user_idtextRequired
The Amazon Connect user (agent). Pick one, or give their id or ARN.

Outputs

userobject
The user
Example output
{
  "user": {
    "after_contact_work_seconds": 0,
    "arn": "arn:aws:connect:us-east-1:123456789012:instance/a1b2c3d4-5678-90ab-cdef-111111111111/agent/a1b2c3d4-5678-90ab-cdef-444444444444",
    "auto_accept": false,
    "desk_phone_number": null,
    "email": "jane.doe@example.com",
    "first_name": "Jane",
    "hierarchy_group_id": null,
    "last_modified_at": "2026-10-01T12:00:00Z",
    "last_name": "Doe",
    "mobile": null,
    "phone_type": "SOFT_PHONE",
    "routing_profile_id": "a1b2c3d4-5678-90ab-cdef-555555555555",
    "secondary_email": null,
    "security_profile_ids": [
      "a1b2c3d4-5678-90ab-cdef-999999999999"
    ],
    "tags": {},
    "user_id": "a1b2c3d4-5678-90ab-cdef-444444444444",
    "username": "jdoe"
  }
}

List flows

List the flows in an instance, by type. Defaults to inbound flows, the kind calls and tasks start with.

Inputs

Instanceinstance_idtextRequired
Your Amazon Connect instance. Pick one, or give its id or ARN.
Typesflow_typeslist
Which kinds of flow. Defaults to inbound flows.One or more of: CONTACT_FLOW (Inbound flows (default)), CUSTOMER_QUEUE (Customer queue flows), CUSTOMER_HOLD (Customer hold flows), CUSTOMER_WHISPER (Customer whisper flows), AGENT_HOLD (Agent hold flows), AGENT_WHISPER (Agent whisper flows), OUTBOUND_WHISPER (Outbound whisper flows), AGENT_TRANSFER (Transfer to agent flows), QUEUE_TRANSFER (Transfer to queue flows), CAMPAIGN (Campaign flows).
Max resultsmax_resultsnumber
How many to return, 1 to 1000. Defaults to 100.From 1 to 1000. Default: 100.

Outputs

countnumber
How many were returned
flowslist
The flows
Example output
{
  "count": 1,
  "flows": [
    {
      "arn": "arn:aws:connect:us-east-1:123456789012:instance/a1b2c3d4-5678-90ab-cdef-111111111111/contact-flow/a1b2c3d4-5678-90ab-cdef-333333333333",
      "flow_id": "a1b2c3d4-5678-90ab-cdef-333333333333",
      "name": "Default inbound",
      "state": "ACTIVE",
      "status": "PUBLISHED",
      "type": "CONTACT_FLOW"
    }
  ]
}

List instances

List your Amazon Connect instances in the connection's Region.

Inputs

None.

Outputs

countnumber
How many were returned
instanceslist
The instances
Example output
{
  "count": 1,
  "instances": [
    {
      "access_url": "https://acme-support.my.connect.aws",
      "alias": "acme-support",
      "arn": "arn:aws:connect:us-east-1:123456789012:instance/a1b2c3d4-5678-90ab-cdef-111111111111",
      "created_at": "2026-01-12T09:00:00Z",
      "identity_management": "CONNECT_MANAGED",
      "inbound_calls_enabled": true,
      "instance_id": "a1b2c3d4-5678-90ab-cdef-111111111111",
      "outbound_calls_enabled": true,
      "status": "ACTIVE"
    }
  ]
}

List queues

List the queues in an instance.

Inputs

Instanceinstance_idtextRequired
Your Amazon Connect instance. Pick one, or give its id or ARN.
Max resultsmax_resultsnumber
How many to return, 1 to 1000. Defaults to 100.From 1 to 1000. Default: 100.

Outputs

countnumber
How many were returned
queueslist
The queues
Example output
{
  "count": 1,
  "queues": [
    {
      "arn": "arn:aws:connect:us-east-1:123456789012:instance/a1b2c3d4-5678-90ab-cdef-111111111111/queue/a1b2c3d4-5678-90ab-cdef-222222222222",
      "last_modified_at": "2026-10-01T12:00:00Z",
      "name": "BasicQueue",
      "queue_id": "a1b2c3d4-5678-90ab-cdef-222222222222",
      "type": "STANDARD"
    }
  ]
}

List routing profiles

List the routing profiles in an instance: which queues and channels agents take contacts from.

Inputs

Instanceinstance_idtextRequired
Your Amazon Connect instance. Pick one, or give its id or ARN.
Max resultsmax_resultsnumber
How many to return, 1 to 1000. Defaults to 100.From 1 to 1000. Default: 100.

Outputs

countnumber
How many were returned
routing_profileslist
The routing profiles
Example output
{
  "count": 1,
  "routing_profiles": [
    {
      "arn": "arn:aws:connect:us-east-1:123456789012:instance/a1b2c3d4-5678-90ab-cdef-111111111111/routing-profile/a1b2c3d4-5678-90ab-cdef-555555555555",
      "last_modified_at": "2026-10-01T12:00:00Z",
      "name": "Basic Routing Profile",
      "routing_profile_id": "a1b2c3d4-5678-90ab-cdef-555555555555"
    }
  ]
}

List users

List the users (agents, supervisors and admins) in an instance.

Inputs

Instanceinstance_idtextRequired
Your Amazon Connect instance. Pick one, or give its id or ARN.
Max resultsmax_resultsnumber
How many to return, 1 to 1000. Defaults to 100.From 1 to 1000. Default: 100.

Outputs

countnumber
How many were returned
userslist
The users
Example output
{
  "count": 1,
  "users": [
    {
      "arn": "arn:aws:connect:us-east-1:123456789012:instance/a1b2c3d4-5678-90ab-cdef-111111111111/agent/a1b2c3d4-5678-90ab-cdef-444444444444",
      "last_modified_at": "2026-10-01T12:00:00Z",
      "user_id": "a1b2c3d4-5678-90ab-cdef-444444444444",
      "username": "jdoe"
    }
  ]
}

Search contacts

Find calls, chats and tasks in a time range, by channel, queue, agent or how they started. Newest first.

Inputs

Instanceinstance_idtextRequired
Your Amazon Connect instance. Pick one, or give its id or ARN.
Fromstart_timedate and time
Start of the range. Defaults to 24 hours ago.
Toend_timedate and time
End of the range. Defaults to now.
Contacts thattime_typetext
Which time falls in the range. Defaults to Started.One of: INITIATION_TIMESTAMP (Started), DISCONNECT_TIMESTAMP (Ended), CONNECTED_TO_AGENT_TIMESTAMP (Reached an agent), ENQUEUE_TIMESTAMP (Joined a queue), SCHEDULED_TIMESTAMP (Scheduled for). Default: INITIATION_TIMESTAMP.
Channelschannelslist
Only these channels. Leave blank for all.One or more of: VOICE (Calls), CHAT (Chats), TASK (Tasks).
Queuesqueue_idslist
Only contacts in these queues. Leave blank for all.
Agentsagent_idslist
Only contacts these users took. Leave blank for all.
How they startedinitiation_methodslist
Only contacts started these ways. Leave blank for all.One or more of: INBOUND, OUTBOUND (Outbound, dialled by an agent), API (Started from the API (calls and tasks from workflows)), TRANSFER, QUEUE_TRANSFER (Queue transfer), CALLBACK, DISCONNECT (Disconnect flow), FLOW (Started by a flow).
Max resultsmax_resultsnumber
How many to return, 1 to 1000. Defaults to 100.From 1 to 1000. Default: 100.

Outputs

contactslist
The contacts found
countnumber
How many were returned
totalnumber
How many match in all, which can be more than returned
Example output
{
  "contacts": [
    {
      "agent_id": "a1b2c3d4-5678-90ab-cdef-444444444444",
      "arn": "arn:aws:connect:us-east-1:123456789012:instance/a1b2c3d4-5678-90ab-cdef-111111111111/contact/a1b2c3d4-5678-90ab-cdef-666666666666",
      "channel": "VOICE",
      "connected_to_agent_at": "2026-11-18T10:01:05Z",
      "contact_id": "a1b2c3d4-5678-90ab-cdef-666666666666",
      "disconnected_at": "2026-11-18T10:07:41Z",
      "enqueued_at": "2026-11-18T10:00:20Z",
      "initial_contact_id": "a1b2c3d4-5678-90ab-cdef-666666666666",
      "initiated_at": "2026-11-18T10:00:00Z",
      "initiation_method": "INBOUND",
      "name": null,
      "previous_contact_id": null,
      "queue_id": "a1b2c3d4-5678-90ab-cdef-222222222222",
      "scheduled_at": null
    }
  ],
  "count": 1,
  "total": 1
}

Start outbound call

Call a phone number from Amazon Connect and run a flow, which can play a message or put the call in a queue for an agent. Calls are billed by Amazon Connect.

Inputs

Instanceinstance_idtextRequired
Your Amazon Connect instance. Pick one, or give its id or ARN.
Phone number to calldestination_phone_numbertextRequired
With + and the country code, such as +14155550123.
Flowcontact_flow_idtextRequired
The flow to run, as published in Amazon Connect. Pick one, or give its id or ARN.
Caller ID numbercaller_id_numbertext
The instance's number the person sees. Leave blank to use the Queue's outbound caller ID instead.
Queuequeue_idtext
The queue the call belongs to; its outbound caller ID is shown when no Caller ID number is chosen.
Namenametext
A name agents see for the call.
Descriptiondescriptiontext
A note agents see for the call.
Contact attributescontact_attributesobject
Names and values your flows and agents can read, such as account = A-1001. Names may use letters, digits, - and _.
Ring forring_timeout_secondsnumber
Seconds to wait for an answer, 15 to 60. Defaults to 60.From 15 to 60.

Outputs

contact_idtext
The call's contact id
Example output
{
  "contact_id": "a1b2c3d4-5678-90ab-cdef-666666666666"
}

Update contact attributes

Add or change attributes on a contact, during or after it, such as a CRM account or a reason for the call. Attributes you leave out are kept.

Inputs

Instanceinstance_idtextRequired
Your Amazon Connect instance. Pick one, or give its id or ARN.
Contactcontact_idtextRequired
The contact's id, from an earlier step or a trigger.
Contact attributescontact_attributesobjectRequired
Names and values to save, such as account = A-1001. Names may use letters, digits, - and _.

Outputs

attributesobject
The attributes saved, as sent
contact_idtext
The contact
updatedtrue/false
Always true once saved
Example output
{
  "attributes": {
    "account": "A-1001"
  },
  "contact_id": "a1b2c3d4-5678-90ab-cdef-666666666666",
  "updated": true
}

On this page