Amazon Connect Connect Association API

The Connect Association API from Amazon Connect — 1 operation(s) for connect association.

Operations 5

PUT /analytics-data/instance/{InstanceId}/association Associate Analytics Data Set #
POST /analytics-data/instance/{InstanceId}/association Disassociate Analytics Data Set #
GET /analytics-data/instance/{InstanceId}/association List Analytics Data Associations #
PUT /analytics-data/instance/{InstanceId}/associations Batch Associate Analytics Data Set #
POST /analytics-data/instance/{InstanceId}/associations Batch Disassociate Analytics Data Set #

Specifications

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-association-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.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-connect-association-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Connect Service Association API
  version: '2017-08-08'
  description: Generated from AWS's published Smithy model for Amazon Connect Service. 5 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:
  /analytics-data/instance/{InstanceId}/association:
    put:
      operationId: AssociateAnalyticsDataSet
      summary: Associate Analytics Data Set
      description: Associates the specified dataset for a Connect Customer instance with the target account. You can associate
        only one dataset in a single call.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssociateAnalyticsDataSetResponse'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '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/AssociateAnalyticsDataSetRequest'
      tags:
      - Association
    post:
      operationId: DisassociateAnalyticsDataSet
      summary: Disassociate Analytics Data Set
      description: Removes the dataset ID associated with a given Connect Customer instance.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '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/DisassociateAnalyticsDataSetRequest'
      tags:
      - Association
    get:
      operationId: ListAnalyticsDataAssociations
      summary: List Analytics Data Associations
      description: Lists the association status of requested dataset ID for a given Connect Customer instance.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAnalyticsDataAssociationsResponse'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '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/ListAnalyticsDataAssociationsRequest'
      tags:
      - Association
  /analytics-data/instance/{InstanceId}/associations:
    put:
      operationId: BatchAssociateAnalyticsDataSet
      summary: Batch Associate Analytics Data Set
      description: Associates a list of analytics datasets for a given Connect Customer instance to a target account. You
        can associate multiple datasets in a single call.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchAssociateAnalyticsDataSetResponse'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '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/BatchAssociateAnalyticsDataSetRequest'
      tags:
      - Association
    post:
      operationId: BatchDisassociateAnalyticsDataSet
      summary: Batch Disassociate Analytics Data Set
      description: Removes a list of analytics datasets associated with a given Connect Customer instance. You can disassociate
        multiple datasets in a single call.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchDisassociateAnalyticsDataSetResponse'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '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/BatchDisassociateAnalyticsDataSetRequest'
      tags:
      - Association
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:
    AnalyticsDataAssociationResult:
      type: object
      properties:
        DataSetId:
          type: string
          description: The identifier of the dataset.
        TargetAccountId:
          type: string
          description: The identifier of the target account.
        ResourceShareId:
          type: string
          description: The Resource Access Manager share ID.
        ResourceShareArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Resource Access Manager share.
        ResourceShareStatus:
          type: string
          description: The Amazon Web Services Resource Access Manager status of association.
    AssociateAnalyticsDataSetRequest:
      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.
        DataSetId:
          type: string
          description: The identifier of the dataset to associate with the target account.
        TargetAccountId:
          type: string
          description: The identifier of the target account. Use to associate a dataset to a different account than the one
            containing the Connect Customer instance. If not specified, by default this value is the Amazon Web Services account
            that has the Connect Customer instance.
      required:
      - InstanceId
      - DataSetId
    AssociateAnalyticsDataSetResponse:
      type: object
      properties:
        DataSetId:
          type: string
          description: The identifier of the dataset that was associated.
        TargetAccountId:
          type: string
          description: The identifier of the target account.
        ResourceShareId:
          type: string
          description: The Resource Access Manager share ID that is generated.
        ResourceShareArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Resource Access Manager share.
    BatchAssociateAnalyticsDataSetRequest:
      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.
        DataSetIds:
          type: array
          items:
            type: string
          description: An array of dataset identifiers to associate.
        TargetAccountId:
          type: string
          description: The identifier of the target account. Use to associate a dataset to a different account than the one
            containing the Connect Customer instance. If not specified, by default this value is the Amazon Web Services account
            that has the Connect Customer instance.
      required:
      - InstanceId
      - DataSetIds
    BatchAssociateAnalyticsDataSetResponse:
      type: object
      properties:
        Created:
          type: array
          items:
            $ref: '#/components/schemas/AnalyticsDataAssociationResult'
          description: 'Information about associations that are successfully created: DataSetId, TargetAccountId, ResourceShareId,
            ResourceShareArn.'
        Errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorResult'
          description: A list of errors for datasets that aren't successfully associated with the target account.
    BatchDisassociateAnalyticsDataSetRequest:
      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.
        DataSetIds:
          type: array
          items:
            type: string
          description: An array of associated dataset identifiers to remove.
        TargetAccountId:
          type: string
          description: The identifier of the target account. Use to disassociate a dataset from a different account than the
            one containing the Connect Customer instance. If not specified, by default this value is the Amazon Web Services
            account that has the Connect Customer instance.
      required:
      - InstanceId
      - DataSetIds
    BatchDisassociateAnalyticsDataSetResponse:
      type: object
      properties:
        Deleted:
          type: array
          items:
            type: string
          description: An array of successfully disassociated dataset identifiers.
        Errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorResult'
          description: A list of errors for any datasets not successfully removed.
    DisassociateAnalyticsDataSetRequest:
      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.
        DataSetId:
          type: string
          description: The identifier of the dataset to remove.
        TargetAccountId:
          type: string
          description: The identifier of the target account. Use to associate a dataset to a different account than the one
            containing the Connect Customer instance. If not specified, by default this value is the Amazon Web Services account
            that has the Connect Customer instance.
      required:
      - InstanceId
      - DataSetId
    ErrorResult:
      type: object
      properties:
        ErrorCode:
          type: string
          description: The error code.
        ErrorMessage:
          type: string
          description: The corresponding error message for the error code.
    InternalServiceException:
      type: object
      properties:
        Message:
          type: string
          description: The message.
    InvalidParameterException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the parameters.
    ListAnalyticsDataAssociationsRequest:
      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.
        DataSetId:
          type: string
          description: The identifier of the dataset to get the association status.
        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.
      required:
      - InstanceId
    ListAnalyticsDataAssociationsResponse:
      type: object
      properties:
        Results:
          type: array
          items:
            $ref: '#/components/schemas/AnalyticsDataAssociationResult'
          description: 'An array of successful results: DataSetId, TargetAccountId, ResourceShareId, ResourceShareArn. This
            is a paginated API, so nextToken is given if there are more results to be returned.'
        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)