AWS::QuickSight::Template TimeRangeFilter
A TimeRangeFilter filters values that are between two specified values.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Column" :ColumnIdentifier, "DefaultFilterControlConfiguration" :DefaultFilterControlConfiguration, "ExcludePeriodConfiguration" :ExcludePeriodConfiguration, "FilterId" :String, "IncludeMaximum" :Boolean, "IncludeMinimum" :Boolean, "NullOption" :String, "RangeMaximumValue" :TimeRangeFilterValue, "RangeMinimumValue" :TimeRangeFilterValue, "TimeGranularity" :String}
YAML
Column:ColumnIdentifierDefaultFilterControlConfiguration:DefaultFilterControlConfigurationExcludePeriodConfiguration:ExcludePeriodConfigurationFilterId:StringIncludeMaximum:BooleanIncludeMinimum:BooleanNullOption:StringRangeMaximumValue:TimeRangeFilterValueRangeMinimumValue:TimeRangeFilterValueTimeGranularity:String
Properties
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 exclude period of the time range 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
IncludeMaximum-
Determines whether the maximum value in the filter value range should be included in the filtered results.
Required: No
Type: Boolean
Update requires: No interruption
IncludeMinimum-
Determines whether the minimum value in the filter value range should be included in the filtered results.
Required: No
Type: Boolean
Update 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
-
RangeMaximumValue-
The maximum value for the filter value range.
Required: No
Type: TimeRangeFilterValue
Update requires: No interruption
RangeMinimumValue-
The minimum value for the filter value range.
Required: No
Type: TimeRangeFilterValue
Update requires: No interruption
TimeGranularity-
The level of time precision that is used to aggregate
DateTimevalues.Required: No
Type: String
Allowed values:
YEAR | QUARTER | MONTH | WEEK | DAY | HOUR | MINUTE | SECOND | MILLISECONDUpdate requires: No interruption
