BatchGetDocumentStatus
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.
Request Syntax
{
"DocumentInfoList": [
{
"Attributes": [
{
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
}
],
"DocumentId": "string"
}
],
"IndexId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- DocumentInfoList
-
A list of
DocumentInfoobjects that identify the documents for which to get the status. You identify the documents by their document ID and optional attributes.Type: Array of DocumentInfo objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: Yes
- IndexId
-
The identifier of the index to add documents to. The index ID is returned by the CreateIndex API.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9-]*Required: Yes
Response Syntax
{
"DocumentStatusList": [
{
"DocumentId": "string",
"DocumentStatus": "string",
"FailureCode": "string",
"FailureReason": "string"
}
],
"Errors": [
{
"DataSourceId": "string",
"DocumentId": "string",
"ErrorCode": "string",
"ErrorMessage": "string"
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- DocumentStatusList
-
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.
Type: Array of Status objects
- Errors
-
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.
Type: Array of BatchGetDocumentStatusResponseError objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
HTTP Status Code: 400
- ConflictException
-
A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
HTTP Status Code: 400
- InternalServerException
-
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. HTTP Status Code: 500
- ResourceNotFoundException
-
The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
HTTP Status Code: 400
- ThrottlingException
-
The request was denied due to request throttling. Please reduce the number of requests and try again.
HTTP Status Code: 400
- ValidationException
-
The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
