Skip to content

DashboardVersionDefinition

Source code in docs_src/capo_quicksight/types/dashboard_version_definition.py
class DashboardVersionDefinition(TypedDict, closed=True):
    data_set_identifier_declarations: "capo_quicksight.types.data_set_identifier_declaration_list.DataSetIdentifierDeclarationList"
    """<p>An array of dataset identifier declarations. With this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard's sub-structures.</p>"""
    topic_identifier_declarations: NotRequired[
        "capo_quicksight.types.topic_identifier_declaration_list.TopicIdentifierDeclarationList"
    ]
    """<p>An array of topic identifier declarations. With this mapping, you can use topic identifiers instead of topic Amazon Resource Names (ARNs) throughout the dashboard's sub-structures.</p>"""
    sheets: NotRequired[
        "capo_quicksight.types.sheet_definition_list.SheetDefinitionList"
    ]
    """<p>An array of sheet definitions for a dashboard.</p>"""
    tooltip_sheets: NotRequired[
        "capo_quicksight.types.tooltip_sheet_definition_list.TooltipSheetDefinitionList"
    ]
    """<p>An array of tooltip sheet definitions for a dashboard.</p>"""
    calculated_fields: NotRequired[
        "capo_quicksight.types.calculated_fields.CalculatedFields"
    ]
    """<p>An array of calculated field definitions for the dashboard.</p>"""
    parameter_declarations: NotRequired[
        "capo_quicksight.types.parameter_declaration_list.ParameterDeclarationList"
    ]
    """<p>The parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html">Parameters in Amazon Quick Sight</a> in the <i>Amazon Quick Suite User Guide</i>.</p>"""
    filter_groups: NotRequired[
        "capo_quicksight.types.filter_group_list.FilterGroupList"
    ]
    """<p>The filter definitions for a dashboard.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/adding-a-filter.html">Filtering Data in Amazon Quick Sight</a> in the <i>Amazon Quick Suite User Guide</i>.</p>"""
    column_configurations: NotRequired[
        "capo_quicksight.types.column_configuration_list.ColumnConfigurationList"
    ]
    """<p>An array of dashboard-level column configurations. Column configurations are used to set the default formatting for a column that is used throughout a dashboard. </p>"""
    analysis_defaults: NotRequired[
        "capo_quicksight.types.analysis_defaults.AnalysisDefaults"
    ]
    options: NotRequired["capo_quicksight.types.asset_options.AssetOptions"]
    """<p>An array of option definitions for a dashboard.</p>"""
    static_files: NotRequired["capo_quicksight.types.static_file_list.StaticFileList"]
    """<p>The static files for the definition.</p>"""

analysis_defaults instance-attribute

analysis_defaults: NotRequired[AnalysisDefaults]

calculated_fields instance-attribute

calculated_fields: NotRequired[CalculatedFields]

An array of calculated field definitions for the dashboard.

column_configurations instance-attribute

column_configurations: NotRequired[ColumnConfigurationList]

An array of dashboard-level column configurations. Column configurations are used to set the default formatting for a column that is used throughout a dashboard.

data_set_identifier_declarations instance-attribute

data_set_identifier_declarations: DataSetIdentifierDeclarationList

An array of dataset identifier declarations. With this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard's sub-structures.

filter_groups instance-attribute

filter_groups: NotRequired[FilterGroupList]

The filter definitions for a dashboard.

For more information, see Filtering Data in Amazon Quick Sight in the Amazon Quick Suite User Guide.

options instance-attribute

options: NotRequired[AssetOptions]

An array of option definitions for a dashboard.

parameter_declarations instance-attribute

parameter_declarations: NotRequired[ParameterDeclarationList]

The parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object.

For more information, see Parameters in Amazon Quick Sight in the Amazon Quick Suite User Guide.

sheets instance-attribute

sheets: NotRequired[SheetDefinitionList]

An array of sheet definitions for a dashboard.

static_files instance-attribute

static_files: NotRequired[StaticFileList]

The static files for the definition.

tooltip_sheets instance-attribute

tooltip_sheets: NotRequired[TooltipSheetDefinitionList]

An array of tooltip sheet definitions for a dashboard.

topic_identifier_declarations instance-attribute

topic_identifier_declarations: NotRequired[TopicIdentifierDeclarationList]

An array of topic identifier declarations. With this mapping, you can use topic identifiers instead of topic Amazon Resource Names (ARNs) throughout the dashboard's sub-structures.