Amazon Connect website screenshot

Amazon Connect

Amazon Connect is a cloud-based contact center service that makes it easy to set up and manage a customer contact center and provide reliable customer engagement at any scale, with omnichannel support for voice, chat, email, and task management. It includes AI-powered features for agent assistance, customer profiles, conversation analytics, and outbound campaign management.

11 APIs 10 Features
ChatContact CenterCustomer ServiceVoiceAIOmnichannel

APIs

Amazon Connect Service API

The Amazon Connect Service API provides programmatic access to manage contact center instances, users, routing profiles, contact flows, queues, hours of operation, security prof...

Amazon Connect Streams SDK

Amazon Connect Streams is a browser-based integration API and JavaScript SDK that enables embedding and controlling the Amazon Connect Contact Control Panel (CCP) within your we...

Amazon AppIntegrations API

The Amazon AppIntegrations service enables you to configure and reuse connections to external applications, powering third-party integrations in the Amazon Connect agent workspace.

Amazon Connect Contact Lens API

Amazon Connect Contact Lens enables you to analyze conversations between customers and agents using speech transcription, natural language processing, and intelligent search cap...

Amazon Connect Outbound Campaigns API

With the outbound campaigns feature of Amazon Connect, you can create high-volume outbound campaigns for appointment reminders, telemarketing, subscription renewals, or debt col...

Amazon Connect Outbound Campaigns V2 API

The outbound campaigns V2 API provides an updated interface for creating high-volume outbound campaigns including multi-channel support and availability in all Amazon Connect re...

Amazon Connect Cases API

With Amazon Connect Cases, agents can track and manage customer issues that require multiple interactions, follow-up tasks, and teams in your contact center. A case represents a...

Amazon Connect Participant Service API

The Amazon Connect Participant Service enables managing chat participants including agents, customers, and managers. Use it to send messages and events, manage connection state,...

Amazon Connect Customer Profiles API

Amazon Connect Customer Profiles provides a unified customer profile for your contact center with pre-built connectors powered by AppFlow that make it easy to combine customer i...

Amazon Q Connect API

Amazon Q in Connect is a generative AI customer service assistant built on Amazon Bedrock. It provides real-time recommendations to help contact center agents resolve customer i...

Amazon Voice ID API

Amazon Connect Voice ID provides real-time caller authentication and fraud risk detection to make voice interactions in contact centers more secure and efficient. Note - Voice I...

Collections

Arazzo Workflows

Amazon Connect Create Queue and Place Outbound Call

Create a queue against an hours schedule, confirm it, and place an outbound call into it.

ARAZZO

Amazon Connect Create Routing Profile and Assign to User

Create a routing profile with media concurrencies and assign it to an existing agent.

ARAZZO

Amazon Connect Instance Configuration Overview

Describe an instance, then inventory its contact flows and queues once it is active.

ARAZZO

Amazon Connect Provision Queue with Hours of Operation

Create an hours-of-operation schedule, build a queue that uses it, and verify the queue.

ARAZZO

Amazon Connect Provision Agent User

Create an agent user, assign a routing profile, and confirm the final account state.

ARAZZO

Amazon Connect Publish and Verify Contact Flow

Create a contact flow from flow-language content and read it back to verify it published.

ARAZZO

Amazon Connect Queue Real-Time Health

Confirm a queue is enabled, then pull live agent and in-queue metrics for it.

ARAZZO

Amazon Connect Search and Inspect Contact

Search contacts in a time range, then describe and read the attributes of the first match.

ARAZZO

Amazon Connect Start Chat Contact and Set Attributes

Start a customer chat, confirm the contact, and attach routing attributes.

ARAZZO

Amazon Connect Start Outbound Voice Contact and Track

Place an outbound voice call, then describe the contact and tag it with attributes.

ARAZZO

Amazon Connect Start Task Contact and Stop It

Create a task contact, confirm it through describe, then end the contact.

ARAZZO

Amazon Connect Update User Identity Info

Read a user, update their identity information, then re-read to confirm the change.

ARAZZO

GraphQL

Amazon Connect GraphQL Schema

This directory contains a conceptual GraphQL schema for the Amazon Connect cloud contact center platform, derived from the [Amazon Connect API Reference](https://docs.aws.amazon...

GRAPHQL

Pricing Plans

Rate Limits

Amazon Connect Rate Limits

22 limits

RATE LIMITS

FinOps

Features

Omnichannel Routing

Unified routing across voice, chat, email, and tasks through a single platform with skills-based routing and priority queuing.

AI-Powered Agent Assist

Amazon Q in Connect provides real-time AI-generated recommendations and answers to help agents resolve customer issues faster.

Contact Flows

Drag-and-drop contact flow designer for building IVR, chatbot, and agent guidance workflows without extensive coding.

Conversational Analytics

Contact Lens provides speech transcription, sentiment analysis, and NLP-powered insights across all customer interactions.

Customer Profiles

Unified customer profile combining CRM, ITSM, ERP, and contact history data for context-aware agent interactions.

Outbound Campaigns

High-volume multi-channel outbound campaigns with predictive dialer, answering machine detection, and multiple dialing modes.

Cases Management

Structured case tracking for customer issues requiring multiple interactions, follow-up tasks, and cross-team coordination.

Voice and Video Calling

In-app, web, and video calling with screen share capabilities using 16kHz high-quality audio with packet loss resistance.

Chat and Messaging

Real-time and asynchronous messaging including SMS, WhatsApp Business, and Apple Messages for Business integration.

Real-Time and Historical Metrics

Comprehensive dashboards and reporting for contact center performance optimization and workforce planning.

Use Cases

Customer Support Contact Center

Deploy an omnichannel contact center handling voice, chat, email, and messaging with intelligent routing to the right agents.

AI-Powered Self-Service

Build conversational AI flows that handle common customer requests in 30+ languages without agent involvement.

Agent Productivity Improvement

Reduce average handle time with real-time AI guidance, unified agent workspace, and automated post-contact work.

Outbound Customer Engagement

Run appointment reminders, subscription renewals, payment notifications, and telemarketing campaigns at scale.

Fraud Prevention

Use Voice ID for real-time caller authentication and fraud risk detection in voice contact center interactions.

Compliance and Quality Monitoring

Analyze 100% of customer interactions with Contact Lens for regulatory compliance and quality assurance.

Semantic Vocabularies

Amazon Connect Context

61 classes · 132 properties

JSON-LD

API Governance Rules

Amazon Connect API Rules

36 rules · 16 errors 17 warnings 3 info

SPECTRAL

JSON Structure

Agent Status Summary Structure

4 properties

JSON STRUCTURE

Amazon Connect Instance Structure

11 properties

JSON STRUCTURE

Amazon Connect Structure

0 properties

JSON STRUCTURE

Contact Flow Structure

8 properties

JSON STRUCTURE

Contact Flow Summary Structure

5 properties

JSON STRUCTURE

Contact Structure

11 properties

JSON STRUCTURE

Contact Summary Structure

6 properties

JSON STRUCTURE

Create Contact Flow Request Structure

5 properties

JSON STRUCTURE

Create Contact Flow Response Structure

2 properties

JSON STRUCTURE

Create Hours Of Operation Request Structure

5 properties

JSON STRUCTURE

Create Hours Of Operation Response Structure

2 properties

JSON STRUCTURE

Create Instance Request Structure

7 properties

JSON STRUCTURE

Create Instance Response Structure

2 properties

JSON STRUCTURE

Create Queue Request Structure

6 properties

JSON STRUCTURE

Create Queue Response Structure

2 properties

JSON STRUCTURE

Create Routing Profile Request Structure

6 properties

JSON STRUCTURE

Create Routing Profile Response Structure

2 properties

JSON STRUCTURE

Create User Request Structure

9 properties

JSON STRUCTURE

Create User Response Structure

2 properties

JSON STRUCTURE

Describe Contact Flow Response Structure

1 properties

JSON STRUCTURE

Describe Contact Response Structure

1 properties

JSON STRUCTURE

Describe Instance Response Structure

1 properties

JSON STRUCTURE

Describe Queue Response Structure

1 properties

JSON STRUCTURE

Describe Routing Profile Response Structure

1 properties

JSON STRUCTURE

Describe User Response Structure

1 properties

JSON STRUCTURE

Get Current Metric Data Request Structure

5 properties

JSON STRUCTURE

Get Current Metric Data Response Structure

3 properties

JSON STRUCTURE

Get Metric Data Request Structure

7 properties

JSON STRUCTURE

Get Metric Data Response Structure

2 properties

JSON STRUCTURE

Hours Of Operation Config Structure

3 properties

JSON STRUCTURE

Hours Of Operation Summary Structure

3 properties

JSON STRUCTURE

Hours Of Operation Time Slice Structure

2 properties

JSON STRUCTURE

Instance Structure

9 properties

JSON STRUCTURE

Instance Summary Structure

7 properties

JSON STRUCTURE

List Agent Statuses Response Structure

2 properties

JSON STRUCTURE

List Contact Flows Response Structure

2 properties

JSON STRUCTURE

List Hours Of Operations Response Structure

2 properties

JSON STRUCTURE

List Instances Response Structure

2 properties

JSON STRUCTURE

List Queues Response Structure

2 properties

JSON STRUCTURE

List Routing Profiles Response Structure

2 properties

JSON STRUCTURE

List Security Profiles Response Structure

2 properties

JSON STRUCTURE

List Users Response Structure

2 properties

JSON STRUCTURE

Media Concurrency Structure

2 properties

JSON STRUCTURE

Queue Structure

9 properties

JSON STRUCTURE

Queue Summary Structure

4 properties

JSON STRUCTURE

Routing Profile Structure

10 properties

JSON STRUCTURE

Routing Profile Summary Structure

3 properties

JSON STRUCTURE

Search Contacts Request Structure

6 properties

JSON STRUCTURE

Search Contacts Response Structure

3 properties

JSON STRUCTURE

Security Profile Summary Structure

3 properties

JSON STRUCTURE

Start Chat Contact Request Structure

7 properties

JSON STRUCTURE

Start Chat Contact Response Structure

3 properties

JSON STRUCTURE

Start Task Contact Request Structure

12 properties

JSON STRUCTURE

Update User Identity Info Request Structure

1 properties

JSON STRUCTURE

User Identity Info Structure

5 properties

JSON STRUCTURE

User Phone Config Structure

4 properties

JSON STRUCTURE

User Structure

10 properties

JSON STRUCTURE

User Summary Structure

3 properties

JSON STRUCTURE

Example Payloads

Agent Status Summary Example

4 fields

EXAMPLE

Contact Example

11 fields

EXAMPLE

Contact Flow Example

8 fields

EXAMPLE

Contact Flow Summary Example

5 fields

EXAMPLE

Contact Summary Example

6 fields

EXAMPLE

Create Queue Request Example

6 fields

EXAMPLE

Create User Request Example

9 fields

EXAMPLE

Create User Response Example

2 fields

EXAMPLE

Instance Example

9 fields

EXAMPLE

Instance Summary Example

7 fields

EXAMPLE

List Queues Response Example

2 fields

EXAMPLE

List Users Response Example

2 fields

EXAMPLE

Media Concurrency Example

2 fields

EXAMPLE

Queue Example

9 fields

EXAMPLE

Queue Summary Example

4 fields

EXAMPLE

Routing Profile Example

10 fields

EXAMPLE

User Example

10 fields

EXAMPLE

User Identity Info Example

5 fields

EXAMPLE

User Phone Config Example

4 fields

EXAMPLE

User Summary Example

3 fields

EXAMPLE

Resources

🔗
PostmanWorkspace
PostmanWorkspace
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🌐
Portal
Portal
🌐
DeveloperPortal
DeveloperPortal
🔗
Documentation
Documentation
📜
TermsOfService
TermsOfService
📜
PrivacyPolicy
PrivacyPolicy
💬
Support
Support
📰
Blog
Blog
👥
GitHubOrganization
GitHubOrganization
👥
GitHubOrganization
GitHubOrganization
🌐
Console
Console
📝
Signup
Signup
🔗
Login
Login
🟢
StatusPage
StatusPage
🔗
KnowledgeCenter
KnowledgeCenter
👥
YouTube
YouTube
👥
StackOverflow
StackOverflow
🔗
Contact
Contact
🔗
Security
Security
🔗
Compliance
Compliance
💰
Pricing
Pricing
🔗
SpectralRules
SpectralRules
🔗
Vocabulary
Vocabulary

Sources

Raw ↑
opencollection: 1.0.0
info:
  name: Amazon Connect Service API
  version: '2017-08-08'
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Instances
    type: folder
  items:
  - info:
      name: Amazon Connect List Instances
      type: http
    http:
      method: GET
      url: https://connect.amazonaws.com/instance
      params:
      - name: nextToken
        value: abc123token
        type: query
        description: The token for the next set of results.
      - name: maxResults
        value: '10'
        type: query
        description: The maximum number of results to return.
    docs: Returns a paginated list of all Amazon Connect instances associated with the AWS account.
  - info:
      name: Amazon Connect Create Instance
      type: http
    http:
      method: POST
      url: https://connect.amazonaws.com/instance
      body:
        type: json
        data: '{}'
    docs: Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such
      as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis.
  - info:
      name: Amazon Connect Describe Instance
      type: http
    http:
      method: GET
      url: https://connect.amazonaws.com/instance/:InstanceId
      params:
      - name: InstanceId
        value: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The identifier of the Amazon Connect instance.
    docs: Returns the current state of the specified Amazon Connect instance.
  - info:
      name: Amazon Connect Delete Instance
      type: http
    http:
      method: DELETE
      url: https://connect.amazonaws.com/instance/:InstanceId
      params:
      - name: InstanceId
        value: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The identifier of the Amazon Connect instance.
    docs: Deletes the Amazon Connect instance. The associated settings, data, metrics, and reports are also deleted.
- info:
    name: Users
    type: folder
  items:
  - info:
      name: Amazon Connect List Users
      type: http
    http:
      method: GET
      url: https://connect.amazonaws.com/users/:InstanceId
      params:
      - name: InstanceId
        value: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The identifier of the Amazon Connect instance.
      - name: nextToken
        value: ''
        type: query
        description: The token for the next set of results.
      - name: maxResults
        value: '50'
        type: query
        description: The maximum number of results to return.
    docs: Provides summary information about the users for the specified Amazon Connect instance.
  - info:
      name: Amazon Connect Create User
      type: http
    http:
      method: POST
      url: https://connect.amazonaws.com/users/:InstanceId
      params:
      - name: InstanceId
        value: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The identifier of the Amazon Connect instance.
      body:
        type: json
        data: '{}'
    docs: Creates a user account for the specified Amazon Connect instance.
  - info:
      name: Amazon Connect Describe User
      type: http
    http:
      method: GET
      url: https://connect.amazonaws.com/users/:InstanceId/:UserId
      params:
      - name: InstanceId
        value: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The identifier of the Amazon Connect instance.
      - name: UserId
        value: '500123'
        type: path
        description: The identifier of the user account.
    docs: Describes the specified user account.
  - info:
      name: Amazon Connect Delete User
      type: http
    http:
      method: DELETE
      url: https://connect.amazonaws.com/users/:InstanceId/:UserId
      params:
      - name: InstanceId
        value: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The identifier of the Amazon Connect instance.
      - name: UserId
        value: '500123'
        type: path
        description: The identifier of the user account.
    docs: Deletes a user account from the specified Amazon Connect instance.
  - info:
      name: Amazon Connect Update User Identity Info
      type: http
    http:
      method: POST
      url: https://connect.amazonaws.com/users/:InstanceId/:UserId/identity-info
      params:
      - name: InstanceId
        value: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The identifier of the Amazon Connect instance.
      - name: UserId
        value: '500123'
        type: path
        description: The identifier of the user account.
      body:
        type: json
        data: '{}'
    docs: Updates the identity information for the specified user in an Amazon Connect instance.
  - info:
      name: Amazon Connect Update User Routing Profile
      type: http
    http:
      method: POST
      url: https://connect.amazonaws.com/users/:InstanceId/:UserId/routing-profile
      params:
      - name: InstanceId
        value: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The identifier of the Amazon Connect instance.
      - name: UserId
        value: '500123'
        type: path
        description: The identifier of the user account.
      body:
        type: json
        data: '{}'
    docs: Assigns the specified routing profile to the specified user.
  - info:
      name: Amazon Connect Put User Status
      type: http
    http:
      method: PUT
      url: https://connect.amazonaws.com/users/:InstanceId/:UserId/status
      params:
      - name: InstanceId
        value: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The identifier of the Amazon Connect instance.
      - name: UserId
        value: '500123'
        type: path
        description: The identifier of the user account.
      body:
        type: json
        data: '{}'
    docs: Changes the current status of a user or agent in Amazon Connect. If the agent is currently handling a contact, this
      sets the agent's next status.
- info:
    name: Routing Profiles
    type: folder
  items:
  - info:
      name: Amazon Connect List Routing Profiles
      type: http
    http:
      method: GET
      url: https://connect.amazonaws.com/routing-profiles/:InstanceId
      params:
      - name: InstanceId
        value: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The identifier of the Amazon Connect instance.
      - name: nextToken
        value: ''
        type: query
      - name: maxResults
        value: '50'
        type: query
    docs: Provides summary information about the routing profiles for the specified Amazon Connect instance.
  - info:
      name: Amazon Connect Create Routing Profile
      type: http
    http:
      method: POST
      url: https://connect.amazonaws.com/routing-profiles/:InstanceId
      params:
      - name: InstanceId
        value: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The identifier of the Amazon Connect instance.
      body:
        type: json
        data: '{}'
    docs: Creates a new routing profile for the specified Amazon Connect instance.
  - info:
      name: Amazon Connect Describe Routing Profile
      type: http
    http:
      method: GET
      url: https://connect.amazonaws.com/routing-profiles/:InstanceId/:RoutingProfileId
      params:
      - name: InstanceId
        value: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The identifier of the Amazon Connect instance.
      - name: RoutingProfileId
        value: a1b2c3d4-5678-90ab-cdef-33333EXAMPLE
        type: path
        description: The identifier of the routing profile.
    docs: Describes the specified routing profile.
  - info:
      name: Amazon Connect Delete Routing Profile
      type: http
    http:
      method: DELETE
      url: https://connect.amazonaws.com/routing-profiles/:InstanceId/:RoutingProfileId
      params:
      - name: InstanceId
        value: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The identifier of the Amazon Connect instance.
      - name: RoutingProfileId
        value: a1b2c3d4-5678-90ab-cdef-33333EXAMPLE
        type: path
        description: The identifier of the routing profile.
    docs: Deletes a routing profile.
- info:
    name: Queues
    type: folder
  items:
  - info:
      name: Amazon Connect List Queues
      type: http
    http:
      method: GET
      url: https://connect.amazonaws.com/queues/:InstanceId
      params:
      - name: InstanceId
        value: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The identifier of the Amazon Connect instance.
      - name: queueTypes
        value: ''
        type: query
        description: The type of queue.
      - name: nextToken
        value: ''
        type: query
      - name: maxResults
        value: '50'
        type: query
    docs: Provides information about the queues for the specified Amazon Connect instance.
  - info:
      name: Amazon Connect Create Queue
      type: http
    http:
      method: POST
      url: https://connect.amazonaws.com/queues/:InstanceId
      params:
      - name: InstanceId
        value: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The identifier of the Amazon Connect instance.
      body:
        type: json
        data: '{}'
    docs: This API is in preview release for Amazon Connect and is subject to change. Creates a new queue for the specified
      Amazon Connect instance.
  - info:
      name: Amazon Connect Describe Queue
      type: http
    http:
      method: GET
      url: https://connect.amazonaws.com/queues/:InstanceId/:QueueId
      params:
      - name: InstanceId
        value: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The identifier of the Amazon Connect instance.
      - name: QueueId
        value: a1b2c3d4-5678-90ab-cdef-55555EXAMPLE
        type: path
        description: The identifier for the queue.
    docs: This API is in preview release for Amazon Connect and is subject to change. Describes the specified queue.
  - info:
      name: Amazon Connect Delete Queue
      type: http
    http:
      method: DELETE
      url: https://connect.amazonaws.com/queues/:InstanceId/:QueueId
      params:
      - name: InstanceId
        value: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The identifier of the Amazon Connect instance.
      - name: QueueId
        value: a1b2c3d4-5678-90ab-cdef-55555EXAMPLE
        type: path
        description: The identifier for the queue.
    docs: Deletes a queue.
- info:
    name: Contact Flows
    type: folder
  items:
  - info:
      name: Amazon Connect List Contact Flows
      type: http
    http:
      method: GET
      url: https://connect.amazonaws.com/contact-flows/:InstanceId
      params:
      - name: InstanceId
        value: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The identifier of the Amazon Connect instance.
      - name: contactFlowTypes
        value: ''
        type: query
        description: The type of contact flow.
      - name: nextToken
        value: ''
        type: query
      - name: maxResults
        value: '50'
        type: query
    docs: Provides information about the contact flows for the specified Amazon Connect instance. You can also create and
      update contact flows using the Amazon Connect Flow language.
  - info:
      name: Amazon Connect Create Contact Flow
      type: http
    http:
      method: POST
      url: https://connect.amazonaws.com/contact-flows/:InstanceId
      params:
      - name: InstanceId
        value: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The identifier of the Amazon Connect instance.
      body:
        type: json
        data: '{}'
    docs: Creates a contact flow for the specified Amazon Connect instance.
  - info:
      name: Amazon Connect Describe Contact Flow
      type: http
    http:
      method: GET
      url: https://connect.amazonaws.com/contact-flows/:InstanceId/:ContactFlowId
      params:
      - name: InstanceId
        value: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The identifier of the Amazon Connect instance.
      - name: ContactFlowId
        value: a1b2c3d4-5678-90ab-cdef-77777EXAMPLE
        type: path
        description: The identifier of the contact flow.
    docs: Describes the specified contact flow.
  - info:
      name: Amazon Connect Delete Contact Flow
      type: http
    http:
      method: DELETE
      url: https://connect.amazonaws.com/contact-flows/:InstanceId/:ContactFlowId
      params:
      - name: InstanceId
        value: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The identifier of the Amazon Connect instance.
      - name: ContactFlowId
        value: a1b2c3d4-5678-90ab-cdef-77777EXAMPLE
        type: path
        description: The identifier of the contact flow.
    docs: Deletes a contact flow for the specified Amazon Connect instance.
- info:
    name: Hours of Operations
    type: folder
  items:
  - info:
      name: Amazon Connect List Hours of Operations
      type: http
    http:
      method: GET
      url: https://connect.amazonaws.com/hours-of-operations/:InstanceId
      params:
      - name: InstanceId
        value: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The identifier of the Amazon Connect instance.
      - name: nextToken
        value: ''
        type: query
      - name: maxResults
        value: '50'
        type: query
    docs: Provides information about the hours of operation for the specified Amazon Connect instance.
  - info:
      name: Amazon Connect Create Hours of Operation
      type: http
    http:
      method: POST
      url: https://connect.amazonaws.com/hours-of-operations/:InstanceId
      params:
      - name: InstanceId
        value: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The identifier of the Amazon Connect instance.
      body:
        type: json
        data: '{}'
    docs: This API is in preview release for Amazon Connect and is subject to change. Creates hours of operation.
- info:
    name: Agent Statuses
    type: folder
  items:
  - info:
      name: Amazon Connect List Agent Statuses
      type: http
    http:
      method: GET
      url: https://connect.amazonaws.com/agent-status/:InstanceId
      params:
      - name: InstanceId
        value: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The identifier of the Amazon Connect instance.
      - name: nextToken
        value: ''
        type: query
      - name: maxResults
        value: '50'
        type: query
      - name: agentStatusTypes
        value: ''
        type: query
    docs: This API is in preview release for Amazon Connect and is subject to change. Lists agent statuses.
- info:
    name: Security Profiles
    type: folder
  items:
  - info:
      name: Amazon Connect List Security Profiles
      type: http
    http:
      method: GET
      url: https://connect.amazonaws.com/security-profiles/:InstanceId
      params:
      - name: InstanceId
        value: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The identifier of the Amazon Connect instance.
      - name: nextToken
        value: ''
        type: query
      - name: maxResults
        value: '50'
        type: query
    docs: This API is in preview release for Amazon Connect and is subject to change. Provides summary information about the
      security profiles for the specified Amazon Connect instance.
- info:
    name: Contacts
    type: folder
  items:
  - info:
      name: Amazon Connect Start Chat Contact
      type: http
    http:
      method: POST
      url: https://connect.amazonaws.com/contact/chat
      body:
        type: json
        data: '{}'
    docs: Initiates a chat contact with a customer. Response of this API provides a token required to obtain credentials from
      the CreateParticipantConnection API in the Amazon Connect Participant Service.
  - info:
      name: Amazon Connect Start Outbound Voice Contact
      type: http
    http:
      method: POST
      url: https://connect.amazonaws.com/contact/outbound-voice
      body:
        type: json
        data: '{}'
    docs: Places an outbound call to a contact, and then initiates the contact flow. It performs the actions in the contact
      flow that's specified (in ContactFlowId).
  - info:
      name: Amazon Connect Start Task Contact
      type: http
    http:
      method: POST
      url: https://connect.amazonaws.com/contact/task
      body:
        type: json
        data: '{}'
    docs: Initiates a flow to start a new task contact. For more information, see Concepts - Tasks in the Amazon Connect Administrator
      Guide.
  - info:
      name: Amazon Connect Describe Contact
      type: http
    http:
      method: GET
      url: https://connect.amazonaws.com/contacts/:InstanceId/:ContactId
      params:
      - name: InstanceId
        value: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The identifier of the Amazon Connect instance.
      - name: ContactId
        value: a1b2c3d4-5678-90ab-cdef-88888EXAMPLE
        type: path
        description: The identifier of the contact.
    docs: This API is in preview release for Amazon Connect and is subject to change. Describes the specified contact.
  - info:
      name: Amazon Connect Get Contact Attributes
      type: http
    http:
      method: GET
      url: https://connect.amazonaws.com/contacts/:InstanceId/:ContactId/attributes
      params:
      - name: InstanceId
        value: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The identifier of the Amazon Connect instance.
      - name: ContactId
        value: a1b2c3d4-5678-90ab-cdef-88888EXAMPLE
        type: path
        description: The identifier of the initial contact.
    docs: Retrieves the contact attributes for the specified contact.
  - info:
      name: Amazon Connect Update Contact Attributes
      type: http
    http:
      method: POST
      url: https://connect.amazonaws.com/contacts/:InstanceId/:ContactId/attributes
      params:
      - name: InstanceId
        value: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The identifier of the Amazon Connect instance.
      - name: ContactId
        value: a1b2c3d4-5678-90ab-cdef-88888EXAMPLE
        type: path
        description: The identifier of the contact.
      body:
        type: json
        data: '{}'
    docs: Creates or updates user-defined contact attributes associated with the specified contact.
  - info:
      name: Amazon Connect Stop Contact
      type: http
    http:
      method: POST
      url: https://connect.amazonaws.com/contacts/:InstanceId/:ContactId/stop
      params:
      - name: InstanceId
        value: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The identifier of the Amazon Connect instance.
      - name: ContactId
        value: a1b2c3d4-5678-90ab-cdef-88888EXAMPLE
        type: path
        description: The identifier of the contact.
      body:
        type: json
        data: '{}'
    docs: 'Ends the specified contact. This call does not work for voice contacts that use the following initiation methods:
      DISCONNECT, TRANSFER, QUEUE_TRANSFER, CALLBACK, or EXTERNAL_OUTBOUND.'
  - info:
      name: Amazon Connect Search Contacts
      type: http
    http:
      method: POST
      url: https://connect.amazonaws.com/search-contacts
      body:
        type: json
        data: '{}'
    docs: Searches contacts in an Amazon Connect instance.
- info:
    name: Metrics
    type: folder
  items:
  - info:
      name: Amazon Connect Get Historical Metric Data
      type: http
    http:
      method: POST
      url: https://connect.amazonaws.com/metrics/historical/:InstanceId
      params:
      - name: InstanceId
        value: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The identifier of the Amazon Connect instance.
      body:
        type: json
        data: '{}'
    docs: Gets historical metric data from the specified Amazon Connect instance. You can use this API to get historical data
      for Amazon Connect queues, routing profiles, agents, and contact flows.
  - info:
      name: Amazon Connect Get Current Metric Data
      type: http
    http:
      method: POST
      url: https://connect.amazonaws.com/metrics/current/:InstanceId
      params:
      - name: InstanceId
        value: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The identifier of the Amazon Connect instance.
      body:
        type: json
        data: '{}'
    docs: Gets the real-time metric data from the specified Amazon Connect instance. For a description of each metric, see
      Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
- info:
    name: Tags
    type: folder
  items:
  - info:
      name: Amazon Connect List Tags for Resource
      type: http
    http:
      method: GET
      url: https://connect.amazonaws.com/tags/:ResourceArn
      params:
      - name: ResourceArn
        value: arn:aws:connect:us-east-1:123456789012:instance/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The Amazon Resource Name (ARN) of the resource.
    docs: Lists the tags for the specified resource.
  - info:
      name: Amazon Connect Tag Resource
      type: http
    http:
      method: POST
      url: https://connect.amazonaws.com/tags/:ResourceArn
      params:
      - name: ResourceArn
        value: arn:aws:connect:us-east-1:123456789012:instance/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The Amazon Resource Name (ARN) of the resource.
      body:
        type: json
        data: '{}'
    docs: Adds the specified tags to the specified resource.
  - info:
      name: Amazon Connect Untag Resource
      type: http
    http:
      method: DELETE
      url: https://connect.amazonaws.com/tags/:ResourceArn
      params:
      - name: ResourceArn
        value: arn:aws:connect:us-east-1:123456789012:instance/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The Amazon Resource Name (ARN) of the resource.
      - name: tagKeys
        value: Environment,Team
        type: query
        description: The tag keys.
    docs: Removes the specified tags from the specified resource.
- info:
    name: Authentication
    type: folder
  items:
  - info:
      name: Amazon Connect Get Federation Token
      type: http
    http:
      method: GET
      url: https://connect.amazonaws.com/federation-token/:InstanceId
      params:
      - name: InstanceId
        value: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
        type: path
        description: The identifier of the Amazon Connect instance.
    docs: Retrieves a token for federation. This API doesn't support root users. If you try to invoke GetFederationToken with
      root credentials, an error message similar to the following one appears.
bundled: true