A CategoryFilter filters text values.
For more information, see Adding text filters in the Amazon QuickSight User Guide.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"Column" : ColumnIdentifier,
"Configuration" : CategoryFilterConfiguration,
"DefaultFilterControlConfiguration" : DefaultFilterControlConfiguration,
"FilterId" : String
}
YAML
Column:
ColumnIdentifier
Configuration:
CategoryFilterConfiguration
DefaultFilterControlConfiguration:
DefaultFilterControlConfiguration
FilterId: String
Properties
Column-
The column that the filter is applied to.
Required: Yes
Type: ColumnIdentifier
Update requires: No interruption
Configuration-
The configuration for a
CategoryFilter.Required: Yes
Type: CategoryFilterConfiguration
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:
1Maximum:
512Update requires: No interruption
