Amazon Q

Amazon Q Indices API

The Indices API from Amazon Q — 1 operation(s) for indices.

GitHub OpenAPI

Operations 5

GET /applications/{applicationId}/indices List Indices #
POST /applications/{applicationId}/indices Create Index #
GET /applications/{applicationId}/indices/{indexId} Get Index #
PUT /applications/{applicationId}/indices/{indexId} Update Index #
DELETE /applications/{applicationId}/indices/{indexId} Delete Index #

Documentation

📖
Documentation
https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/
📖
Authentication
https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/security-iam.html
📖
APIReference
https://docs.aws.amazon.com/amazonq/latest/api-reference/Welcome.html
📖
GettingStarted
https://aws.amazon.com/q/business/getting-started/
📖
Documentation
https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/what-is.html
📖
RateLimits
https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/quotas-regions.html
📖
Documentation
https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/
📖
Authentication
https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/security-iam.html
📖
GettingStarted
https://aws.amazon.com/q/developer/getting-started/
📖
Documentation
https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/what-is.html
📖
RateLimits
https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/quotas.html

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-q/openapi/amazon-q-indices-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/aws/amazon-q-developer-cli

Other Resources

🔗
Pricing
https://aws.amazon.com/q/business/pricing/
🔗
Features
https://aws.amazon.com/q/business/features/
🔗
CLI
https://docs.aws.amazon.com/cli/latest/reference/qbusiness/
🔗
SDKs
https://aws.amazon.com/tools/
🔗
ChangeLog
https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/doc-history.html
🔗
Pricing
https://aws.amazon.com/q/developer/pricing/
🔗
Features
https://aws.amazon.com/q/developer/features/
🔗
ChangeLog
https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/doc-history.html

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-indices-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

amazon-q-indices-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Amazon Q Indices API
  version: '1.0'
  description: 'Operations tagged Indices across 2 of this provider''s published API definitions: amazon-q-openapi.yml, amazon-q-indices-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://qbusiness.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
      description: AWS region
security:
- sigv4: []
tags:
- name: Indices
paths:
  /applications/{applicationId}/indices:
    get:
      operationId: ListIndices
      summary: List Indices
      description: Lists the Amazon Q Business indices you have created.
      tags:
      - Indices
      parameters:
      - name: applicationId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
    post:
      operationId: CreateIndex
      summary: Create Index
      description: Creates an Amazon Q Business index.
      tags:
      - Indices
      parameters:
      - name: applicationId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - displayName
              properties:
                displayName:
                  type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Index'
    servers:
    - url: https://qbusiness.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
          description: AWS region
  /applications/{applicationId}/indices/{indexId}:
    get:
      operationId: GetIndex
      summary: Get Index
      description: Gets information about an existing Amazon Q Business index.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetIndexResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetIndexRequest'
      tags:
      - Indices
    put:
      operationId: UpdateIndex
      summary: Update Index
      description: Updates an Amazon Q Business index.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateIndexResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateIndexRequest'
      tags:
      - Indices
    delete:
      operationId: DeleteIndex
      summary: Delete Index
      description: Deletes an Amazon Q Business index.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteIndexResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteIndexRequest'
      tags:
      - Indices
    servers:
    - url: https://qbusiness.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  schemas:
    Index:
      type: object
      properties:
        indexId:
          type: string
          description: The unique identifier of the index.
        displayName:
          type: string
          description: The name of the index.
        status:
          type: string
          enum:
          - CREATING
          - ACTIVE
          - DELETING
          - FAILED
          - UPDATING
          description: The status of the index.
    IndexStatistics:
      type: object
      properties:
        textDocumentStatistics:
          $ref: '#/components/schemas/TextDocumentStatistics'
    GetIndexResponse:
      type: object
      properties:
        applicationId:
          type: string
          description: The identifier of the Amazon Q Business application associated with the index.
        indexId:
          type: string
          description: The identifier of the Amazon Q Business index.
        displayName:
          type: string
          description: The name of the Amazon Q Business index.
        indexArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon Q Business index.
        status:
          type: string
          enum:
          - CREATING
          - ACTIVE
          - DELETING
          - FAILED
          - UPDATING
          description: The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
        type:
          type: string
          enum:
          - ENTERPRISE
          - STARTER
          description: The type of index attached to your Amazon Q Business application.
        description:
          type: string
          description: The description for the Amazon Q Business index.
        createdAt:
          type: string
          format: date-time
          description: The Unix timestamp when the Amazon Q Business index was created.
        updatedAt:
          type: string
          format: date-time
          description: The Unix timestamp when the Amazon Q Business index was last updated.
        capacityConfiguration:
          $ref: '#/components/schemas/IndexCapacityConfiguration'
        documentAttributeConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/DocumentAttributeConfiguration'
          description: Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.
        error:
          $ref: '#/components/schemas/ErrorDetail'
        indexStatistics:
          $ref: '#/components/schemas/IndexStatistics'
    ErrorDetail:
      type: object
      properties:
        errorMessage:
          type: string
          description: The message explaining the Amazon Q Business request error.
        errorCode:
          type: string
          enum:
          - InternalError
          - InvalidRequest
          - ResourceInactive
          - ResourceNotFound
          description: The code associated with the Amazon Q Business request error.
    UpdateIndexResponse:
      type: object
      properties: {}
    TextDocumentStatistics:
      type: object
      properties:
        indexedTextBytes:
          type: integer
          description: The total size, in bytes, of the indexed documents.
        indexedTextDocumentCount:
          type: integer
          description: The number of text documents indexed.
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
          description: The message describing a ResourceNotFoundException.
        resourceId:
          type: string
          description: The identifier of the resource affected.
        resourceType:
          type: string
          description: The type of the resource affected.
      required:
      - message
      - resourceId
      - resourceType
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    UpdateIndexRequest:
      type: object
      properties:
        applicationId:
          type: string
          description: The identifier of the Amazon Q Business application connected to the index.
        indexId:
          type: string
          description: The identifier of the Amazon Q Business index.
        displayName:
          type: string
          description: The name of the Amazon Q Business index.
        description:
          type: string
          description: The description of the Amazon Q Business index.
        capacityConfiguration:
          $ref: '#/components/schemas/IndexCapacityConfiguration'
        documentAttributeConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/DocumentAttributeConfiguration'
          description: Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.
      required:
      - applicationId
      - indexId
    DeleteIndexResponse:
      type: object
      properties: {}
    GetIndexRequest:
      type: object
      properties:
        applicationId:
          type: string
          description: The identifier of the Amazon Q Business application connected to the index.
        indexId:
          type: string
          description: The identifier of the Amazon Q Business index you want information on.
      required:
      - applicationId
      - indexId
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
          description: The message describing a ServiceQuotaExceededException.
        resourceId:
          type: string
          description: The identifier of the resource affected.
        resourceType:
          type: string
          description: The type of the resource affected.
      required:
      - message
      - resourceId
      - resourceType
    ValidationExceptionField:
      type: object
      properties:
        name:
          type: string
          description: The field name where the invalid entry was detected.
        message:
          type: string
          description: A message about the validation exception.
      required:
      - name
      - message
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ConflictException:
      type: object
      properties:
        message:
          type: string
          description: The message describing a ConflictException.
        resourceId:
          type: string
          description: The identifier of the resource affected.
        resourceType:
          type: string
          description: The type of the resource affected.
      required:
      - message
      - resourceId
      - resourceType
    ValidationException:
      type: object
      properties:
        message:
          type: string
          description: The message describing the ValidationException.
        reason:
          type: string
          enum:
          - CANNOT_PARSE
          - FIELD_VALIDATION_FAILED
          - UNKNOWN_OPERATION
          description: The reason for the ValidationException.
        fields:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
          description: The input field(s) that failed validation.
      required:
      - message
      - reason
    IndexCapacityConfiguration:
      type: object
      properties:
        units:
          type: integer
          description: The number of storage units configured for an Amazon Q Business index.
    DeleteIndexRequest:
      type: object
      properties:
        applicationId:
          type: string
          description: The identifier of the Amazon Q Business application the Amazon Q Business index is linked to.
        indexId:
          type: string
          description: The identifier of the Amazon Q Business index.
      required:
      - applicationId
      - indexId
    DocumentAttributeConfiguration:
      type: object
      properties:
        name:
          type: string
          description: The name of the document attribute.
        type:
          type: string
          enum:
          - STRING
          - STRING_LIST
          - NUMBER
          - DATE
          description: The type of document attribute.
        search:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Information about whether the document attribute can be used by an end user to search for information on their web experience.
  securitySchemes:
    sigv4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4
x-refined-from:
- amazon-q-openapi.yml
- amazon-q-indices-api-openapi.yml