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

FilterGroup

A grouping of individual filters. Filter groups are applied to the same group of visuals.

For more information, see Adding filter conditions (group filters) with AND and OR operators in the Amazon QuickSight User Guide.

Contents

Note

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

CrossDataset

The filter new feature which can apply filter group to all data sets. Choose one of the following options:

  • ALL_DATASETS

  • SINGLE_DATASET

Type: String

Valid Values: ALL_DATASETS | SINGLE_DATASET

Required: Yes

FilterGroupId

The value that uniquely identifies a FilterGroup within a dashboard, template, or analysis.

Type: String

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

Pattern: [\w\-]+

Required: Yes

Filters

The list of filters that are present in a FilterGroup.

Type: Array of Filter objects

Array Members: Maximum number of 20 items.

Required: Yes

ScopeConfiguration

The configuration that specifies what scope to apply to a FilterGroup.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Type: FilterScopeConfiguration object

Required: Yes

Status

The status of the FilterGroup.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

See Also

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