TopicColumn ¶

class TopicColumn(TypedDict, closed=True):
    column_name: "capo_quicksight.types.limited_string.LimitedString"
    """<p>The name of the column.</p>"""
    column_friendly_name: NotRequired[
        "capo_quicksight.types.limited_sensitive_string.LimitedSensitiveString"
    ]
    """<p>A user-friendly name for the column.</p>"""
    column_description: NotRequired[
        "capo_quicksight.types.description_sensitive_string.DescriptionSensitiveString"
    ]
    """<p>A description of the column and its contents.</p>"""
    column_synonyms: NotRequired["capo_quicksight.types.synonyms.Synonyms"]
    """<p>The other names or aliases for the column.</p>"""
    column_data_role: NotRequired[
        "capo_quicksight.types.column_data_role.ColumnDataRole"
    ]
    """<p>The role of the column in the data. Valid values are <code>DIMENSION</code> and <code>MEASURE</code>.</p>"""
    aggregation: NotRequired[
        "capo_quicksight.types.default_aggregation.DefaultAggregation"
    ]
    """<p>The type of aggregation that is performed on the column data when it's queried.</p>"""
    is_included_in_topic: "capo_quicksight.types.boolean.Boolean"
    """<p>A Boolean value that indicates whether the column is included in the query results.</p>"""
    disable_indexing: NotRequired[
        "capo_quicksight.types.nullable_boolean.NullableBoolean"
    ]
    """<p>A Boolean value that indicates whether the column shows in the autocomplete functionality.</p>"""
    comparative_order: NotRequired[
        "capo_quicksight.types.comparative_order.ComparativeOrder"
    ]
    """<p>The order in which data is displayed for the column when it's used in a comparative context.</p>"""
    semantic_type: NotRequired["capo_quicksight.types.semantic_type.SemanticType"]
    """<p>The semantic type of data contained in the column.</p>"""
    time_granularity: NotRequired[
        "capo_quicksight.types.topic_time_granularity.TopicTimeGranularity"
    ]
    """<p>The level of time precision that is used to aggregate <code>DateTime</code> values.</p>"""
    allowed_aggregations: NotRequired[
        "capo_quicksight.types.author_specified_aggregations.AuthorSpecifiedAggregations"
    ]
    """<p>The list of aggregation types that are allowed for the column. Valid values for this structure are <code>COUNT</code>, <code>DISTINCT_COUNT</code>, <code>MIN</code>, <code>MAX</code>, <code>MEDIAN</code>, <code>SUM</code>, <code>AVERAGE</code>, <code>STDEV</code>, <code>STDEVP</code>, <code>VAR</code>, <code>VARP</code>, and <code>PERCENTILE</code>.</p>"""
    not_allowed_aggregations: NotRequired[
        "capo_quicksight.types.author_specified_aggregations.AuthorSpecifiedAggregations"
    ]
    """<p>The list of aggregation types that are not allowed for the column. Valid values for this structure are <code>COUNT</code>, <code>DISTINCT_COUNT</code>, <code>MIN</code>, <code>MAX</code>, <code>MEDIAN</code>, <code>SUM</code>, <code>AVERAGE</code>, <code>STDEV</code>, <code>STDEVP</code>, <code>VAR</code>, <code>VARP</code>, and <code>PERCENTILE</code>.</p>"""
    default_formatting: NotRequired[
        "capo_quicksight.types.default_formatting.DefaultFormatting"
    ]
    """<p>The default formatting used for values in the column.</p>"""
    never_aggregate_in_filter: "capo_quicksight.types.boolean.Boolean"
    """<p>A Boolean value that indicates whether to aggregate the column data when it's used in a filter context.</p>"""
    cell_value_synonyms: NotRequired[
        "capo_quicksight.types.cell_value_synonyms.CellValueSynonyms"
    ]
    """<p>The other names or aliases for the column cell value.</p>"""
    non_additive: NotRequired["capo_quicksight.types.nullable_boolean.NullableBoolean"]
    """<p>The non additive value for the column.</p>"""