Amazon Q

Amazon Q Q Associations API

The Q Associations API from Amazon Q — 4 operation(s) for q associations.

Documentation GitHub OpenAPI

Operations 8

POST /assistants/{assistantId}/associations Create Assistant Association #

GET /assistants/{assistantId}/associations List Assistant Associations #

GET /assistants/{assistantId}/associations/{assistantAssociationId} Get Assistant Association #

DELETE /assistants/{assistantId}/associations/{assistantAssociationId} Delete Assistant Association #

POST /knowledgeBases/{knowledgeBaseId}/contents/{contentId}/associations Create Content Association #

GET /knowledgeBases/{knowledgeBaseId}/contents/{contentId}/associations List Content Associations #

GET /knowledgeBases/{knowledgeBaseId}/contents/{contentId}/associations/{contentAssociationId} Get Content Association #

DELETE /knowledgeBases/{knowledgeBaseId}/contents/{contentId}/associations/{contentAssociationId} Delete Content Association #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/amazon-q/openapi/amazon-q-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-q:amazon-q-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.2.0
info:
  title: QBusiness Associations API
  version: '2023-11-27'
  description: Generated from AWS's published Smithy model for QBusiness. 8 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://wisdom.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Associations
paths:
  /assistants/{assistantId}/associations:
    post:
      operationId: CreateAssistantAssociation
      summary: Create Assistant Association
      description: Creates an association between an Amazon Q in Connect assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAssistantAssociationResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomAccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomConflictException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomServiceQuotaExceededException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAssistantAssociationRequest'
      tags:
      - Associations
    get:
      operationId: ListAssistantAssociations
      summary: List Assistant Associations
      description: Lists information about assistant associations.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAssistantAssociationsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomAccessDeniedException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListAssistantAssociationsRequest'
      tags:
      - Associations
  /assistants/{assistantId}/associations/{assistantAssociationId}:
    get:
      operationId: GetAssistantAssociation
      summary: Get Assistant Association
      description: Retrieves information about an assistant association.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAssistantAssociationResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomAccessDeniedException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomResourceNotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAssistantAssociationRequest'
      tags:
      - Associations
    delete:
      operationId: DeleteAssistantAssociation
      summary: Delete Assistant Association
      description: Deletes an assistant association.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteAssistantAssociationResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomAccessDeniedException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomResourceNotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteAssistantAssociationRequest'
      tags:
      - Associations
  /knowledgeBases/{knowledgeBaseId}/contents/{contentId}/associations:
    post:
      operationId: CreateContentAssociation
      summary: Create Content Association
      description: 'Creates an association between a content resource in a knowledge base and step-by-step guides. Step-by-step guides offer instructions to agents for resolving common customer issues. You create a content association to integrate Amazon Q in Connect and step-by-step guides. After you integrate Amazon Q and step-by-step guides, when Amazon Q provides a recommendation to an agent based on the intent that it''s detected, it also provides them with the option to start the step-by-step guide that you have associated with the content. Note the following limitations: You can create only one content association for each content resource in a knowledge base. You can associate a step-by-step guide with multiple content resources. For more information, see Integrate Amazon Q in Connect with step-by-step guides in the Connect Customer Administrator Guide.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateContentAssociationResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomAccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomConflictException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomServiceQuotaExceededException'
        '400':
          description: ThrottlingException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomThrottlingException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateContentAssociationRequest'
      tags:
      - Associations
    get:
      operationId: ListContentAssociations
      summary: List Content Associations
      description: Lists the content associations. For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Connect Customer Administrator Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListContentAssociationsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomAccessDeniedException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomResourceNotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListContentAssociationsRequest'
      tags:
      - Associations
  /knowledgeBases/{knowledgeBaseId}/contents/{contentId}/associations/{contentAssociationId}:
    get:
      operationId: GetContentAssociation
      summary: Get Content Association
      description: Returns the content association. For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Connect Customer Administrator Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetContentAssociationResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomAccessDeniedException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomResourceNotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetContentAssociationRequest'
      tags:
      - Associations
    delete:
      operationId: DeleteContentAssociation
      summary: Delete Content Association
      description: Deletes the content association. For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Connect Customer Administrator Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteContentAssociationResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomAccessDeniedException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomResourceNotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteContentAssociationRequest'
      tags:
      - Associations
components:
  schemas:
    ContentAssociationContents:
      type: object
      properties:
        amazonConnectGuideAssociation:
          $ref: '#/components/schemas/AmazonConnectGuideAssociationData'
      description: Exactly one member is set.
    ListContentAssociationsResponse:
      type: object
      properties:
        contentAssociationSummaries:
          type: array
          items:
            $ref: '#/components/schemas/ContentAssociationSummary'
          description: Summary information about content associations.
        nextToken:
          type: string
          description: If there are additional results, this is the token for the next set of results.
      required:
      - contentAssociationSummaries
    GetContentAssociationRequest:
      type: object
      properties:
        knowledgeBaseId:
          type: string
          description: The identifier of the knowledge base.
        contentId:
          type: string
          description: The identifier of the content.
        contentAssociationId:
          type: string
          description: The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.
      required:
      - knowledgeBaseId
      - contentId
      - contentAssociationId
    WisdomAccessDeniedException:
      type: object
      properties:
        message:
          type: string
    ListAssistantAssociationsRequest:
      type: object
      properties:
        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.
        assistantId:
          type: string
          description: The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
      required:
      - assistantId
    ExternalBedrockKnowledgeBaseConfig:
      type: object
      properties:
        bedrockKnowledgeBaseArn:
          type: string
          description: The Amazon Resource Name (ARN) of the external Bedrock knowledge base.
        accessRoleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM role used to access the external Bedrock knowledge base.
      required:
      - bedrockKnowledgeBaseArn
      - accessRoleArn
    DeleteContentAssociationResponse:
      type: object
      properties: {}
    WisdomResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        resourceName:
          type: string
          description: The specified resource name.
    DeleteAssistantAssociationResponse:
      type: object
      properties: {}
    WisdomValidationException:
      type: object
      properties:
        message:
          type: string
    AssistantAssociationSummary:
      type: object
      properties:
        assistantAssociationId:
          type: string
          description: The identifier of the assistant association.
        assistantAssociationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the assistant association.
        assistantId:
          type: string
          description: The identifier of the Amazon Q in Connect assistant.
        assistantArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
        associationType:
          type: string
          description: The type of association.
        associationData:
          $ref: '#/components/schemas/AssistantAssociationOutputData'
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
      required:
      - assistantAssociationId
      - assistantAssociationArn
      - assistantId
      - assistantArn
      - associationType
      - associationData
    ListContentAssociationsRequest:
      type: object
      properties:
        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.
        knowledgeBaseId:
          type: string
          description: The identifier of the knowledge base.
        contentId:
          type: string
          description: The identifier of the content.
      required:
      - knowledgeBaseId
      - contentId
    KnowledgeBaseAssociationData:
      type: object
      properties:
        knowledgeBaseId:
          type: string
          description: The identifier of the knowledge base.
        knowledgeBaseArn:
          type: string
          description: The Amazon Resource Name (ARN) of the knowledge base.
    CreateContentAssociationResponse:
      type: object
      properties:
        contentAssociation:
          $ref: '#/components/schemas/ContentAssociationData'
    WisdomServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
    UnauthorizedException:
      type: object
      properties:
        message:
          type: string
    CreateAssistantAssociationRequest:
      type: object
      properties:
        assistantId:
          type: string
          description: The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
        associationType:
          type: string
          description: The type of association.
        association:
          $ref: '#/components/schemas/AssistantAssociationInputData'
        clientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
      required:
      - assistantId
      - associationType
      - association
    ContentAssociationSummary:
      type: object
      properties:
        knowledgeBaseId:
          type: string
          description: The identifier of the knowledge base.
        knowledgeBaseArn:
          type: string
          description: The Amazon Resource Name (ARN) of the knowledge base.
        contentId:
          type: string
          description: The identifier of the content.
        contentArn:
          type: string
          description: The Amazon Resource Name (ARN) of the content.
        contentAssociationId:
          type: string
          description: The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.
        contentAssociationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the content association.
        associationType:
          type: string
          description: The type of association.
        associationData:
          $ref: '#/components/schemas/ContentAssociationContents'
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
      required:
      - knowledgeBaseId
      - knowledgeBaseArn
      - contentId
      - contentArn
      - contentAssociationId
      - contentAssociationArn
      - associationType
      - associationData
    AssistantAssociationData:
      type: object
      properties:
        assistantAssociationId:
          type: string
          description: The identifier of the assistant association.
        assistantAssociationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the assistant association.
        assistantId:
          type: string
          description: The identifier of the Amazon Q in Connect assistant.
        assistantArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
        associationType:
          type: string
          description: The type of association.
        associationData:
          $ref: '#/components/schemas/AssistantAssociationOutputData'
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
      required:
      - assistantAssociationId
      - assistantAssociationArn
      - assistantId
      - assistantArn
      - associationType
      - associationData
    GetAssistantAssociationResponse:
      type: object
      properties:
        assistantAssociation:
          $ref: '#/components/schemas/AssistantAssociationData'
    CreateContentAssociationRequest:
      type: object
      properties:
        clientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
        knowledgeBaseId:
          type: string
          description: The identifier of the knowledge base.
        contentId:
          type: string
          description: The identifier of the content.
        associationType:
          type: string
          description: The type of association.
        association:
          $ref: '#/components/schemas/ContentAssociationContents'
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
      required:
      - knowledgeBaseId
      - contentId
      - associationType
      - association
    CreateAssistantAssociationResponse:
      type: object
      properties:
        assistantAssociation:
          $ref: '#/components/schemas/AssistantAssociationData'
    AssistantAssociationInputData:
      type: object
      properties:
        knowledgeBaseId:
          type: string
          description: The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
        externalBedrockKnowledgeBaseConfig:
          $ref: '#/components/schemas/ExternalBedrockKnowledgeBaseConfig'
      description: Exactly one member is set.
    WisdomConflictException:
      type: object
      properties:
        message:
          type: string
    ListAssistantAssociationsResponse:
      type: object
      properties:
        assistantAssociationSummaries:
          type: array
          items:
            $ref: '#/components/schemas/AssistantAssociationSummary'
          description: Summary information about assistant associations.
        nextToken:
          type: string
          description: If there are additional results, this is the token for the next set of results.
      required:
      - assistantAssociationSummaries
    GetAssistantAssociationRequest:
      type: object
      properties:
        assistantAssociationId:
          type: string
          description: The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.
        assistantId:
          type: string
          description: The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
      required:
      - assistantAssociationId
      - assistantId
    AssistantAssociationOutputData:
      type: object
      properties:
        knowledgeBaseAssociation:
          $ref: '#/components/schemas/KnowledgeBaseAssociationData'
        externalBedrockKnowledgeBaseConfig:
          $ref: '#/components/schemas/ExternalBedrockKnowledgeBaseConfig'
      description: Exactly one member is set.
    DeleteAssistantAssociationRequest:
      type: object
      properties:
        assistantAssociationId:
          type: string
          description: The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.
        assistantId:
          type: string
          description: The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
      required:
      - assistantAssociationId
      - assistantId
    ContentAssociationData:
      type: object
      properties:
        knowledgeBaseId:
          type: string
          description: The identifier of the knowledge base.
        knowledgeBaseArn:
          type: string
          description: The Amazon Resource Name (ARN) of the knowledge base.
        contentId:
          type: string
          description: The identifier of the content.
        contentArn:
          type: string
          description: The Amazon Resource Name (ARN) of the content.
        contentAssociationId:
          type: string
          description: The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.
        contentAssociationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the content association.
        associationType:
          type: string
          description: The type of association.
        associationData:
          $ref: '#/components/schemas/ContentAssociationContents'
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
      required:
      - knowledgeBaseId
      - knowledgeBaseArn
      - contentId
      - contentArn
      - contentAssociationId
      - contentAssociationArn
      - associationType
      - associationData
    DeleteContentAssociationRequest:
      type: object
      properties:
        knowledgeBaseId:
          type: string
          description: The identifier of the knowledge base.
        contentId:
          type: string
          description: The identifier of the content.
        contentAssociationId:
          type: string
          description: The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.
      required:
      - knowledgeBaseId
      - contentId
      - contentAssociationId
    GetContentAssociationResponse:
      type: object
      properties:
        contentAssociation:
          $ref: '#/components/schemas/ContentAssociationData'
    WisdomThrottlingException:
      type: object
      properties:
        message:
          type: string
    AmazonConnectGuideAssociationData:
      type: object
      properties:
        flowId:
          type: string
          description: The Amazon Resource Name (ARN) of an Connect Customer flow. Step-by-step guides are a type of flow.
  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: wisdom
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/qconnect/service/2020-10-19/qconnect-2020-10-19.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)