Amazon Connect

Amazon Connect Connect Integration Associations API

The Connect Integration Associations API from Amazon Connect — 2 operation(s) for connect integration associations.

Documentation GitHub OpenAPI

Operations 3

PUT /instance/{InstanceId}/integration-associations Create Integration Association #

GET /instance/{InstanceId}/integration-associations List Integration Associations #

DELETE /instance/{InstanceId}/integration-associations/{IntegrationAssociationId} Delete Integration Association #

Specifications

⚙

OpenAPI

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

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-integration-associations-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 Integration Associations API
  version: '2017-08-08'
  description: Generated from AWS's published Smithy model for Amazon Connect Service. 3 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}/integration-associations:
    put:
      operationId: CreateIntegrationAssociation
      summary: Create Integration Association
      description: Creates an Amazon Web Services resource association with an Connect Customer instance.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateIntegrationAssociationResponse'
        '409':
          description: DuplicateResourceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DuplicateResourceException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '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/CreateIntegrationAssociationRequest'
      tags:
      - Integration Associations
    get:
      operationId: ListIntegrationAssociations
      summary: List Integration Associations
      description: Provides summary information about the Amazon Web Services resource associations for the specified Connect
        Customer instance.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListIntegrationAssociationsResponse'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '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/ListIntegrationAssociationsRequest'
      tags:
      - Integration Associations
  /instance/{InstanceId}/integration-associations/{IntegrationAssociationId}:
    delete:
      operationId: DeleteIntegrationAssociation
      summary: Delete Integration Association
      description: Deletes an Amazon Web Services resource association from an Connect Customer instance. The association
        must not have any use cases associated with it.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '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/DeleteIntegrationAssociationRequest'
      tags:
      - Integration Associations
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:
    CreateIntegrationAssociationRequest:
      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.
        IntegrationType:
          type: string
          enum:
          - EVENT
          - VOICE_ID
          - PINPOINT_APP
          - WISDOM_ASSISTANT
          - WISDOM_KNOWLEDGE_BASE
          - WISDOM_QUICK_RESPONSES
          - Q_MESSAGE_TEMPLATES
          - CASES_DOMAIN
          - APPLICATION
          - FILE_SCANNER
          - SES_IDENTITY
          - ANALYTICS_CONNECTOR
          - CALL_TRANSFER_CONNECTOR
          - COGNITO_USER_POOL
          - MESSAGE_PROCESSOR
          description: The type of information to be ingested.
        IntegrationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the integration. When integrating with Amazon Web Services End User
            Messaging, the Connect Customer and Amazon Web Services End User Messaging instances must be in the same account.
        SourceApplicationUrl:
          type: string
          description: The URL for the external application. This field is only required for the EVENT integration type.
        SourceApplicationName:
          type: string
          description: The name of the external application. This field is only required for the EVENT integration type.
        SourceType:
          type: string
          enum:
          - SALESFORCE
          - ZENDESK
          - CASES
          description: The type of the data source. This field is only required for the EVENT integration type.
        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:
      - InstanceId
      - IntegrationType
      - IntegrationArn
    CreateIntegrationAssociationResponse:
      type: object
      properties:
        IntegrationAssociationId:
          type: string
          description: The identifier for the integration association.
        IntegrationAssociationArn:
          type: string
          description: The Amazon Resource Name (ARN) for the association.
    DeleteIntegrationAssociationRequest:
      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.
        IntegrationAssociationId:
          type: string
          description: The identifier for the integration association.
      required:
      - InstanceId
      - IntegrationAssociationId
    DuplicateResourceException:
      type: object
      properties:
        Message:
          type: string
    IntegrationAssociationSummary:
      type: object
      properties:
        IntegrationAssociationId:
          type: string
          description: The identifier for the AppIntegration association.
        IntegrationAssociationArn:
          type: string
          description: The Amazon Resource Name (ARN) for the AppIntegration association.
        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.
        IntegrationType:
          type: string
          enum:
          - EVENT
          - VOICE_ID
          - PINPOINT_APP
          - WISDOM_ASSISTANT
          - WISDOM_KNOWLEDGE_BASE
          - WISDOM_QUICK_RESPONSES
          - Q_MESSAGE_TEMPLATES
          - CASES_DOMAIN
          - APPLICATION
          - FILE_SCANNER
          - SES_IDENTITY
          - ANALYTICS_CONNECTOR
          - CALL_TRANSFER_CONNECTOR
          - COGNITO_USER_POOL
          - MESSAGE_PROCESSOR
          description: The integration type.
        IntegrationArn:
          type: string
          description: The Amazon Resource Name (ARN) for the AppIntegration.
        SourceApplicationUrl:
          type: string
          description: The URL for the external application.
        SourceApplicationName:
          type: string
          description: The user-provided, friendly name for the external application.
        SourceType:
          type: string
          enum:
          - SALESFORCE
          - ZENDESK
          - CASES
          description: The name of the source.
    InternalServiceException:
      type: object
      properties:
        Message:
          type: string
          description: The message.
    InvalidRequestException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the request.
        Reason:
          $ref: '#/components/schemas/InvalidRequestExceptionReason'
    InvalidRequestExceptionReason:
      type: object
      properties:
        AttachedFileInvalidRequestExceptionReason:
          type: string
          enum:
          - INVALID_FILE_SIZE
          - INVALID_FILE_TYPE
          - INVALID_FILE_NAME
          description: Reason why the StartAttachedFiledUpload request was invalid.
      description: Exactly one member is set.
    ListIntegrationAssociationsRequest:
      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.
        IntegrationType:
          type: string
          enum:
          - EVENT
          - VOICE_ID
          - PINPOINT_APP
          - WISDOM_ASSISTANT
          - WISDOM_KNOWLEDGE_BASE
          - WISDOM_QUICK_RESPONSES
          - Q_MESSAGE_TEMPLATES
          - CASES_DOMAIN
          - APPLICATION
          - FILE_SCANNER
          - SES_IDENTITY
          - ANALYTICS_CONNECTOR
          - CALL_TRANSFER_CONNECTOR
          - COGNITO_USER_POOL
          - MESSAGE_PROCESSOR
          description: The integration type.
        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.
        MaxResults:
          type: integer
          description: The maximum number of results to return per page.
        IntegrationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the integration.
      required:
      - InstanceId
    ListIntegrationAssociationsResponse:
      type: object
      properties:
        IntegrationAssociationSummaryList:
          type: array
          items:
            $ref: '#/components/schemas/IntegrationAssociationSummary'
          description: The associations.
        NextToken:
          type: string
          description: If there are additional results, this is the token for the next set of results.
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the resource.
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
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)