aws_sdk_qbusiness/client/

batch_put_document.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`BatchPutDocument`](crate::operation::batch_put_document::builders::BatchPutDocumentFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`application_id(impl Into<String>)`](crate::operation::batch_put_document::builders::BatchPutDocumentFluentBuilder::application_id) / [`set_application_id(Option<String>)`](crate::operation::batch_put_document::builders::BatchPutDocumentFluentBuilder::set_application_id):<br>required: **true**<br><p>The identifier of the Amazon Q Business application.</p><br>
    ///   - [`index_id(impl Into<String>)`](crate::operation::batch_put_document::builders::BatchPutDocumentFluentBuilder::index_id) / [`set_index_id(Option<String>)`](crate::operation::batch_put_document::builders::BatchPutDocumentFluentBuilder::set_index_id):<br>required: **true**<br><p>The identifier of the Amazon Q Business index to add the documents to.</p><br>
    ///   - [`documents(Document)`](crate::operation::batch_put_document::builders::BatchPutDocumentFluentBuilder::documents) / [`set_documents(Option<Vec::<Document>>)`](crate::operation::batch_put_document::builders::BatchPutDocumentFluentBuilder::set_documents):<br>required: **true**<br><p>One or more documents to add to the index.</p><important>  <p>Ensure that the name of your document doesn't contain any confidential information. Amazon Q Business returns document names in chat responses and citations when relevant.</p> </important><br>
    ///   - [`role_arn(impl Into<String>)`](crate::operation::batch_put_document::builders::BatchPutDocumentFluentBuilder::role_arn) / [`set_role_arn(Option<String>)`](crate::operation::batch_put_document::builders::BatchPutDocumentFluentBuilder::set_role_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.</p><br>
    ///   - [`data_source_sync_id(impl Into<String>)`](crate::operation::batch_put_document::builders::BatchPutDocumentFluentBuilder::data_source_sync_id) / [`set_data_source_sync_id(Option<String>)`](crate::operation::batch_put_document::builders::BatchPutDocumentFluentBuilder::set_data_source_sync_id):<br>required: **false**<br><p>The identifier of the data source sync during which the documents were added.</p><br>
    /// - On success, responds with [`BatchPutDocumentOutput`](crate::operation::batch_put_document::BatchPutDocumentOutput) with field(s):
    ///   - [`failed_documents(Option<Vec::<FailedDocument>>)`](crate::operation::batch_put_document::BatchPutDocumentOutput::failed_documents): <p>A list of documents that were not added to the Amazon Q Business index because the document failed a validation check. Each document contains an error message that indicates why the document couldn't be added to the index.</p>
    /// - On failure, responds with [`SdkError<BatchPutDocumentError>`](crate::operation::batch_put_document::BatchPutDocumentError)
    pub fn batch_put_document(&self) -> crate::operation::batch_put_document::builders::BatchPutDocumentFluentBuilder {
        crate::operation::batch_put_document::builders::BatchPutDocumentFluentBuilder::new(self.handle.clone())
    }
}