Amazon Connect

Amazon Connect Connect Onboarding API

The Connect Onboarding API from Amazon Connect — 2 operation(s) for connect onboarding.

Documentation GitHub OpenAPI

Operations 6

DELETE /connect-instance/{connectInstanceId}/onboarding Delete Instance Onboarding Job #

GET /connect-instance/{connectInstanceId}/onboarding Get Instance Onboarding Job Status #

PUT /connect-instance/{connectInstanceId}/onboarding Start Instance Onboarding Job #

DELETE /v2/connect-instance/{connectInstanceId}/onboarding Delete Instance Onboarding Job #

GET /v2/connect-instance/{connectInstanceId}/onboarding Get Instance Onboarding Job Status #

PUT /v2/connect-instance/{connectInstanceId}/onboarding Start Instance Onboarding Job #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/amazon-connect/openapi/amazon-connect-onboarding-api-openapi.yml

Schemas & Data

📊

JSONSchema

https://artifacts.apis.io/amazon-connect/json-schema/amazon-connect-connect-campaigns-start-instance-onboarding-job-request-schema.json

📊

JSONSchema

https://artifacts.apis.io/amazon-connect/json-schema/amazon-connect-start-instance-onboarding-job-request-schema.json

📊

JSONSchema

https://artifacts.apis.io/amazon-connect/json-schema/amazon-connect-get-instance-onboarding-job-status-response-schema.json

📊

JSONSchema

https://artifacts.apis.io/amazon-connect/json-schema/amazon-connect-start-instance-onboarding-job-response-schema.json

📊

JSONSchema

https://artifacts.apis.io/amazon-connect/json-schema/amazon-connect-delete-instance-onboarding-job-request-schema.json

📊

JSONSchema

https://artifacts.apis.io/amazon-connect/json-schema/amazon-connect-get-instance-onboarding-job-status-request-schema.json

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.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-connect:amazon-connect-onboarding-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.

GitHub Google LinkedIn

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 Onboarding API
  version: '2017-08-08'
  description: Generated from AWS's published Smithy model for Amazon Connect Service. 6 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-campaigns.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /connect-instance/{connectInstanceId}/onboarding:
    delete:
      operationId: DeleteInstanceOnboardingJob
      summary: Delete Instance Onboarding Job
      description: Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsAccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsInternalServerException'
        '409':
          description: InvalidStateException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidStateException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteInstanceOnboardingJobRequest'
      tags:
      - Onboarding
    get:
      operationId: GetInstanceOnboardingJobStatus
      summary: Get Instance Onboarding Job Status
      description: Get the specific instance onboarding job status.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetInstanceOnboardingJobStatusResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsAccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetInstanceOnboardingJobStatusRequest'
      tags:
      - Onboarding
    put:
      operationId: StartInstanceOnboardingJob
      summary: Start Instance Onboarding Job
      description: Onboard the specific Amazon Connect instance to Connect Campaigns.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartInstanceOnboardingJobResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsAccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartInstanceOnboardingJobRequest'
      tags:
      - Onboarding
  /v2/connect-instance/{connectInstanceId}/onboarding:
    delete:
      operationId: DeleteInstanceOnboardingJob
      summary: Delete Instance Onboarding Job
      description: Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsAccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsInternalServerException'
        '409':
          description: InvalidStateException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidStateException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteInstanceOnboardingJobRequest'
      tags:
      - Onboarding
      servers:
      - url: https://connect-campaigns.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
    get:
      operationId: GetInstanceOnboardingJobStatus
      summary: Get Instance Onboarding Job Status
      description: Get the specific instance onboarding job status.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetInstanceOnboardingJobStatusResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsAccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetInstanceOnboardingJobStatusRequest'
      tags:
      - Onboarding
      servers:
      - url: https://connect-campaigns.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
    put:
      operationId: StartInstanceOnboardingJob
      summary: Start Instance Onboarding Job
      description: Onboard the specific Amazon Connect instance to Connect Campaigns.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartInstanceOnboardingJobResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsAccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectCampaignsStartInstanceOnboardingJobRequest'
      tags:
      - Onboarding
      servers:
      - url: https://connect-campaigns.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
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-campaigns
  schemas:
    ConnectCampaignsAccessDeniedException:
      type: object
      properties:
        message:
          type: string
        xAmzErrorType:
          type: string
      required:
      - message
    ConnectCampaignsConflictException:
      type: object
      properties:
        message:
          type: string
        xAmzErrorType:
          type: string
      required:
      - message
    ConnectCampaignsEncryptionConfig:
      type: object
      properties:
        enabled:
          type: boolean
        encryptionType:
          type: string
        keyArn:
          type: string
      required:
      - enabled
    ConnectCampaignsInternalServerException:
      type: object
      properties:
        message:
          type: string
        xAmzErrorType:
          type: string
      required:
      - message
    ConnectCampaignsResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        xAmzErrorType:
          type: string
      required:
      - message
    ConnectCampaignsStartInstanceOnboardingJobRequest:
      type: object
      properties:
        connectInstanceId:
          type: string
        encryptionConfig:
          $ref: '#/components/schemas/ConnectCampaignsEncryptionConfig'
      required:
      - connectInstanceId
      - encryptionConfig
    ConnectCampaignsThrottlingException:
      type: object
      properties:
        message:
          type: string
        xAmzErrorType:
          type: string
      required:
      - message
    ConnectCampaignsValidationException:
      type: object
      properties:
        message:
          type: string
        xAmzErrorType:
          type: string
      required:
      - message
    DeleteInstanceOnboardingJobRequest:
      type: object
      properties:
        connectInstanceId:
          type: string
      required:
      - connectInstanceId
    GetInstanceOnboardingJobStatusRequest:
      type: object
      properties:
        connectInstanceId:
          type: string
      required:
      - connectInstanceId
    GetInstanceOnboardingJobStatusResponse:
      type: object
      properties:
        connectInstanceOnboardingJobStatus:
          $ref: '#/components/schemas/InstanceOnboardingJobStatus'
    InstanceOnboardingJobStatus:
      type: object
      properties:
        connectInstanceId:
          type: string
        status:
          type: string
        failureCode:
          type: string
      required:
      - connectInstanceId
      - status
    InvalidStateException:
      type: object
      properties:
        message:
          type: string
        xAmzErrorType:
          type: string
      required:
      - message
    StartInstanceOnboardingJobRequest:
      type: object
      properties:
        connectInstanceId:
          type: string
        encryptionConfig:
          $ref: '#/components/schemas/ConnectCampaignsEncryptionConfig'
      required:
      - connectInstanceId
      - encryptionConfig
    StartInstanceOnboardingJobResponse:
      type: object
      properties:
        connectInstanceOnboardingJobStatus:
          $ref: '#/components/schemas/InstanceOnboardingJobStatus'
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/connectcampaigns/service/2021-01-30/connectcampaigns-2021-01-30.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)
  sources:
  - https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/connectcampaigns/service/2021-01-30/connectcampaigns-2021-01-30.json
  - https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/connectcampaignsv2/service/2024-04-23/connectcampaignsv2-2024-04-23.json