Skip to content
AWS for Query.Farm

aws.quicksight.describe_dashboard_snapshot_job_result

Example SQL Queries

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

Description

Describes the result of an existing snapshot job that has finished running.

A finished snapshot job will return a COMPLETED or FAILED status when you poll the job with a DescribeDashboardSnapshotJob API call.

If the job has not finished running, this operation returns a message that says Dashboard Snapshot Job with id <SnapshotjobId> has not reached a terminal state..

Table Definition

Column NameColumn Data Type
aws_account_id Required Input Column

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

VARCHAR
dashboard_id Required Input Column

The ID of the dashboard that you have started a snapshot job for.

VARCHAR
snapshot_job_id Required Input Column

The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

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
arn

The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.

VARCHAR
created_time

The time that a snapshot job was created.

TIMESTAMP_S
error_info

Displays information for the error that caused a job to fail.

STRUCT(
    "error_message" VARCHAR,
    "error_type" VARCHAR
)
Show child fields
error_info.error_message

The error message.

error_info.error_type

The error type.

job_status

Indicates the status of a job after it has reached a terminal state. A finished snapshot job will retuen a COMPLETED or FAILED status.

VARCHAR
last_updated_time

The time that a snapshot job status was last updated.

TIMESTAMP_S
request_id

The Amazon Web Services request ID for this operation.

VARCHAR
result

The result of the snapshot job. Jobs that have successfully completed will return the S3Uri where they are located. Jobs that have failedwill return information on the error that caused the job to fail.

STRUCT(
    "anonymous_users" STRUCT(
        "file_groups" STRUCT(
            "files" STRUCT(
                "sheet_selections" STRUCT(
                    "sheet_id" VARCHAR,
                    "selection_scope" VARCHAR,
                    "visual_ids" VARCHAR[]
                )[],
                "format_type" VARCHAR
            )[],
            "s3_results" STRUCT(
                "s3_destination_configuration" STRUCT(
                    "bucket_configuration" STRUCT(
                        "bucket_name" VARCHAR,
                        "bucket_prefix" VARCHAR,
                        "bucket_region" VARCHAR
                    )
                ),
                "s3_uri" VARCHAR,
                "error_info" STRUCT(
                    "error_message" VARCHAR,
                    "error_type" VARCHAR
                )[]
            )[]
        )[]
    )[]
)
Show child fields
result.anonymous_users[]
Show child fields
result.anonymous_users[].file_groups[]
Show child fields
result.anonymous_users[].file_groups[].files[]
Show child fields
result.anonymous_users[].file_groups[].files[].format_type

The format of the snapshot file to be generated. You can choose between CSV, Excel, or PDF.

result.anonymous_users[].file_groups[].files[].sheet_selections[]
Show child fields
result.anonymous_users[].file_groups[].files[].sheet_selections[].selection_scope

The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options.

  • ALL_VISUALS - Selects all visuals that are on the sheet. This value is required if the snapshot is a PDF.

  • SELECTED_VISUALS - Select the visual that you want to add to the snapshot. This value is required if the snapshot is a CSV or Excel workbook.

result.anonymous_users[].file_groups[].files[].sheet_selections[].sheet_id

The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV, Excel, and PDF format types.

result.anonymous_users[].file_groups[].files[].sheet_selections[].visual_ids[]
result.anonymous_users[].file_groups[].s3_results[]
Show child fields
result.anonymous_users[].file_groups[].s3_results[].error_info[]
Show child fields
result.anonymous_users[].file_groups[].s3_results[].error_info[].error_message

The error message.

result.anonymous_users[].file_groups[].s3_results[].error_info[].error_type

The error type.

result.anonymous_users[].file_groups[].s3_results[].s3_destination_configuration

A list of Amazon S3 bucket configurations that are provided when you make a StartDashboardSnapshotJob API call.

Show child fields
result.anonymous_users[].file_groups[].s3_results[].s3_destination_configuration.bucket_configuration

A structure that contains details about the Amazon S3 bucket that the generated dashboard snapshot is saved in.

Show child fields
result.anonymous_users[].file_groups[].s3_results[].s3_destination_configuration.bucket_configuration.bucket_name

The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.

result.anonymous_users[].file_groups[].s3_results[].s3_destination_configuration.bucket_configuration.bucket_prefix

The prefix of the Amazon S3 bucket that the generated snapshots are stored in.

result.anonymous_users[].file_groups[].s3_results[].s3_destination_configuration.bucket_configuration.bucket_region

The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the StartDashboardSnapshotJob API call is made.

result.anonymous_users[].file_groups[].s3_results[].s3_uri

The Amazon S3 Uri.

status

The HTTP status of the request

BIGINT