NumericEqualityFilter
A NumericEqualityFilter filters values that are equal to the specified value.
Contents
Note
In the following list, the required parameters are described first.
- Column
-
The column that the filter is applied to.
Type: ColumnIdentifier object
Required: Yes
- FilterId
-
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
[\w\-]+Required: Yes
- MatchOperator
-
The match operator that is used to determine if a filter should be applied.
Type: String
Valid Values:
EQUALS | DOES_NOT_EQUALRequired: Yes
- NullOption
-
This option determines how null values should be treated when filtering data.
-
ALL_VALUES: Include null values in filtered results. -
NULLS_ONLY: Only include null values in filtered results. -
NON_NULLS_ONLY: Exclude null values from filtered results.
Type: String
Valid Values:
ALL_VALUES | NULLS_ONLY | NON_NULLS_ONLYRequired: Yes
-
- AggregationFunction
-
The aggregation function of the filter.
Type: AggregationFunction object
Required: No
- DefaultFilterControlConfiguration
-
The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
Type: DefaultFilterControlConfiguration object
Required: No
- ParameterName
-
The parameter whose value should be used for the filter value.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^[a-zA-Z0-9]+$Required: No
- SelectAllOptions
-
Select all of the values. Null is not the assigned value of select all.
-
FILTER_ALL_VALUES
Type: String
Valid Values:
FILTER_ALL_VALUESRequired: No
-
- Value
-
The input value.
Type: Double
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: