Skip to content

DateDimensionField

Source code in docs_src/capo_quicksight/types/date_dimension_field.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class DateDimensionField(TypedDict, closed=True):
    field_id: "capo_quicksight.types.field_id.FieldId"
    """<p>The custom field ID.</p>"""
    column: "capo_quicksight.types.column_identifier.ColumnIdentifier"
    """<p>The column that is used in the <code>DateDimensionField</code>.</p>"""
    date_granularity: NotRequired[
        "capo_quicksight.types.time_granularity.TimeGranularity"
    ]
    """<p>The date granularity of the <code>DateDimensionField</code>. Choose one of the following options:</p> <ul> <li> <p> <code>YEAR</code> </p> </li> <li> <p> <code>QUARTER</code> </p> </li> <li> <p> <code>MONTH</code> </p> </li> <li> <p> <code>WEEK</code> </p> </li> <li> <p> <code>DAY</code> </p> </li> <li> <p> <code>HOUR</code> </p> </li> <li> <p> <code>MINUTE</code> </p> </li> <li> <p> <code>SECOND</code> </p> </li> <li> <p> <code>MILLISECOND</code> </p> </li> </ul>"""
    hierarchy_id: NotRequired["capo_quicksight.types.hierarchy_id.HierarchyId"]
    """<p>The custom hierarchy ID.</p>"""
    format_configuration: NotRequired[
        "capo_quicksight.types.date_time_format_configuration.DateTimeFormatConfiguration"
    ]
    """<p>The format configuration of the field.</p>"""

column instance-attribute 

column: ColumnIdentifier

The column that is used in the DateDimensionField.

date_granularity instance-attribute 

date_granularity: NotRequired[TimeGranularity]

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

  • YEAR

  • QUARTER

  • MONTH

  • WEEK

  • DAY

  • HOUR

  • MINUTE

  • SECOND

  • MILLISECOND

field_id instance-attribute 

field_id: FieldId

The custom field ID.

format_configuration instance-attribute 

format_configuration: NotRequired[DateTimeFormatConfiguration]

The format configuration of the field.

hierarchy_id instance-attribute 

hierarchy_id: NotRequired[HierarchyId]

The custom hierarchy ID.