amazonka-quicksight-2.0: Amazon QuickSight SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.QuickSight.Types.FilterGroup

Description

 
Synopsis

Documentation

data FilterGroup Source #

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.

See: newFilterGroup smart constructor.

Constructors

FilterGroup' 

Fields

  • status :: Maybe WidgetStatus

    The status of the FilterGroup.

  • filterGroupId :: Text

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

  • filters :: [Filter]

    The list of filters that are present in a FilterGroup.

  • scopeConfiguration :: FilterScopeConfiguration

    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.

  • crossDataset :: CrossDatasetTypes

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

    • ALL_DATASETS
    • SINGLE_DATASET

Instances

Instances details
FromJSON FilterGroup Source # 
Instance details

Defined in Amazonka.QuickSight.Types.FilterGroup

ToJSON FilterGroup Source # 
Instance details

Defined in Amazonka.QuickSight.Types.FilterGroup

Generic FilterGroup Source # 
Instance details

Defined in Amazonka.QuickSight.Types.FilterGroup

Associated Types

type Rep FilterGroup :: Type -> Type #

Show FilterGroup Source # 
Instance details

Defined in Amazonka.QuickSight.Types.FilterGroup

NFData FilterGroup Source # 
Instance details

Defined in Amazonka.QuickSight.Types.FilterGroup

Methods

rnf :: FilterGroup -> () #

Eq FilterGroup Source # 
Instance details

Defined in Amazonka.QuickSight.Types.FilterGroup

Hashable FilterGroup Source # 
Instance details

Defined in Amazonka.QuickSight.Types.FilterGroup

type Rep FilterGroup Source # 
Instance details

Defined in Amazonka.QuickSight.Types.FilterGroup

type Rep FilterGroup = D1 ('MetaData "FilterGroup" "Amazonka.QuickSight.Types.FilterGroup" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "FilterGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WidgetStatus)) :*: S1 ('MetaSel ('Just "filterGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Filter]) :*: (S1 ('MetaSel ('Just "scopeConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FilterScopeConfiguration) :*: S1 ('MetaSel ('Just "crossDataset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CrossDatasetTypes)))))

newFilterGroup Source #

Create a value of FilterGroup with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:status:FilterGroup', filterGroup_status - The status of the FilterGroup.

$sel:filterGroupId:FilterGroup', filterGroup_filterGroupId - The value that uniquely identifies a FilterGroup within a dashboard, template, or analysis.

$sel:filters:FilterGroup', filterGroup_filters - The list of filters that are present in a FilterGroup.

$sel:scopeConfiguration:FilterGroup', filterGroup_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.

$sel:crossDataset:FilterGroup', filterGroup_crossDataset - The filter new feature which can apply filter group to all data sets. Choose one of the following options:

  • ALL_DATASETS
  • SINGLE_DATASET

filterGroup_status :: Lens' FilterGroup (Maybe WidgetStatus) Source #

The status of the FilterGroup.

filterGroup_filterGroupId :: Lens' FilterGroup Text Source #

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

filterGroup_filters :: Lens' FilterGroup [Filter] Source #

The list of filters that are present in a FilterGroup.

filterGroup_scopeConfiguration :: Lens' FilterGroup FilterScopeConfiguration Source #

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.

filterGroup_crossDataset :: Lens' FilterGroup CrossDatasetTypes Source #

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

  • ALL_DATASETS
  • SINGLE_DATASET