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


A CategoryFilter filters text values.

For more information, see Adding text filters in the Amazon QuickSight User Guide.



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


The column that the filter is applied to.

Type: ColumnIdentifier object

Required: Yes


The configuration for a CategoryFilter.

Type: CategoryFilterConfiguration object

Required: Yes


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


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

Type: DefaultFilterControlConfiguration object

Required: No

See Also

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