aws_sdk_kendra/client/

batch_delete_document.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`BatchDeleteDocument`](crate::operation::batch_delete_document::builders::BatchDeleteDocumentFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`index_id(impl Into<String>)`](crate::operation::batch_delete_document::builders::BatchDeleteDocumentFluentBuilder::index_id) / [`set_index_id(Option<String>)`](crate::operation::batch_delete_document::builders::BatchDeleteDocumentFluentBuilder::set_index_id):<br>required: **true**<br><p>The identifier of the index that contains the documents to delete.</p><br>
    ///   - [`document_id_list(impl Into<String>)`](crate::operation::batch_delete_document::builders::BatchDeleteDocumentFluentBuilder::document_id_list) / [`set_document_id_list(Option<Vec::<String>>)`](crate::operation::batch_delete_document::builders::BatchDeleteDocumentFluentBuilder::set_document_id_list):<br>required: **true**<br><p>One or more identifiers for documents to delete from the index.</p><br>
    ///   - [`data_source_sync_job_metric_target(DataSourceSyncJobMetricTarget)`](crate::operation::batch_delete_document::builders::BatchDeleteDocumentFluentBuilder::data_source_sync_job_metric_target) / [`set_data_source_sync_job_metric_target(Option<DataSourceSyncJobMetricTarget>)`](crate::operation::batch_delete_document::builders::BatchDeleteDocumentFluentBuilder::set_data_source_sync_job_metric_target):<br>required: **false**<br><p>Maps a particular data source sync job to a particular data source.</p><br>
    /// - On success, responds with [`BatchDeleteDocumentOutput`](crate::operation::batch_delete_document::BatchDeleteDocumentOutput) with field(s):
    ///   - [`failed_documents(Option<Vec::<BatchDeleteDocumentResponseFailedDocument>>)`](crate::operation::batch_delete_document::BatchDeleteDocumentOutput::failed_documents): <p>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.</p>
    /// - On failure, responds with [`SdkError<BatchDeleteDocumentError>`](crate::operation::batch_delete_document::BatchDeleteDocumentError)
    pub fn batch_delete_document(&self) -> crate::operation::batch_delete_document::builders::BatchDeleteDocumentFluentBuilder {
        crate::operation::batch_delete_document::builders::BatchDeleteDocumentFluentBuilder::new(self.handle.clone())
    }
}