| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Kendra.BatchGetDocumentStatus
Description
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.
Synopsis
- data BatchGetDocumentStatus = BatchGetDocumentStatus' {}
- newBatchGetDocumentStatus :: Text -> NonEmpty DocumentInfo -> BatchGetDocumentStatus
- batchGetDocumentStatus_indexId :: Lens' BatchGetDocumentStatus Text
- batchGetDocumentStatus_documentInfoList :: Lens' BatchGetDocumentStatus (NonEmpty DocumentInfo)
- data BatchGetDocumentStatusResponse = BatchGetDocumentStatusResponse' {}
- newBatchGetDocumentStatusResponse :: Int -> BatchGetDocumentStatusResponse
- batchGetDocumentStatusResponse_documentStatusList :: Lens' BatchGetDocumentStatusResponse (Maybe [Status])
- batchGetDocumentStatusResponse_errors :: Lens' BatchGetDocumentStatusResponse (Maybe [BatchGetDocumentStatusResponseError])
- batchGetDocumentStatusResponse_httpStatus :: Lens' BatchGetDocumentStatusResponse Int
Creating a Request
data BatchGetDocumentStatus Source #
See: newBatchGetDocumentStatus smart constructor.
Constructors
| BatchGetDocumentStatus' | |
Fields
| |
Instances
newBatchGetDocumentStatus Source #
Arguments
| :: Text | |
| -> NonEmpty DocumentInfo | |
| -> BatchGetDocumentStatus |
Create a value of BatchGetDocumentStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:indexId:BatchGetDocumentStatus', batchGetDocumentStatus_indexId - The identifier of the index to add documents to. The index ID is
returned by the
CreateIndex
API.
$sel:documentInfoList:BatchGetDocumentStatus', batchGetDocumentStatus_documentInfoList - 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.
Request Lenses
batchGetDocumentStatus_indexId :: Lens' BatchGetDocumentStatus Text Source #
The identifier of the index to add documents to. The index ID is returned by the CreateIndex API.
batchGetDocumentStatus_documentInfoList :: Lens' BatchGetDocumentStatus (NonEmpty DocumentInfo) Source #
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.
Destructuring the Response
data BatchGetDocumentStatusResponse Source #
See: newBatchGetDocumentStatusResponse smart constructor.
Constructors
| BatchGetDocumentStatusResponse' | |
Fields
| |
Instances
newBatchGetDocumentStatusResponse Source #
Create a value of BatchGetDocumentStatusResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:documentStatusList:BatchGetDocumentStatusResponse', batchGetDocumentStatusResponse_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.
$sel:errors:BatchGetDocumentStatusResponse', batchGetDocumentStatusResponse_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.
$sel:httpStatus:BatchGetDocumentStatusResponse', batchGetDocumentStatusResponse_httpStatus - The response's http status code.
Response Lenses
batchGetDocumentStatusResponse_documentStatusList :: Lens' BatchGetDocumentStatusResponse (Maybe [Status]) Source #
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.
batchGetDocumentStatusResponse_errors :: Lens' BatchGetDocumentStatusResponse (Maybe [BatchGetDocumentStatusResponseError]) Source #
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.
batchGetDocumentStatusResponse_httpStatus :: Lens' BatchGetDocumentStatusResponse Int Source #
The response's http status code.