AttributeFilter - Amazon Q Business
ContentsSee Also
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

AttributeFilter

The filter criteria used on responses based on document attributes or metadata fields.

Contents

andAllFilters

Performs a logical AND operation on all supplied filters.

Type: Array of AttributeFilter objects

Required: No

containsAll

Returns true when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.

Type: DocumentAttribute object

Required: No

containsAny

Returns true when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.

Type: DocumentAttribute object

Required: No

equalsTo

Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue, longValue, stringListValue and stringValue.

Type: DocumentAttribute object

Required: No

greaterThan

Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

Type: DocumentAttribute object

Required: No

greaterThanOrEquals

Performs a greater than or equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

Type: DocumentAttribute object

Required: No

lessThan

Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

Type: DocumentAttribute object

Required: No

lessThanOrEquals

Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type: dateValue and longValue.

Type: DocumentAttribute object

Required: No

notFilter

Performs a logical NOT operation on all supplied filters.

Type: AttributeFilter object

Required: No

orAllFilters

Performs a logical OR operation on all supplied filters.

Type: Array of AttributeFilter objects

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: