Skip to content

UpdateTemplateRequest

Source code in docs_src/capo_quicksight/types/update_template_request.py
class UpdateTemplateRequest(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 template that you're updating.</p>"""
    template_id: (
        "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId"
    )
    """<p>The ID for the template.</p>"""
    source_entity: NotRequired[
        "capo_quicksight.types.template_source_entity.TemplateSourceEntity"
    ]
    """<p>The entity that you are using as a source when you update the template. In <code>SourceEntity</code>, you specify the type of object you're using as source: <code>SourceTemplate</code> for a template or <code>SourceAnalysis</code> for an analysis. Both of these require an Amazon Resource Name (ARN). For <code>SourceTemplate</code>, specify the ARN of the source template. For <code>SourceAnalysis</code>, specify the ARN of the source analysis. The <code>SourceTemplate</code> ARN can contain any Amazon Web Services account and any Quick Sight-supported Amazon Web Services Region;. </p> <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> or <code>SourceAnalysis</code> to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. Use the <code>TopicReferences</code> entity to list the replacement topics for the topic placeholders listed in the original. The schema in each topic must match its placeholder.</p>"""
    version_description: NotRequired[
        "capo_quicksight.types.version_description.VersionDescription"
    ]
    """<p>A description of the current template version that is being updated. Every time you call <code>UpdateTemplate</code>, you create a new version of the template. Each version of the template maintains a description of the version in the <code>VersionDescription</code> field.</p>"""
    name: NotRequired["capo_quicksight.types.template_name.TemplateName"]
    """<p>The name for the template.</p>"""
    definition: NotRequired[
        "capo_quicksight.types.template_version_definition.TemplateVersionDefinition"
    ]
    """<p>The definition of a template.</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 a template with definition objects. This skips the validation step for specific errors.</p>"""

aws_account_id instance-attribute

aws_account_id: AwsAccountId

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

definition instance-attribute

definition: NotRequired[TemplateVersionDefinition]

The definition of a template.

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

name instance-attribute

name: NotRequired[TemplateName]

The name for the template.

source_entity instance-attribute

source_entity: NotRequired[TemplateSourceEntity]

The entity that you are using as a source when you update the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any Amazon Web Services account and any Quick Sight-supported Amazon Web Services Region;.

Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. Use the TopicReferences entity to list the replacement topics for the topic placeholders listed in the original. The schema in each topic must match its placeholder.

template_id instance-attribute

The ID for the template.

validation_strategy instance-attribute

validation_strategy: NotRequired[ValidationStrategy]

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

version_description instance-attribute

version_description: NotRequired[VersionDescription]

A description of the current template version that is being updated. Every time you call UpdateTemplate, you create a new version of the template. Each version of the template maintains a description of the version in the VersionDescription field.