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

Description¶

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

When you use the batch_put_document API, documents are indexed asynchronously. You can use the batch_get_document_status 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 batch_get_document_status 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.

Usage¶

kendra_batch_get_document_status(IndexId, DocumentInfoList)

Arguments¶

IndexId

[required] The identifier of the index to add documents to. The index ID is returned by the CreateIndex API.
DocumentInfoList

[required] 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.

Value¶

A list with the following syntax:

list(
  Errors = list(
    list(
      DocumentId = "string",
      DataSourceId = "string",
      ErrorCode = "InternalError"|"InvalidRequest",
      ErrorMessage = "string"
    )
  ),
  DocumentStatusList = list(
    list(
      DocumentId = "string",
      DocumentStatus = "NOT_FOUND"|"PROCESSING"|"INDEXED"|"UPDATED"|"FAILED"|"UPDATE_FAILED",
      FailureCode = "string",
      FailureReason = "string"
    )
  )
)

Request syntax¶

svc$batch_get_document_status(
  IndexId = "string",
  DocumentInfoList = list(
    list(
      DocumentId = "string",
      Attributes = list(
        list(
          Key = "string",
          Value = list(
            StringValue = "string",
            StringListValue = list(
              "string"
            ),
            LongValue = 123,
            DateValue = as.POSIXct(
              "2015-01-01"
            )
          )
        )
      )
    )
  )
)