BatchGetDocumentStatusCommand

Suggest an Edit

Returns the indexing status for one or more documents submitted with the BatchPutDocument  API.

When you use the BatchPutDocument API, documents are indexed asynchronously. You can use the BatchGetDocumentStatus API to get the current status of a list of documents so that you can determine if they have been successfully indexed.

You can also use the BatchGetDocumentStatus API to check the status of the BatchDeleteDocument  API. When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status.

Example Syntax

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

import { KendraClient, BatchGetDocumentStatusCommand } from "@aws-sdk/client-kendra"; // ES Modules import
// const { KendraClient, BatchGetDocumentStatusCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
const client = new KendraClient(config);
const input = { // BatchGetDocumentStatusRequest
  IndexId: "STRING_VALUE", // required
  DocumentInfoList: [ // DocumentInfoList // required
    { // DocumentInfo
      DocumentId: "STRING_VALUE", // required
      Attributes: [ // DocumentAttributeList
        { // DocumentAttribute
          Key: "STRING_VALUE", // required
          Value: { // DocumentAttributeValue
            StringValue: "STRING_VALUE",
            StringListValue: [ // DocumentAttributeStringListValue
              "STRING_VALUE",
            ],
            LongValue: Number("long"),
            DateValue: new Date("TIMESTAMP"),
          },
        },
      ],
    },
  ],
};
const command = new BatchGetDocumentStatusCommand(input);
const response = await client.send(command);
// { // BatchGetDocumentStatusResponse
//   Errors: [ // BatchGetDocumentStatusResponseErrors
//     { // BatchGetDocumentStatusResponseError
//       DocumentId: "STRING_VALUE",
//       DataSourceId: "STRING_VALUE",
//       ErrorCode: "InternalError" || "InvalidRequest",
//       ErrorMessage: "STRING_VALUE",
//     },
//   ],
//   DocumentStatusList: [ // DocumentStatusList
//     { // Status
//       DocumentId: "STRING_VALUE",
//       DocumentStatus: "NOT_FOUND" || "PROCESSING" || "INDEXED" || "UPDATED" || "FAILED" || "UPDATE_FAILED",
//       FailureCode: "STRING_VALUE",
//       FailureReason: "STRING_VALUE",
//     },
//   ],
// };

BatchGetDocumentStatusCommand Input

See BatchGetDocumentStatusCommandInput for more details

Parameter
Type
Description
DocumentInfoList
Required
DocumentInfo[] | undefined

A list of DocumentInfo objects that identify the documents for which to get the status. You identify the documents by their document ID and optional attributes.

IndexId
Required
string | undefined

The identifier of the index to add documents to. The index ID is returned by the CreateIndex   API.

BatchGetDocumentStatusCommand Output

See BatchGetDocumentStatusCommandOutput for details

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

The status of documents. The status indicates if the document is waiting to be indexed, is in the process of indexing, has completed indexing, or failed indexing. If a document failed indexing, the status provides the reason why.

Errors
BatchGetDocumentStatusResponseError[] | undefined

A list of documents that Amazon Kendra couldn't get the status for. The list includes the ID of the document and the reason that the status couldn't be found.

Throws

Name
Fault
Details
AccessDeniedException
client

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

ConflictException
client

A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

InternalServerException
server

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support  for help.

ResourceNotFoundException
client

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException
client

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

ValidationException
client

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

KendraServiceException
Base exception class for all service exceptions from Kendra service.