Struct DocumentAttributeTarget 

#[non_exhaustive]
pub struct DocumentAttributeTarget {
    pub target_document_attribute_key: Option<String>,
    pub target_document_attribute_value_deletion: bool,
    pub target_document_attribute_value: Option<DocumentAttributeValue>,
}

The target document attribute or metadata field you want to alter when ingesting documents into Amazon Kendra.

For example, you can delete customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID'. You set the target key as 'Customer_ID' and the deletion flag to TRUE. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.

Amazon Kendra cannot create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Kendra then will map your newly created metadata field to your index field.

You can also use this with DocumentAttributeCondition.

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.

target_document_attribute_key: Option<String>

The identifier of the target document attribute or metadata field.

For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.

target_document_attribute_value_deletion: bool

TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE. To create a target value (TargetDocumentAttributeValue), set this to FALSE.

target_document_attribute_value: Option<DocumentAttributeValue>

The target value you want to create for the target attribute.

For example, 'Finance' could be the target value for the target attribute key 'Department'.

Implementations

impl DocumentAttributeTarget

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

The identifier of the target document attribute or metadata field.

For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.

pub fn target_document_attribute_value_deletion(&self) -> bool

TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE. To create a target value (TargetDocumentAttributeValue), set this to FALSE.

pub fn target_document_attribute_value(&self) -> Option<&DocumentAttributeValue>

The target value you want to create for the target attribute.

For example, 'Finance' could be the target value for the target attribute key 'Department'.

impl DocumentAttributeTarget

pub fn builder() -> DocumentAttributeTargetBuilder

Creates a new builder-style object to manufacture DocumentAttributeTarget.

Trait Implementations

impl Clone for DocumentAttributeTarget

fn clone(&self) -> DocumentAttributeTarget

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentAttributeTarget

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

Formats the value using the given formatter.

impl PartialEq for DocumentAttributeTarget

fn eq(&self, other: &DocumentAttributeTarget) -> 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 DocumentAttributeTarget