---
title: "GET /applications/{applicationId}/index/{indexId}/documents"
method: GET
path: "/applications/{applicationId}/index/{indexId}/documents"
---

# GET /applications/{applicationId}/index/{indexId}/documents

`GET /applications/{applicationId}/index/{indexId}/documents`

A list of documents attached to an index.

## Path parameters

- `applicationId` string, required
- `indexId` string, required

## Query parameters

- `dataSourceIds` DataSourceId[]
- `nextToken` string
- `maxResults` integer

## Response `200`

Success

- ListDocumentsResponse
  - `documentDetailList` DocumentDetails[] — A list of document details.
    - `documentId` string — The identifier of the document.
    - `status` 'RECEIVED' | 'PROCESSING' | 'INDEXED' | 'UPDATED' | 'FAILED' | 'DELETING' | 'DELETED' | 'DOCUMENT_FAILED_TO_INDEX' — The current status of the document.
    - `error` object — An error message associated with the document.
      - `errorMessage` string — The message explaining the Amazon Q Business request error.
      - `errorCode` 'InternalError' | 'InvalidRequest' | 'ResourceInactive' | 'ResourceNotFound' — The code associated with the Amazon Q Business request error.
    - `createdAt` string, date-time — The timestamp for when the document was created.
    - `updatedAt` string, date-time — The timestamp for when the document was last updated.
  - `nextToken` string — If the <code>maxResults</code> response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.

## Other responses

- `480` — InternalServerException
- `481` — ResourceNotFoundException
- `482` — ThrottlingException
- `483` — ValidationException
- `484` — AccessDeniedException

---

[API](https://skmtc.net/aws/apis/qbusiness.md) · [All operations](https://skmtc.net/aws/apis/qbusiness/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/qbusiness/versions/82966d6c4053/schema)
