NumericRangeFilter - Amazon QuickSight

NumericRangeFilter

A NumericRangeFilter filters values that are within the value range.

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

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_ONLY

Required: 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

IncludeMaximum

Determines whether the maximum value in the filter value range should be included in the filtered results.

Type: Boolean

Required: No

IncludeMinimum

Determines whether the minimum value in the filter value range should be included in the filtered results.

Type: Boolean

Required: No

RangeMaximum

The maximum value for the filter value range.

Type: NumericRangeFilterValue object

Required: No

RangeMinimum

The minimum value for the filter value range.

Type: NumericRangeFilterValue object

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_VALUES

Required: No

See Also

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