RelativeDatesFilter - Amazon QuickSight
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

RelativeDatesFilter

A RelativeDatesFilter filters relative dates values.

Contents

Note

In the following list, the required parameters are described first.

AnchorDateConfiguration

The date configuration of the filter.

Type: AnchorDateConfiguration object

Required: Yes

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

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.

Type: String

Valid Values: ALL_VALUES | NULLS_ONLY | NON_NULLS_ONLY

Required: Yes

RelativeDateType

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

  • PREVIOUS

  • THIS

  • LAST

  • NOW

  • NEXT

Type: String

Valid Values: PREVIOUS | THIS | LAST | NOW | NEXT

Required: Yes

TimeGranularity

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

Type: String

Valid Values: YEAR | QUARTER | MONTH | WEEK | DAY | HOUR | MINUTE | SECOND | MILLISECOND

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

ExcludePeriodConfiguration

The configuration for the exclude period of the filter.

Type: ExcludePeriodConfiguration object

Required: No

MinimumGranularity

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

Type: String

Valid Values: YEAR | QUARTER | MONTH | WEEK | DAY | HOUR | MINUTE | SECOND | MILLISECOND

Required: No

ParameterName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^[a-zA-Z0-9]+$

Required: No

RelativeDateValue

The date value of the filter.

Type: Integer

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: