aws_sdk_qbusiness/client/
batch_delete_document.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`BatchDeleteDocument`](crate::operation::batch_delete_document::builders::BatchDeleteDocumentFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`application_id(impl Into<String>)`](crate::operation::batch_delete_document::builders::BatchDeleteDocumentFluentBuilder::application_id) / [`set_application_id(Option<String>)`](crate::operation::batch_delete_document::builders::BatchDeleteDocumentFluentBuilder::set_application_id):<br>required: **true**<br><p>The identifier of the Amazon Q Business application.</p><br>
7    ///   - [`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 Amazon Q Business index that contains the documents to delete.</p><br>
8    ///   - [`documents(DeleteDocument)`](crate::operation::batch_delete_document::builders::BatchDeleteDocumentFluentBuilder::documents) / [`set_documents(Option<Vec::<DeleteDocument>>)`](crate::operation::batch_delete_document::builders::BatchDeleteDocumentFluentBuilder::set_documents):<br>required: **true**<br><p>Documents deleted from the Amazon Q Business index.</p><br>
9    ///   - [`data_source_sync_id(impl Into<String>)`](crate::operation::batch_delete_document::builders::BatchDeleteDocumentFluentBuilder::data_source_sync_id) / [`set_data_source_sync_id(Option<String>)`](crate::operation::batch_delete_document::builders::BatchDeleteDocumentFluentBuilder::set_data_source_sync_id):<br>required: **false**<br><p>The identifier of the data source sync during which the documents were deleted.</p><br>
10    /// - On success, responds with [`BatchDeleteDocumentOutput`](crate::operation::batch_delete_document::BatchDeleteDocumentOutput) with field(s):
11    ///   - [`failed_documents(Option<Vec::<FailedDocument>>)`](crate::operation::batch_delete_document::BatchDeleteDocumentOutput::failed_documents): <p>A list of documents that couldn't be removed from the Amazon Q Business index. Each entry contains an error message that indicates why the document couldn't be removed from the index.</p>
12    /// - On failure, responds with [`SdkError<BatchDeleteDocumentError>`](crate::operation::batch_delete_document::BatchDeleteDocumentError)
13    pub fn batch_delete_document(&self) -> crate::operation::batch_delete_document::builders::BatchDeleteDocumentFluentBuilder {
14        crate::operation::batch_delete_document::builders::BatchDeleteDocumentFluentBuilder::new(self.handle.clone())
15    }
16}
aws_sdk_qbusiness/client/batch_delete_document.rs

aws_sdk_qbusiness/client/
batch_delete_document.rs
