| Column Name | Column 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 the snapshot job was created. | TIMESTAMP_S |
job_status
Indicates the status of a job. The status updates as the job executes. This shows one of the following values. -
COMPLETED - The job was completed successfully. -
FAILED - The job failed to execute. -
QUEUED - The job is queued and hasn't started yet. -
RUNNING - The job is still running. | VARCHAR |
last_updated_time
The time that the snapshot job status was last updated. | TIMESTAMP_S |
request_id
The Amazon Web Services request ID for this operation. | VARCHAR |
snapshot_configuration
The snapshot configuration of the job. This information is provided when you make a StartDashboardSnapshotJob API call. | STRUCT(
"file_groups" STRUCT(
"files" STRUCT(
"sheet_selections" STRUCT(
"sheet_id" VARCHAR,
"selection_scope" VARCHAR,
"visual_ids" VARCHAR[]
)[],
"format_type" VARCHAR
)[]
)[],
"destination_configuration" STRUCT(
"s3_destinations" STRUCT(
"bucket_configuration" STRUCT(
"bucket_name" VARCHAR,
"bucket_prefix" VARCHAR,
"bucket_region" VARCHAR
)
)[]
),
"parameters" STRUCT(
"string_parameters" STRUCT(
"name" VARCHAR,
"values" VARCHAR[]
)[],
"integer_parameters" STRUCT(
"name" VARCHAR,
"values" BIGINT[]
)[],
"decimal_parameters" STRUCT(
"name" VARCHAR,
"values" DOUBLE[]
)[],
"date_time_parameters" STRUCT(
"name" VARCHAR,
"values" TIMESTAMP_S[]
)[]
)
) |
Show child fields- snapshot_configuration.destination_configuration
A structure that contains information on the Amazon S3 bucket that the generated snapshot is stored in. Show child fields- snapshot_configuration.destination_configuration.s3_destinations[]
Show child fields- snapshot_configuration.destination_configuration.s3_destinations[].bucket_configuration
A structure that contains details about the Amazon S3 bucket that the generated dashboard snapshot is saved in. Show child fields- snapshot_configuration.destination_configuration.s3_destinations[].bucket_configuration.bucket_name
The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent. - snapshot_configuration.destination_configuration.s3_destinations[].bucket_configuration.bucket_prefix
The prefix of the Amazon S3 bucket that the generated snapshots are stored in. - snapshot_configuration.destination_configuration.s3_destinations[].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.
- snapshot_configuration.file_groups[]
Show child fields- snapshot_configuration.file_groups[].files[]
Show child fields- snapshot_configuration.file_groups[].files[].format_type
The format of the snapshot file to be generated. You can choose between CSV, Excel, or PDF. - snapshot_configuration.file_groups[].files[].sheet_selections[]
Show child fields- snapshot_configuration.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. - snapshot_configuration.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. - snapshot_configuration.file_groups[].files[].sheet_selections[].visual_ids[]
- snapshot_configuration.parameters
A list of Amazon QuickSight parameters and the list's override values. Show child fields- snapshot_configuration.parameters.date_time_parameters[]
Show child fields- snapshot_configuration.parameters.date_time_parameters[].name
A display name for the date-time parameter. - snapshot_configuration.parameters.date_time_parameters[].values[]
- snapshot_configuration.parameters.decimal_parameters[]
Show child fields- snapshot_configuration.parameters.decimal_parameters[].name
A display name for the decimal parameter. - snapshot_configuration.parameters.decimal_parameters[].values[]
- snapshot_configuration.parameters.integer_parameters[]
Show child fields- snapshot_configuration.parameters.integer_parameters[].name
The name of the integer parameter. - snapshot_configuration.parameters.integer_parameters[].values[]
- snapshot_configuration.parameters.string_parameters[]
Show child fields- snapshot_configuration.parameters.string_parameters[].name
A display name for a string parameter. - snapshot_configuration.parameters.string_parameters[].values[]
|
status
The HTTP status of the request | BIGINT |
user_configuration
The user configuration for the snapshot job. This information is provided when you make a StartDashboardSnapshotJob API call. | STRUCT(
"anonymous_users" STRUCT(
"row_level_permission_tag_keys" VARCHAR[]
)[]
) |
Show child fields- user_configuration.anonymous_users[]
Show child fields- user_configuration.anonymous_users[].row_level_permission_tag_keys[]
|