Struct BatchPutDocumentInput 

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

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.

application_id: Option<String>

The identifier of the Amazon Q Business application.

index_id: Option<String>

The identifier of the Amazon Q Business index to add the documents to.

documents: Option<Vec<Document>>

One or more documents to add to the index.

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.

role_arn: Option<String>

The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.

data_source_sync_id: Option<String>

The identifier of the data source sync during which the documents were added.

Implementations

impl BatchPutDocumentInput

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

The identifier of the Amazon Q Business application.

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

The identifier of the Amazon Q Business index to add the documents to.

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

One or more documents to add to the index.

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.

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 role_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.

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

The identifier of the data source sync during which the documents were added.

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