ListDocumentsCommand

Suggest an Edit

A list of documents attached to an index.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { QBusinessClient, ListDocumentsCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
// const { QBusinessClient, ListDocumentsCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
const client = new QBusinessClient(config);
const input = { // ListDocumentsRequest
  applicationId: "STRING_VALUE", // required
  indexId: "STRING_VALUE", // required
  dataSourceIds: [ // DataSourceIds
    "STRING_VALUE",
  ],
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
};
const command = new ListDocumentsCommand(input);
const response = await client.send(command);
// { // ListDocumentsResponse
//   documentDetailList: [ // DocumentDetailList
//     { // DocumentDetails
//       documentId: "STRING_VALUE",
//       status: "RECEIVED" || "PROCESSING" || "INDEXED" || "UPDATED" || "FAILED" || "DELETING" || "DELETED" || "DOCUMENT_FAILED_TO_INDEX",
//       error: { // ErrorDetail
//         errorMessage: "STRING_VALUE",
//         errorCode: "InternalError" || "InvalidRequest" || "ResourceInactive" || "ResourceNotFound",
//       },
//       createdAt: new Date("TIMESTAMP"),
//       updatedAt: new Date("TIMESTAMP"),
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListDocumentsCommand Input

See ListDocumentsCommandInput for more details

Parameter
Type
Description
applicationId
Required
string | undefined

The identifier of the application id the documents are attached to.

indexId
Required
string | undefined

The identifier of the index the documents are attached to.

dataSourceIds
string[] | undefined

The identifier of the data sources the documents are attached to.

maxResults
number | undefined

The maximum number of documents to return.

nextToken
string | undefined

If the maxResults 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.

ListDocumentsCommand Output

See ListDocumentsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
documentDetailList
DocumentDetails[] | undefined

A list of document details.

nextToken
string | undefined

If the maxResults 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.

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

InternalServerException
server

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support  for help.

ResourceNotFoundException
client

The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

ThrottlingException
client

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException
client

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

QBusinessServiceException
Base exception class for all service exceptions from QBusiness service.