

# CategoryFilter
<a name="API_CategoryFilter"></a>

A `CategoryFilter` filters text values.

For more information, see [Adding text filters](https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html) in the *Amazon Quick Suite User Guide*.

## Contents
<a name="API_CategoryFilter_Contents"></a>

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

 ** Column **   <a name="QS-Type-CategoryFilter-Column"></a>
The column that the filter is applied to.  
Type: [ColumnIdentifier](API_ColumnIdentifier.md) object  
Required: Yes

 ** Configuration **   <a name="QS-Type-CategoryFilter-Configuration"></a>
The configuration for a `CategoryFilter`.  
Type: [CategoryFilterConfiguration](API_CategoryFilterConfiguration.md) object  
Required: Yes

 ** FilterId **   <a name="QS-Type-CategoryFilter-FilterId"></a>
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 **   <a name="QS-Type-CategoryFilter-DefaultFilterControlConfiguration"></a>
The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.  
Type: [DefaultFilterControlConfiguration](API_DefaultFilterControlConfiguration.md) object  
Required: No

## See Also
<a name="API_CategoryFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/quicksight-2018-04-01/CategoryFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/quicksight-2018-04-01/CategoryFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/quicksight-2018-04-01/CategoryFilter) 