Skip to content
AWS for Query.Farm

aws.quicksight.describe_analysis

Example SQL Queries

SELECT * FROM
aws.quicksight.describe_analysis
WHERE
"aws_account_id" = 'VALUE'
AND "analysis_id" = 'VALUE';

Description

Provides a summary of the metadata for an analysis.

Table Definition

Column NameColumn Data Type
analysis_id Required Input Column

The ID of the analysis that you're describing. The ID is part of the URL of the analysis.

VARCHAR
aws_account_id Required Input Column

The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.

VARCHAR
_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
analysis

A metadata structure that contains summary information for the analysis that you're describing.

STRUCT(
    "analysis_id" VARCHAR,
    "arn" VARCHAR,
    "name" VARCHAR,
    "status" VARCHAR,
    "errors" STRUCT(
        "type" VARCHAR,
        "message" VARCHAR,
        "violated_entities" STRUCT(
            "path" VARCHAR
        )[]
    )[],
    "data_set_arns" VARCHAR[],
    "theme_arn" VARCHAR,
    "created_time" TIMESTAMP_S,
    "last_updated_time" TIMESTAMP_S,
    "sheets" STRUCT(
        "sheet_id" VARCHAR,
        "name" VARCHAR
    )[]
)
Show child fields
analysis.analysis_id

The ID of the analysis.

analysis.arn

The Amazon Resource Name (ARN) of the analysis.

analysis.created_time

The time that the analysis was created.

analysis.data_set_arns[]
analysis.errors[]
Show child fields
analysis.errors[].message

The message associated with the analysis error.

analysis.errors[].type

The type of the analysis error.

analysis.errors[].violated_entities[]
Show child fields
analysis.errors[].violated_entities[].path

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

analysis.last_updated_time

The time that the analysis was last updated.

analysis.name

The descriptive name of the analysis.

analysis.sheets[]
Show child fields
analysis.sheets[].name

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

analysis.sheets[].sheet_id

The unique identifier associated with a sheet.

analysis.status

Status associated with the analysis.

analysis.theme_arn

The ARN of the theme of the analysis.

request_id

The Amazon Web Services request ID for this operation.

VARCHAR
status

The HTTP status of the request.

BIGINT