TopBottomFilter - Amazon QuickSight
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).

TopBottomFilter

A TopBottomFilter filters values that are at the top or the bottom.

Contents

Note

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

AggregationSortConfigurations

The aggregation and sort configuration of the top bottom filter.

Type: Array of AggregationSortConfiguration objects

Array Members: Maximum number of 100 items.

Required: Yes

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

DefaultFilterControlConfiguration

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

Type: DefaultFilterControlConfiguration object

Required: No

Limit

The number of items to include in the top bottom filter results.

Type: Integer

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

TimeGranularity

The level of time precision that is used to aggregate DateTime values.

Type: String

Valid Values: YEAR | QUARTER | MONTH | WEEK | DAY | HOUR | MINUTE | SECOND | MILLISECOND

Required: No

See Also

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