AWS::QBusiness::DataSource DocumentAttributeTarget

Filter View

All

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

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 Business 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 Business will then map your newly created document attribute to your index field.

You can also use this with DocumentAttributeCondition.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "AttributeValueOperator" : String,
  "Key" : String,
  "Value" : DocumentAttributeValue
}

YAML

  AttributeValueOperator: String
  Key: String
  Value: 
    DocumentAttributeValue

Properties

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.

Required: No

Type: String

Allowed values: DELETE

Update requires: No interruption

Key

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.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9_][a-zA-Z0-9_-]*$

Minimum: 1

Maximum: 200

Update requires: No interruption

Value

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

Required: No

Type: DocumentAttributeValue

Update requires: No interruption