DateDimensionField - 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).

DateDimensionField

The dimension type field with date type columns.

Contents

Note

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

Column

The column that is used in the DateDimensionField.

Type: ColumnIdentifier object

Required: Yes

FieldId

The custom field ID.

Type: String

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

Required: Yes

DateGranularity

The date granularity of the DateDimensionField. Choose one of the following options:

  • YEAR

  • QUARTER

  • MONTH

  • WEEK

  • DAY

  • HOUR

  • MINUTE

  • SECOND

  • MILLISECOND

Type: String

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

Required: No

FormatConfiguration

The format configuration of the field.

Type: DateTimeFormatConfiguration object

Required: No

HierarchyId

The custom hierarchy ID.

Type: String

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

Required: No

See Also

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