| 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.BatchDeleteDocument
Description
Removes one or more documents from an index. The documents must have
been added with the BatchPutDocument API.
The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to you CloudWatch log.
Synopsis
- data BatchDeleteDocument = BatchDeleteDocument' {}
- newBatchDeleteDocument :: Text -> NonEmpty Text -> BatchDeleteDocument
- batchDeleteDocument_dataSourceSyncJobMetricTarget :: Lens' BatchDeleteDocument (Maybe DataSourceSyncJobMetricTarget)
- batchDeleteDocument_indexId :: Lens' BatchDeleteDocument Text
- batchDeleteDocument_documentIdList :: Lens' BatchDeleteDocument (NonEmpty Text)
- data BatchDeleteDocumentResponse = BatchDeleteDocumentResponse' {}
- newBatchDeleteDocumentResponse :: Int -> BatchDeleteDocumentResponse
- batchDeleteDocumentResponse_failedDocuments :: Lens' BatchDeleteDocumentResponse (Maybe [BatchDeleteDocumentResponseFailedDocument])
- batchDeleteDocumentResponse_httpStatus :: Lens' BatchDeleteDocumentResponse Int
Creating a Request
data BatchDeleteDocument Source #
See: newBatchDeleteDocument smart constructor.
Constructors
| BatchDeleteDocument' | |
Fields
| |
Instances
newBatchDeleteDocument Source #
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> BatchDeleteDocument |
Create a value of BatchDeleteDocument 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:dataSourceSyncJobMetricTarget:BatchDeleteDocument', batchDeleteDocument_dataSourceSyncJobMetricTarget - Undocumented member.
$sel:indexId:BatchDeleteDocument', batchDeleteDocument_indexId - The identifier of the index that contains the documents to delete.
$sel:documentIdList:BatchDeleteDocument', batchDeleteDocument_documentIdList - One or more identifiers for documents to delete from the index.
Request Lenses
batchDeleteDocument_dataSourceSyncJobMetricTarget :: Lens' BatchDeleteDocument (Maybe DataSourceSyncJobMetricTarget) Source #
Undocumented member.
batchDeleteDocument_indexId :: Lens' BatchDeleteDocument Text Source #
The identifier of the index that contains the documents to delete.
batchDeleteDocument_documentIdList :: Lens' BatchDeleteDocument (NonEmpty Text) Source #
One or more identifiers for documents to delete from the index.
Destructuring the Response
data BatchDeleteDocumentResponse Source #
See: newBatchDeleteDocumentResponse smart constructor.
Constructors
| BatchDeleteDocumentResponse' | |
Fields
| |
Instances
newBatchDeleteDocumentResponse Source #
Create a value of BatchDeleteDocumentResponse 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:failedDocuments:BatchDeleteDocumentResponse', batchDeleteDocumentResponse_failedDocuments - A list of documents that could not be removed from the index. Each entry
contains an error message that indicates why the document couldn't be
removed from the index.
$sel:httpStatus:BatchDeleteDocumentResponse', batchDeleteDocumentResponse_httpStatus - The response's http status code.
Response Lenses
batchDeleteDocumentResponse_failedDocuments :: Lens' BatchDeleteDocumentResponse (Maybe [BatchDeleteDocumentResponseFailedDocument]) Source #
A list of documents that could not be removed from the index. Each entry contains an error message that indicates why the document couldn't be removed from the index.
batchDeleteDocumentResponse_httpStatus :: Lens' BatchDeleteDocumentResponse Int Source #
The response's http status code.