Skip to content

UpdateAnalysisRequest

Source code in docs_src/capo_quicksight/types/update_analysis_request.py
class UpdateAnalysisRequest(TypedDict, closed=True):
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId"
    """<p>The ID of the Amazon Web Services account that contains the analysis that you're updating.</p>"""
    analysis_id: (
        "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId"
    )
    """<p>The ID for the analysis that you're updating. This ID displays in the URL of the analysis.</p>"""
    name: "capo_quicksight.types.analysis_name.AnalysisName"
    """<p>A descriptive name for the analysis that you're updating. This name displays for the analysis in the Amazon Quick Sight console.</p>"""
    parameters: NotRequired["capo_quicksight.types.parameters.Parameters"]
    """<p>The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values. </p>"""
    source_entity: NotRequired[
        "capo_quicksight.types.analysis_source_entity.AnalysisSourceEntity"
    ]
    """<p>A source entity to use for the analysis that you're updating. This metadata structure contains details that describe a source template and one or more datasets or topics.</p>"""
    theme_arn: NotRequired["capo_quicksight.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating. To see the theme in the Amazon Quick Sight console, make sure that you have access to it.</p>"""
    definition: NotRequired[
        "capo_quicksight.types.analysis_definition.AnalysisDefinition"
    ]
    """<p>The definition of an analysis.</p> <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>"""
    validation_strategy: NotRequired[
        "capo_quicksight.types.validation_strategy.ValidationStrategy"
    ]
    """<p>The option to relax the validation needed to update an analysis with definition objects. This skips the validation step for specific errors.</p>"""

analysis_id instance-attribute

The ID for the analysis that you're updating. This ID displays in the URL of the analysis.

aws_account_id instance-attribute

aws_account_id: AwsAccountId

The ID of the Amazon Web Services account that contains the analysis that you're updating.

definition instance-attribute

definition: NotRequired[AnalysisDefinition]

The definition of an analysis.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

name instance-attribute

A descriptive name for the analysis that you're updating. This name displays for the analysis in the Amazon Quick Sight console.

parameters instance-attribute

parameters: NotRequired[Parameters]

The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.

source_entity instance-attribute

source_entity: NotRequired[AnalysisSourceEntity]

A source entity to use for the analysis that you're updating. This metadata structure contains details that describe a source template and one or more datasets or topics.

theme_arn instance-attribute

theme_arn: NotRequired[Arn]

The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating. To see the theme in the Amazon Quick Sight console, make sure that you have access to it.

validation_strategy instance-attribute

validation_strategy: NotRequired[ValidationStrategy]

The option to relax the validation needed to update an analysis with definition objects. This skips the validation step for specific errors.