View a markdown version of this page

HierarchyFilter - Amazon Quick
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

HierarchyFilter

A HierarchyFilter filters data by drilling down through an ordered list of columns. Each level in the list narrows the data by one column, and the selected values at each level determine which values are available at the next.

Contents

Note

In the following list, the required parameters are described first.

Column

The column that anchors the filter. This column determines the dataset that the whole filter applies to, so every column in HierarchyLevels and in HierarchyTree must belong to the same dataset.

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

HierarchyLevels

The ordered list of columns that defines the drill-down path of the filter. The first level is the top of the hierarchy. You can specify a maximum of 5 levels.

Type: Array of HierarchyFilterLevel objects

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Required: Yes

MatchOperator

Determines whether the values selected in HierarchyTree are kept or removed. Choose one of the following options:

  • INCLUDE: Keep only the selected values.

  • EXCLUDE: Remove the selected values.

Type: String

Valid Values: INCLUDE | EXCLUDE

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

DefaultFilterControlConfiguration

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

Type: DefaultFilterControlConfiguration object

Required: No

HierarchyTree

The tree of selected values for the filter. Each node records the values that are selected at one level of the hierarchy, and its children record the selections beneath those values. Omit this attribute to define the drill-down path without restricting any values.

Type: HierarchyFilterNode object

Required: No

See Also

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