Struct aws_sdk_qbusiness::types::DocumentAttributeTarget

#[non_exhaustive]
pub struct DocumentAttributeTarget {
    pub key: String,
    pub value: Option<DocumentAttributeValue>,
    pub attribute_value_operator: Option<AttributeValueOperator>,
}

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

For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting 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 Q can't 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 Q will then map your newly created document attribute 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.

key: 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.

value: Option<DocumentAttributeValue>

The value of a document attribute. You can only provide one value for a document attribute.

attribute_value_operator: Option<AttributeValueOperator>

TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE.

Implementations

impl DocumentAttributeTarget

pub fn key(&self) -> &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 value(&self) -> Option<&DocumentAttributeValue>

The value of a document attribute. You can only provide one value for a document attribute.

pub fn attribute_value_operator(&self) -> Option<&AttributeValueOperator>

TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE.

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 copy 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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for DocumentAttributeTarget