Skip to content
AWS for Query.Farm

aws.quicksight.describe_template

Example SQL Queries

SELECT * FROM
aws.quicksight.describe_template
WHERE
"aws_account_id" = 'VALUE'
AND "template_id" = 'VALUE';

Description

Describes a template's metadata.

Table Definition

Column NameColumn Data Type
aws_account_id Required Input Column

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

VARCHAR
template_id Required Input Column

The ID for the template.

VARCHAR
alias_name Input Column

The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.

VARCHAR
version_number Input Column

(Optional) The number for the version to describe. If a VersionNumber parameter value isn't provided, the latest version of the template is described.

BIGINT
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
request_id

The Amazon Web Services request ID for this operation.

VARCHAR
status

The HTTP status of the request.

BIGINT
template

The template structure for the object you want to describe.

STRUCT(
    "arn" VARCHAR,
    "name" VARCHAR,
    "version" STRUCT(
        "created_time" TIMESTAMP_S,
        "errors" STRUCT(
            "type" VARCHAR,
            "message" VARCHAR,
            "violated_entities" STRUCT(
                "path" VARCHAR
            )[]
        )[],
        "version_number" BIGINT,
        "status" VARCHAR,
        "data_set_configurations" STRUCT(
            "placeholder" VARCHAR,
            "data_set_schema" STRUCT(
                "column_schema_list" STRUCT(
                    "name" VARCHAR,
                    "data_type" VARCHAR,
                    "geographic_role" VARCHAR
                )[]
            ),
            "column_group_schema_list" STRUCT(
                "name" VARCHAR,
                "column_group_column_schema_list" STRUCT(
                    "name" VARCHAR
                )[]
            )[]
        )[],
        "description" VARCHAR,
        "source_entity_arn" VARCHAR,
        "theme_arn" VARCHAR,
        "sheets" STRUCT(
            "sheet_id" VARCHAR,
            "name" VARCHAR
        )[]
    ),
    "template_id" VARCHAR,
    "last_updated_time" TIMESTAMP_S,
    "created_time" TIMESTAMP_S
)
Show child fields
template.arn

The Amazon Resource Name (ARN) of the template.

template.created_time

Time when this was created.

template.last_updated_time

Time when this was last updated.

template.name

The display name of the template.

template.template_id

The ID for the template. This is unique per Amazon Web Services Region for each Amazon Web Services account.

template.version

A structure describing the versions of the template.

Show child fields
template.version.created_time

The time that this template version was created.

template.version.data_set_configurations[]
Show child fields
template.version.data_set_configurations[].column_group_schema_list[]
Show child fields
template.version.data_set_configurations[].column_group_schema_list[].column_group_column_schema_list[]
Show child fields
template.version.data_set_configurations[].column_group_schema_list[].column_group_column_schema_list[].name

The name of the column group's column schema.

template.version.data_set_configurations[].column_group_schema_list[].name

The name of the column group schema.

template.version.data_set_configurations[].data_set_schema

Dataset schema.

Show child fields
template.version.data_set_configurations[].data_set_schema.column_schema_list[]
Show child fields
template.version.data_set_configurations[].data_set_schema.column_schema_list[].data_type

The data type of the column schema.

template.version.data_set_configurations[].data_set_schema.column_schema_list[].geographic_role

The geographic role of the column schema.

template.version.data_set_configurations[].data_set_schema.column_schema_list[].name

The name of the column schema.

template.version.data_set_configurations[].placeholder

Placeholder.

template.version.description

The description of the template.

template.version.errors[]
Show child fields
template.version.errors[].message

Description of the error type.

template.version.errors[].type

Type of error.

template.version.errors[].violated_entities[]
Show child fields
template.version.errors[].violated_entities[].path

The hierarchical path of the entity within the analysis, template, or dashboard definition tree.

template.version.sheets[]
Show child fields
template.version.sheets[].name

The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.

template.version.sheets[].sheet_id

The unique identifier associated with a sheet.

template.version.source_entity_arn

The Amazon Resource Name (ARN) of an analysis or template that was used to create this template.

template.version.status

The status that is associated with the template.

  • CREATION_IN_PROGRESS

  • CREATION_SUCCESSFUL

  • CREATION_FAILED

  • UPDATE_IN_PROGRESS

  • UPDATE_SUCCESSFUL

  • UPDATE_FAILED

  • DELETED

template.version.theme_arn

The ARN of the theme associated with this version of the template.

template.version.version_number

The version number of the template version.