Skip to content

AnalysisDefinition

Source code in docs_src/capo_quicksight/types/analysis_definition.py
class AnalysisDefinition(TypedDict, closed=True):
    data_set_identifier_declarations: "capo_quicksight.types.data_set_identifier_declaration_list.DataSetIdentifierDeclarationList"
    """<p>An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures.</p>"""
    topic_identifier_declarations: NotRequired[
        "capo_quicksight.types.topic_identifier_declaration_list.TopicIdentifierDeclarationList"
    ]
    """<p>An array of topic identifier declarations. This mapping allows the usage of topic identifiers instead of topic ARNs throughout analysis sub-structures.</p>"""
    sheets: NotRequired[
        "capo_quicksight.types.sheet_definition_list.SheetDefinitionList"
    ]
    """<p>An array of sheet definitions for an analysis. Each <code>SheetDefinition</code> provides detailed information about a sheet within this analysis.</p>"""
    tooltip_sheets: NotRequired[
        "capo_quicksight.types.tooltip_sheet_definition_list.TooltipSheetDefinitionList"
    ]
    """<p>An array of tooltip sheet definitions for an analysis. Each <code>TooltipSheetDefinition</code> provides detailed information about a tooltip sheet within this analysis.</p>"""
    calculated_fields: NotRequired[
        "capo_quicksight.types.calculated_fields.CalculatedFields"
    ]
    """<p>An array of calculated field definitions for the analysis.</p>"""
    parameter_declarations: NotRequired[
        "capo_quicksight.types.parameter_declaration_list.ParameterDeclarationList"
    ]
    """<p>An array of parameter declarations for an analysis.</p> <p>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>Filter definitions for an analysis.</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 analysis-level column configurations. Column configurations can be used to set default formatting for a column to be used throughout an analysis. </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 an analysis.</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 analysis.

column_configurations instance-attribute

column_configurations: NotRequired[ColumnConfigurationList]

An array of analysis-level column configurations. Column configurations can be used to set default formatting for a column to be used throughout an analysis.

data_set_identifier_declarations instance-attribute

data_set_identifier_declarations: DataSetIdentifierDeclarationList

An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures.

filter_groups instance-attribute

filter_groups: NotRequired[FilterGroupList]

Filter definitions for an analysis.

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 an analysis.

parameter_declarations instance-attribute

parameter_declarations: NotRequired[ParameterDeclarationList]

An array of parameter declarations for an analysis.

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 an analysis. Each SheetDefinition provides detailed information about a sheet within this analysis.

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 an analysis. Each TooltipSheetDefinition provides detailed information about a tooltip sheet within this analysis.

topic_identifier_declarations instance-attribute

topic_identifier_declarations: NotRequired[TopicIdentifierDeclarationList]

An array of topic identifier declarations. This mapping allows the usage of topic identifiers instead of topic ARNs throughout analysis sub-structures.