Skip to content

DescribeTemplateDefinitionResponse

Source code in docs_src/capo_quicksight/types/describe_template_definition_response.py
class DescribeTemplateDefinitionResponse(TypedDict, closed=True):
    name: NotRequired["capo_quicksight.types.template_name.TemplateName"]
    """<p>The descriptive name of the template.</p>"""
    template_id: NotRequired[
        "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId"
    ]
    """<p>The ID of the template described.</p>"""
    errors: NotRequired["capo_quicksight.types.template_error_list.TemplateErrorList"]
    """<p>Errors associated with the template version.</p>"""
    resource_status: NotRequired["capo_quicksight.types.resource_status.ResourceStatus"]
    """<p>Status associated with the template.</p> <ul> <li> <p> <code>CREATION_IN_PROGRESS</code> </p> </li> <li> <p> <code>CREATION_SUCCESSFUL</code> </p> </li> <li> <p> <code>CREATION_FAILED</code> </p> </li> <li> <p> <code>UPDATE_IN_PROGRESS</code> </p> </li> <li> <p> <code>UPDATE_SUCCESSFUL</code> </p> </li> <li> <p> <code>UPDATE_FAILED</code> </p> </li> <li> <p> <code>DELETED</code> </p> </li> </ul>"""
    theme_arn: NotRequired["capo_quicksight.types.arn.Arn"]
    """<p>The ARN of the theme of the template.</p>"""
    definition: NotRequired[
        "capo_quicksight.types.template_version_definition.TemplateVersionDefinition"
    ]
    """<p>The definition of the template.</p> <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>"""
    status: "capo_quicksight.types.status_code.StatusCode"
    """<p>The HTTP status of the request.</p>"""
    request_id: NotRequired["capo_quicksight.types.string.String"]
    """<p>The Amazon Web Services request ID for this operation.</p>"""

definition instance-attribute

definition: NotRequired[TemplateVersionDefinition]

The definition of the template.

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

errors instance-attribute

errors: NotRequired[TemplateErrorList]

Errors associated with the template version.

name instance-attribute

name: NotRequired[TemplateName]

The descriptive name of the template.

request_id instance-attribute

request_id: NotRequired[String]

The Amazon Web Services request ID for this operation.

resource_status instance-attribute

resource_status: NotRequired[ResourceStatus]

Status associated with the template.

  • CREATION_IN_PROGRESS

  • CREATION_SUCCESSFUL

  • CREATION_FAILED

  • UPDATE_IN_PROGRESS

  • UPDATE_SUCCESSFUL

  • UPDATE_FAILED

  • DELETED

status instance-attribute

status: StatusCode

The HTTP status of the request.

template_id instance-attribute

template_id: NotRequired[ShortRestrictiveResourceId]

The ID of the template described.

theme_arn instance-attribute

theme_arn: NotRequired[Arn]

The ARN of the theme of the template.