dashboard_snapshot_job_results
Creates, updates, deletes, gets or lists a dashboard_snapshot_job_results resource.
Overview
| Name | dashboard_snapshot_job_results |
| Type | Resource |
| Id | aws.quicksight.dashboard_snapshot_job_results |
Fields
The following fields are returned by SELECT queries:
- describe_dashboard_snapshot_job_result
| Name | Datatype | Description |
|---|---|---|
arn | string | 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. |
created_time | string (date-time) | The time that a snapshot job was created. |
error_info | object | Displays information for the error that caused a job to fail. |
job_status | string | Indicates the status of a job after it has reached a terminal state. A finished snapshot job will retuen a COMPLETED or FAILED status. (QUEUED, RUNNING, COMPLETED, FAILED) |
last_updated_time | string (date-time) | The time that a snapshot job status was last updated. |
request_id | string | The Amazon Web Services request ID for this operation. (pattern: <code>.\S.</code>) |
result | object | 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. |
status | integer | The HTTP status of the request |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_dashboard_snapshot_job_result | select | aws_account_id, dashboard_id, snapshot_job_id, region | 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.. Registered user support This API can be called as before to get the result of a job started by the same Quick Sight user. The result for the user will be returned in RegisteredUsers response attribute. The attribute will contain a list with at most one object in it. Possible error scenarios The request fails with an Access Denied error in the following scenarios: The credentials have expired. The job was started by a different user. The registered user doesn't have access to the specified dashboard. The request succeeds but the job fails in the following scenarios: DASHBOARD_ACCESS_DENIED - The registered user lost access to the dashboard. CAPABILITY_RESTRICTED - The registered user is restricted from exporting data in all selected formats. The request succeeds but the response contains an error code in the following scenarios: CAPABILITY_RESTRICTED - The registered user is restricted from exporting data in some selected formats. RLS_CHANGED - Row-level security settings have changed. Re-run the job with current settings. CLS_CHANGED - Column-level security settings have changed. Re-run the job with current settings. DATASET_DELETED - The dataset has been deleted. Verify the dataset exists before re-running the job. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
aws_account_id | string | The ID of the Amazon Web Services account that the dashboard snapshot job is executed in. |
dashboard_id | string | The ID of the dashboard that you have started a snapshot job for. |
region | string | AWS region (default: us-east-1) |
snapshot_job_id | string | The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call. |
SELECT examples
- describe_dashboard_snapshot_job_result
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.. Registered user support This API can be called as before to get the result of a job started by the same Quick Sight user. The result for the user will be returned in RegisteredUsers response attribute. The attribute will contain a list with at most one object in it. Possible error scenarios The request fails with an Access Denied error in the following scenarios: The credentials have expired. The job was started by a different user. The registered user doesn't have access to the specified dashboard. The request succeeds but the job fails in the following scenarios: DASHBOARD_ACCESS_DENIED - The registered user lost access to the dashboard. CAPABILITY_RESTRICTED - The registered user is restricted from exporting data in all selected formats. The request succeeds but the response contains an error code in the following scenarios: CAPABILITY_RESTRICTED - The registered user is restricted from exporting data in some selected formats. RLS_CHANGED - Row-level security settings have changed. Re-run the job with current settings. CLS_CHANGED - Column-level security settings have changed. Re-run the job with current settings. DATASET_DELETED - The dataset has been deleted. Verify the dataset exists before re-running the job.
SELECT
arn,
created_time,
error_info,
job_status,
last_updated_time,
request_id,
result,
status
FROM aws.quicksight.dashboard_snapshot_job_results
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND dashboard_id = '{{ dashboard_id }}' -- required
AND snapshot_job_id = '{{ snapshot_job_id }}' -- required
AND region = '{{ region }}' -- required
;