1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// 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:
    ///   - [`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 index to add the documents to. You need to create the index first using the <code>CreateIndex</code> API.</p><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. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM access roles for Amazon Kendra</a>.</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> <p>Documents have the following file size limits.</p> <ul>  <li>   <p>50 MB total size for any file</p></li>  <li>   <p>5 MB extracted text for any file</p></li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas</a>.</p><br>
    ///   - [`custom_document_enrichment_configuration(CustomDocumentEnrichmentConfiguration)`](crate::operation::batch_put_document::builders::BatchPutDocumentFluentBuilder::custom_document_enrichment_configuration) / [`set_custom_document_enrichment_configuration(Option<CustomDocumentEnrichmentConfiguration>)`](crate::operation::batch_put_document::builders::BatchPutDocumentFluentBuilder::set_custom_document_enrichment_configuration):<br>required: **false**<br><p>Configuration information for altering your document metadata and content during the document ingestion process when you use the <code>BatchPutDocument</code> API.</p> <p>For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html">Customizing document metadata during the ingestion process</a>.</p><br>
    /// - On success, responds with [`BatchPutDocumentOutput`](crate::operation::batch_put_document::BatchPutDocumentOutput) with field(s):
    ///   - [`failed_documents(Option<Vec::<BatchPutDocumentResponseFailedDocument>>)`](crate::operation::batch_put_document::BatchPutDocumentOutput::failed_documents): <p>A list of documents that were not added to the 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> <p>If there was an error adding a document to an index the error is reported in your Amazon Web Services CloudWatch log. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/cloudwatch-logs.html">Monitoring Amazon Kendra with Amazon CloudWatch logs</a>.</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())
    }
}