Skip to content
AWS for Query.Farm

aws.quicksight.describe_dashboard

Example SQL Queries

SELECT * FROM
aws.quicksight.describe_dashboard
WHERE
"aws_account_id" = 'VALUE'
AND "dashboard_id" = 'VALUE';

Description

Provides a summary for a dashboard.

Table Definition

Column NameColumn Data Type
aws_account_id Required Input Column

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

VARCHAR
dashboard_id Required Input Column

The ID for the dashboard.

VARCHAR
alias_name Input Column

The alias name.

VARCHAR
version_number Input Column

The version number for the dashboard. If a version number isn't passed, the latest published dashboard version 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
dashboard

Information about the dashboard.

STRUCT(
    "dashboard_id" VARCHAR,
    "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,
        "arn" VARCHAR,
        "source_entity_arn" VARCHAR,
        "data_set_arns" VARCHAR[],
        "description" VARCHAR,
        "theme_arn" VARCHAR,
        "sheets" STRUCT(
            "sheet_id" VARCHAR,
            "name" VARCHAR
        )[]
    ),
    "created_time" TIMESTAMP_S,
    "last_published_time" TIMESTAMP_S,
    "last_updated_time" TIMESTAMP_S,
    "link_entities" VARCHAR[]
)
Show child fields
dashboard.arn

The Amazon Resource Name (ARN) of the resource.

dashboard.created_time

The time that this dashboard was created.

dashboard.dashboard_id

Dashboard ID.

dashboard.last_published_time

The last time that this dashboard was published.

dashboard.last_updated_time

The last time that this dashboard was updated.

dashboard.link_entities[]
dashboard.name

A display name for the dashboard.

dashboard.version

Version.

Show child fields
dashboard.version.arn

The Amazon Resource Name (ARN) of the resource.

dashboard.version.created_time

The time that this dashboard version was created.

dashboard.version.data_set_arns[]
dashboard.version.description

Description.

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

Message.

dashboard.version.errors[].type

Type.

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

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

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

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

dashboard.version.sheets[].sheet_id

The unique identifier associated with a sheet.

dashboard.version.source_entity_arn

Source entity ARN.

dashboard.version.status

The HTTP status of the request.

dashboard.version.theme_arn

The ARN of the theme associated with a version of the dashboard.

dashboard.version.version_number

Version number for this version of the dashboard.

request_id

The Amazon Web Services request ID for this operation.

VARCHAR
status

The HTTP status of this request.

BIGINT