AWS::QuickSight::Dashboard RelativeDatesFilter
A RelativeDatesFilter filters relative dates values.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "AnchorDateConfiguration" :AnchorDateConfiguration, "Column" :ColumnIdentifier, "DefaultFilterControlConfiguration" :DefaultFilterControlConfiguration, "ExcludePeriodConfiguration" :ExcludePeriodConfiguration, "FilterId" :String, "MinimumGranularity" :String, "NullOption" :String, "ParameterName" :String, "RelativeDateType" :String, "RelativeDateValue" :Number, "TimeGranularity" :String}
YAML
AnchorDateConfiguration:AnchorDateConfigurationColumn:ColumnIdentifierDefaultFilterControlConfiguration:DefaultFilterControlConfigurationExcludePeriodConfiguration:ExcludePeriodConfigurationFilterId:StringMinimumGranularity:StringNullOption:StringParameterName:StringRelativeDateType:StringRelativeDateValue:NumberTimeGranularity:String
Properties
AnchorDateConfiguration-
The date configuration of the filter.
Required: Yes
Type: AnchorDateConfiguration
Update requires: No interruption
Column-
The column that the filter is applied to.
Required: Yes
Type: ColumnIdentifier
Update requires: No interruption
DefaultFilterControlConfiguration-
The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
Required: No
Type: DefaultFilterControlConfiguration
Update requires: No interruption
ExcludePeriodConfiguration-
The configuration for the exclude period of the filter.
Required: No
Type: ExcludePeriodConfiguration
Update requires: No interruption
FilterId-
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
Required: Yes
Type: String
Pattern:
^[\w\-]+$Minimum:
1Maximum:
512Update requires: No interruption
MinimumGranularity-
The minimum granularity (period granularity) of the relative dates filter.
Required: No
Type: String
Allowed values:
YEAR | QUARTER | MONTH | WEEK | DAY | HOUR | MINUTE | SECOND | MILLISECONDUpdate requires: No interruption
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.
Required: Yes
Type: String
Allowed values:
ALL_VALUES | NULLS_ONLY | NON_NULLS_ONLYUpdate requires: No interruption
-
ParameterName-
The parameter whose value should be used for the filter value.
Required: No
Type: String
Pattern:
^[a-zA-Z0-9]+$Minimum:
1Maximum:
2048Update requires: No interruption
RelativeDateType-
The range date type of the filter. Choose one of the options below:
-
PREVIOUS -
THIS -
LAST -
NOW -
NEXT
Required: Yes
Type: String
Allowed values:
PREVIOUS | THIS | LAST | NOW | NEXTUpdate requires: No interruption
-
RelativeDateValue-
The date value of the filter.
Required: No
Type: Number
Update requires: No interruption
TimeGranularity-
The level of time precision that is used to aggregate
DateTimevalues.Required: Yes
Type: String
Allowed values:
YEAR | QUARTER | MONTH | WEEK | DAY | HOUR | MINUTE | SECOND | MILLISECONDUpdate requires: No interruption