AWS::QuickSight::Template TopBottomFilter
A TopBottomFilter
filters values that are at the top or the bottom.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "AggregationSortConfigurations" :
[ AggregationSortConfiguration, ... ]
, "Column" :ColumnIdentifier
, "DefaultFilterControlConfiguration" :DefaultFilterControlConfiguration
, "FilterId" :String
, "Limit" :Number
, "ParameterName" :String
, "TimeGranularity" :String
}
YAML
AggregationSortConfigurations:
- AggregationSortConfiguration
Column:ColumnIdentifier
DefaultFilterControlConfiguration:DefaultFilterControlConfiguration
FilterId:String
Limit:Number
ParameterName:String
TimeGranularity:String
Properties
AggregationSortConfigurations
-
The aggregation and sort configuration of the top bottom filter.
Required: Yes
Type: Array of AggregationSortConfiguration
Minimum:
0
Maximum:
100
Update requires: No interruption
Column
-
The column that the filter is applied to.
Required: Yes
Type: ColumnIdentifier
Update requires: No interruption
DefaultFilterControlConfiguration
-
The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
Required: No
Type: DefaultFilterControlConfiguration
Update requires: No interruption
FilterId
-
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
Required: Yes
Type: String
Pattern:
^[\w\-]+$
Minimum:
1
Maximum:
512
Update requires: No interruption
Limit
-
The number of items to include in the top bottom filter results.
Required: No
Type: Number
Update requires: No interruption
ParameterName
-
The parameter whose value should be used for the filter value.
Required: No
Type: String
Pattern:
^[a-zA-Z0-9]+$
Minimum:
1
Maximum:
2048
Update requires: No interruption
TimeGranularity
-
The level of time precision that is used to aggregate
DateTime
values.Required: No
Type: String
Allowed values:
YEAR | QUARTER | MONTH | WEEK | DAY | HOUR | MINUTE | SECOND | MILLISECOND
Update requires: No interruption