Skip to content

TemplateVersionDefinition

Source code in docs_src/capo_quicksight/types/template_version_definition.py
class TemplateVersionDefinition(TypedDict, closed=True):
    data_set_configurations: (
        "capo_quicksight.types.data_set_configuration_list.DataSetConfigurationList"
    )
    """<p>An array of dataset configurations. These configurations define the required columns for each dataset used within a template.</p>"""
    topic_configurations: NotRequired[
        "capo_quicksight.types.topic_configuration_list.TopicConfigurationList"
    ]
    """<p>An array of topic configurations. These configurations define the required columns for each topic used within a template.</p>"""
    sheets: NotRequired[
        "capo_quicksight.types.sheet_definition_list.SheetDefinitionList"
    ]
    """<p>An array of sheet definitions for a template.</p>"""
    tooltip_sheets: NotRequired[
        "capo_quicksight.types.tooltip_sheet_definition_list.TooltipSheetDefinitionList"
    ]
    """<p>An array of tooltip sheet definitions for a template.</p>"""
    calculated_fields: NotRequired[
        "capo_quicksight.types.calculated_fields.CalculatedFields"
    ]
    """<p>An array of calculated field definitions for the template.</p>"""
    parameter_declarations: NotRequired[
        "capo_quicksight.types.parameter_declaration_list.ParameterDeclarationList"
    ]
    """<p>An array of parameter declarations for a template.</p> <p> <i>Parameters</i> 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>Filter definitions for a template.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/filtering-visual-data.html">Filtering Data</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 template-level column configurations. Column configurations are used to set default formatting for a column that's used throughout a template. </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 template.</p>"""
    query_execution_options: NotRequired[
        "capo_quicksight.types.query_execution_options.QueryExecutionOptions"
    ]
    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 template.

column_configurations instance-attribute

column_configurations: NotRequired[ColumnConfigurationList]

An array of template-level column configurations. Column configurations are used to set default formatting for a column that's used throughout a template.

data_set_configurations instance-attribute

data_set_configurations: DataSetConfigurationList

An array of dataset configurations. These configurations define the required columns for each dataset used within a template.

filter_groups instance-attribute

filter_groups: NotRequired[FilterGroupList]

Filter definitions for a template.

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

options instance-attribute

options: NotRequired[AssetOptions]

An array of option definitions for a template.

parameter_declarations instance-attribute

parameter_declarations: NotRequired[ParameterDeclarationList]

An array of parameter declarations for a template.

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.

query_execution_options instance-attribute

query_execution_options: NotRequired[QueryExecutionOptions]

sheets instance-attribute

sheets: NotRequired[SheetDefinitionList]

An array of sheet definitions for a template.

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 template.

topic_configurations instance-attribute

topic_configurations: NotRequired[TopicConfigurationList]

An array of topic configurations. These configurations define the required columns for each topic used within a template.