CustomFilterConfiguration - 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).

CustomFilterConfiguration

A custom filter that filters based on a single value. This filter can be partially matched.

Contents

Note

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

MatchOperator

The match operator that is used to determine if a filter should be applied.

Type: String

Valid Values: EQUALS | DOES_NOT_EQUAL | CONTAINS | DOES_NOT_CONTAIN | STARTS_WITH | ENDS_WITH

Required: Yes

NullOption

This option determines how null values should be treated when filtering data.

  • ALL_VALUES: Include null values in filtered results.

  • NULLS_ONLY: Only include null values in filtered results.

  • NON_NULLS_ONLY: Exclude null values from filtered results.

Type: String

Valid Values: ALL_VALUES | NULLS_ONLY | NON_NULLS_ONLY

Required: Yes

CategoryValue

The category value for the filter.

This field is mutually exclusive to ParameterName.

Type: String

Length Constraints: Maximum length of 512.

Required: No

ParameterName

The parameter whose value should be used for the filter value.

This field is mutually exclusive to CategoryValue.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^[a-zA-Z0-9]+$

Required: No

SelectAllOptions

Select all of the values. Null is not the assigned value of select all.

  • FILTER_ALL_VALUES

Type: String

Valid Values: FILTER_ALL_VALUES

Required: No

See Also

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