TimeEqualityFilter
A TimeEqualityFilter filters values that are equal to a given value.
Contents
Note
In the following list, the required parameters are described first.
- Column
-
The column that the filter is applied to.
Type: ColumnIdentifier object
Required: Yes
- FilterId
-
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
[\w\-]+Required: Yes
- DefaultFilterControlConfiguration
-
The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
Type: DefaultFilterControlConfiguration object
Required: No
- ParameterName
-
The parameter whose value should be used for the filter value.
This field is mutually exclusive to
ValueandRollingDate.Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^[a-zA-Z0-9]+$Required: No
- RollingDate
-
The rolling date input for the
TimeEqualityfilter.This field is mutually exclusive to
ValueandParameterName.Type: RollingDateConfiguration object
Required: No
- TimeGranularity
-
The level of time precision that is used to aggregate
DateTimevalues.Type: String
Valid Values:
YEAR | QUARTER | MONTH | WEEK | DAY | HOUR | MINUTE | SECOND | MILLISECONDRequired: No
- Value
-
The value of a
TimeEqualityfilter.This field is mutually exclusive to
RollingDateandParameterName.Type: Timestamp
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: