AWS::Kendra::DataSource DocumentAttributeCondition
The condition used for the target document attribute or metadata field when ingesting documents into Amazon Kendra. You use this with DocumentAttributeTarget to apply the condition.
For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.
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.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "ConditionDocumentAttributeKey" :
String
, "ConditionOnValue" :DocumentAttributeValue
, "Operator" :String
}
YAML
ConditionDocumentAttributeKey:
String
ConditionOnValue:DocumentAttributeValue
Operator:String
Properties
ConditionDocumentAttributeKey
-
The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Kendra currently does not support
_document_body
as an attribute key used for the condition.Required: Yes
Type: String
Pattern:
[a-zA-Z0-9_][a-zA-Z0-9_-]*
Minimum:
1
Maximum:
200
Update requires: No interruption
ConditionOnValue
-
The value used by the operator.
For example, you can specify the value 'financial' for strings in the 'Source_URI' field that partially match or contain this value.
Required: No
Type: DocumentAttributeValue
Update requires: No interruption
Operator
-
The condition operator.
For example, you can use 'Contains' to partially match a string.
Required: Yes
Type: String
Allowed values:
GreaterThan | GreaterThanOrEquals | LessThan | LessThanOrEquals | Equals | NotEquals | Contains | NotContains | Exists | NotExists | BeginsWith
Update requires: No interruption