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_PARAMSto pass filters as individual query parameters, orFILTER_STRINGto construct a single filter expression string.Type: String
Valid Values:
QUERY_PARAMS | FILTER_STRINGRequired: 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
DateTimeFormatterpatterns (for example,EEE, d MMM yyyy HH:mm:ss Z),EPOCH_SECONDSfor Unix epoch seconds, orEPOCH_MILLISfor 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
FilterModeis set toFILTER_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, andOR.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: