View a markdown version of this page

FilterConfiguration - AWS Glue

FilterConfiguration

Configuration that defines how filter predicates are applied to REST API requests, supporting both query parameter and filter string strategies.

Contents

FilterMode

The strategy for applying filters to requests. Use QUERY_PARAMS to pass filters as individual query parameters, or FILTER_STRING to construct a single filter expression string.

Type: String

Valid Values: QUERY_PARAMS | FILTER_STRING

Required: Yes

BetweenConfiguration

Configuration for handling BETWEEN range filter operations.

Type: BetweenConfiguration object

Required: No

DateTimeFormat

The global date and time format for filter expressions. Accepts Java DateTimeFormatter patterns (for example, EEE, d MMM yyyy HH:mm:ss Z), EPOCH_SECONDS for Unix epoch seconds, or EPOCH_MILLIS for Unix epoch milliseconds. If not specified, values are passed as-is in ISO-8601 format.

Type: String

Required: No

FilterStringConfiguration

Configuration for constructing filter expressions when FilterMode is set to FILTER_STRING.

Type: FilterStringConfiguration object

Required: No

OperatorMappings

A map of logical filter operators to their API-specific string representations. Supported operator keys are: EQUAL_TO, NOT_EQUAL_TO, LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, CONTAINS, BETWEEN, AND, and OR.

Type: String to string map

Required: No

StripQuotes

Indicates whether surrounding double quotes should be stripped from filter values before processing.

Type: Boolean

Required: No

See Also

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