Struct BatchPutDocumentInput 

#[non_exhaustive]
pub struct BatchPutDocumentInput {
    pub index_id: Option<String>,
    pub role_arn: Option<String>,
    pub documents: Option<Vec<Document>>,
    pub custom_document_enrichment_configuration: Option<CustomDocumentEnrichmentConfiguration>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

index_id: Option<String>

The identifier of the index to add the documents to. You need to create the index first using the CreateIndex API.

role_arn: Option<String>

The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket. For more information, see IAM access roles for Amazon Kendra.

documents: Option<Vec<Document>>

One or more documents to add to the index.

Documents have the following file size limits.

• 50 MB total size for any file

• 5 MB extracted text for any file

For more information, see Quotas.

custom_document_enrichment_configuration: Option<CustomDocumentEnrichmentConfiguration>

Configuration information for altering your document metadata and content during the document ingestion process when you use the BatchPutDocument API.

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 Customizing document metadata during the ingestion process.

Implementations

impl BatchPutDocumentInput

pub fn index_id(&self) -> Option<&str>

The identifier of the index to add the documents to. You need to create the index first using the CreateIndex API.

pub fn role_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket. For more information, see IAM access roles for Amazon Kendra.

pub fn documents(&self) -> &[Document]

One or more documents to add to the index.

Documents have the following file size limits.

• 50 MB total size for any file

• 5 MB extracted text for any file

For more information, see Quotas.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .documents.is_none().

pub fn custom_document_enrichment_configuration( &self, ) -> Option<&CustomDocumentEnrichmentConfiguration>

Configuration information for altering your document metadata and content during the document ingestion process when you use the BatchPutDocument API.

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 Customizing document metadata during the ingestion process.

impl BatchPutDocumentInput

pub fn builder() -> BatchPutDocumentInputBuilder

Creates a new builder-style object to manufacture BatchPutDocumentInput.

Trait Implementations

impl Clone for BatchPutDocumentInput

fn clone(&self) -> BatchPutDocumentInput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BatchPutDocumentInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for BatchPutDocumentInput

fn eq(&self, other: &BatchPutDocumentInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BatchPutDocumentInput