Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.QuickSight.Types.RelativeDatesFilter

Description

Synopsis

Documentation

data RelativeDatesFilter Source #

A RelativeDatesFilter filters relative dates values.

See: newRelativeDatesFilter smart constructor.

Constructors

RelativeDatesFilter'

Fields

excludePeriodConfiguration :: Maybe ExcludePeriodConfiguration
The configuration for the exclude period of the filter.
minimumGranularity :: Maybe TimeGranularity
The minimum granularity (period granularity) of the relative dates filter.
parameterName :: Maybe Text
The parameter whose value should be used for the filter value.
relativeDateValue :: Maybe Int
The date value of the filter.
filterId :: Text
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
column :: ColumnIdentifier
The column that the filter is applied to.
anchorDateConfiguration :: AnchorDateConfiguration
The date configuration of the filter.
timeGranularity :: TimeGranularity
The level of time precision that is used to aggregate DateTime values.
relativeDateType :: RelativeDateType
The range date type of the filter. Choose one of the options below:
- ```
PREVIOUS
```
- ```
THIS
```
- ```
LAST
```
- ```
NOW
```
- ```
NEXT
```
nullOption :: FilterNullOption
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.

Instances

Instances details

FromJSON RelativeDatesFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.RelativeDatesFilter Methods parseJSON :: Value -> Parser RelativeDatesFilter # parseJSONList :: Value -> Parser [RelativeDatesFilter] #
ToJSON RelativeDatesFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.RelativeDatesFilter Methods toJSON :: RelativeDatesFilter -> Value # toEncoding :: RelativeDatesFilter -> Encoding # toJSONList :: [RelativeDatesFilter] -> Value # toEncodingList :: [RelativeDatesFilter] -> Encoding #
Generic RelativeDatesFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.RelativeDatesFilter Associated Types type Rep RelativeDatesFilter :: Type -> Type # Methods from :: RelativeDatesFilter -> Rep RelativeDatesFilter x # to :: Rep RelativeDatesFilter x -> RelativeDatesFilter #
Read RelativeDatesFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.RelativeDatesFilter Methods readsPrec :: Int -> ReadS RelativeDatesFilter # readList :: ReadS [RelativeDatesFilter] # readPrec :: ReadPrec RelativeDatesFilter # readListPrec :: ReadPrec [RelativeDatesFilter] #
Show RelativeDatesFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.RelativeDatesFilter Methods showsPrec :: Int -> RelativeDatesFilter -> ShowS # show :: RelativeDatesFilter -> String # showList :: [RelativeDatesFilter] -> ShowS #
NFData RelativeDatesFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.RelativeDatesFilter Methods rnf :: RelativeDatesFilter -> () #
Eq RelativeDatesFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.RelativeDatesFilter Methods (==) :: RelativeDatesFilter -> RelativeDatesFilter -> Bool # (/=) :: RelativeDatesFilter -> RelativeDatesFilter -> Bool #
Hashable RelativeDatesFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.RelativeDatesFilter Methods hashWithSalt :: Int -> RelativeDatesFilter -> Int # hash :: RelativeDatesFilter -> Int #
type Rep RelativeDatesFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.RelativeDatesFilter type Rep RelativeDatesFilter = D1 ('MetaData "RelativeDatesFilter" "Amazonka.QuickSight.Types.RelativeDatesFilter" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "RelativeDatesFilter'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "excludePeriodConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExcludePeriodConfiguration)) :: S1 ('MetaSel ('Just "minimumGranularity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeGranularity))) :: (S1 ('MetaSel ('Just "parameterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "relativeDateValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "filterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) :: ((S1 ('MetaSel ('Just "column") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ColumnIdentifier) :: S1 ('MetaSel ('Just "anchorDateConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AnchorDateConfiguration)) :: (S1 ('MetaSel ('Just "timeGranularity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TimeGranularity) :: (S1 ('MetaSel ('Just "relativeDateType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RelativeDateType) :*: S1 ('MetaSel ('Just "nullOption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FilterNullOption))))))

newRelativeDatesFilter Source #

Arguments

:: Text	`$sel:filterId:RelativeDatesFilter'`
-> ColumnIdentifier	`$sel:column:RelativeDatesFilter'`
-> AnchorDateConfiguration	`$sel:anchorDateConfiguration:RelativeDatesFilter'`
-> TimeGranularity	`$sel:timeGranularity:RelativeDatesFilter'`
-> RelativeDateType	`$sel:relativeDateType:RelativeDatesFilter'`
-> FilterNullOption	`$sel:nullOption:RelativeDatesFilter'`
-> RelativeDatesFilter

Create a value of RelativeDatesFilter 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:excludePeriodConfiguration:RelativeDatesFilter', relativeDatesFilter_excludePeriodConfiguration - The configuration for the exclude period of the filter.

$sel:minimumGranularity:RelativeDatesFilter', relativeDatesFilter_minimumGranularity - The minimum granularity (period granularity) of the relative dates filter.

RelativeDatesFilter, relativeDatesFilter_parameterName - The parameter whose value should be used for the filter value.

$sel:relativeDateValue:RelativeDatesFilter', relativeDatesFilter_relativeDateValue - The date value of the filter.

$sel:filterId:RelativeDatesFilter', relativeDatesFilter_filterId - An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

$sel:column:RelativeDatesFilter', relativeDatesFilter_column - The column that the filter is applied to.

$sel:anchorDateConfiguration:RelativeDatesFilter', relativeDatesFilter_anchorDateConfiguration - The date configuration of the filter.

$sel:timeGranularity:RelativeDatesFilter', relativeDatesFilter_timeGranularity - The level of time precision that is used to aggregate DateTime values.

$sel:relativeDateType:RelativeDatesFilter', relativeDatesFilter_relativeDateType - The range date type of the filter. Choose one of the options below:

```
PREVIOUS
```
```
THIS
```
```
LAST
```
```
NOW
```
```
NEXT
```

$sel:nullOption:RelativeDatesFilter', relativeDatesFilter_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.

relativeDatesFilter_excludePeriodConfiguration :: Lens' RelativeDatesFilter (Maybe ExcludePeriodConfiguration) Source #

The configuration for the exclude period of the filter.

relativeDatesFilter_minimumGranularity :: Lens' RelativeDatesFilter (Maybe TimeGranularity) Source #

The minimum granularity (period granularity) of the relative dates filter.

relativeDatesFilter_parameterName :: Lens' RelativeDatesFilter (Maybe Text) Source #

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

relativeDatesFilter_relativeDateValue :: Lens' RelativeDatesFilter (Maybe Int) Source #

The date value of the filter.

relativeDatesFilter_filterId :: Lens' RelativeDatesFilter Text Source #

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

relativeDatesFilter_column :: Lens' RelativeDatesFilter ColumnIdentifier Source #

The column that the filter is applied to.

relativeDatesFilter_anchorDateConfiguration :: Lens' RelativeDatesFilter AnchorDateConfiguration Source #

The date configuration of the filter.

relativeDatesFilter_timeGranularity :: Lens' RelativeDatesFilter TimeGranularity Source #

The level of time precision that is used to aggregate DateTime values.

relativeDatesFilter_relativeDateType :: Lens' RelativeDatesFilter RelativeDateType Source #

The range date type of the filter. Choose one of the options below:

```
PREVIOUS
```
```
THIS
```
```
LAST
```
```
NOW
```
```
NEXT
```

relativeDatesFilter_nullOption :: Lens' RelativeDatesFilter FilterNullOption Source #

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.