Class: Aws::Kendra::Types::DocumentAttributeTarget

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

Note:

When making an API call, you may pass DocumentAttributeTarget data as a hash:

{
  target_document_attribute_key: "DocumentAttributeKey",
  target_document_attribute_value_deletion: false,
  target_document_attribute_value: {
    string_value: "DocumentAttributeStringValue",
    string_list_value: ["String"],
    long_value: 1,
    date_value: Time.now,
  },
}

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#target_document_attribute_keyString

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.

Returns:

  • (String)


6534
6535
6536
6537
6538
6539
6540
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 6534

class DocumentAttributeTarget < Struct.new(
  :target_document_attribute_key,
  :target_document_attribute_value_deletion,
  :target_document_attribute_value)
  SENSITIVE = []
  include Aws::Structure
end

#target_document_attribute_valueTypes::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'.



6534
6535
6536
6537
6538
6539
6540
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 6534

class DocumentAttributeTarget < Struct.new(
  :target_document_attribute_key,
  :target_document_attribute_value_deletion,
  :target_document_attribute_value)
  SENSITIVE = []
  include Aws::Structure
end

#target_document_attribute_value_deletionBoolean

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.

Returns:

  • (Boolean)


6534
6535
6536
6537
6538
6539
6540
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 6534

class DocumentAttributeTarget < Struct.new(
  :target_document_attribute_key,
  :target_document_attribute_value_deletion,
  :target_document_attribute_value)
  SENSITIVE = []
  include Aws::Structure
end