dashboard_snapshot_jobs
Creates, updates, deletes, gets or lists a dashboard_snapshot_jobs resource.
Overview
| Name | dashboard_snapshot_jobs |
| Type | Resource |
| Id | aws.quicksight.dashboard_snapshot_jobs |
Fields
The following fields are returned by SELECT queries:
- describe_dashboard_snapshot_job
| 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. |
aws_account_id | string | The ID of the Amazon Web Services account that the dashboard snapshot job is executed in. (pattern: <code>^[0-9]{12}$</code>) |
created_time | string (date-time) | The time that the snapshot job was created. |
dashboard_id | string | The ID of the dashboard that you have started a snapshot job for. (pattern: <code>[\w-]+</code>) |
job_status | string | 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. (QUEUED, RUNNING, COMPLETED, FAILED) |
last_updated_time | string (date-time) | The time that the snapshot job status was last updated. |
request_id | string | The Amazon Web Services request ID for this operation. (pattern: <code>.\S.</code>) |
snapshot_configuration | object | The snapshot configuration of the job. This information is provided when you make a StartDashboardSnapshotJob API call. |
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. (pattern: <code>[\w-]+</code>) |
status | integer | The HTTP status of the request |
user_configuration | object | The user configuration for the snapshot job. This information is provided when you make a StartDashboardSnapshotJob API call. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_dashboard_snapshot_job | select | aws_account_id, dashboard_id, snapshot_job_id, region | Describes an existing snapshot job. Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see JobStatus. Registered user support This API can be called as before to get status of a job started by the same Quick Sight user. Possible error scenarios Request will fail with an Access Denied error in the following scenarios: The credentials have expired. Job has been started by a different user. Impersonated Quick Sight user doesn't have access to the specified dashboard in the job. | |
start_dashboard_snapshot_job_schedule | exec | aws_account_id, dashboard_id, schedule_id, region | Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email. Only one job can run simultaneously in a given schedule. Repeated requests are skipped with a 202 HTTP status code. For more information, see Scheduling and sending Amazon Quick Sight reports by email and Configuring email report settings for a Amazon Quick Sight dashboard in the Amazon Quick Sight User Guide. |
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 want to start a snapshot job schedule for. |
region | string | AWS region (default: us-east-1) |
schedule_id | string | The ID of the schedule that you want to start a snapshot job schedule for. The schedule ID can be found in the Amazon Quick Sight console in the Schedules pane of the dashboard that the schedule is configured for. |
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
Describes an existing snapshot job. Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see JobStatus. Registered user support This API can be called as before to get status of a job started by the same Quick Sight user. Possible error scenarios Request will fail with an Access Denied error in the following scenarios: The credentials have expired. Job has been started by a different user. Impersonated Quick Sight user doesn't have access to the specified dashboard in the job.
SELECT
arn,
aws_account_id,
created_time,
dashboard_id,
job_status,
last_updated_time,
request_id,
snapshot_configuration,
snapshot_job_id,
status,
user_configuration
FROM aws.quicksight.dashboard_snapshot_jobs
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
;
Lifecycle Methods
- start_dashboard_snapshot_job_schedule
Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email. Only one job can run simultaneously in a given schedule. Repeated requests are skipped with a 202 HTTP status code. For more information, see Scheduling and sending Amazon Quick Sight reports by email and Configuring email report settings for a Amazon Quick Sight dashboard in the Amazon Quick Sight User Guide.
EXEC aws.quicksight.dashboard_snapshot_jobs.start_dashboard_snapshot_job_schedule
@aws_account_id='{{ aws_account_id }}' --required,
@dashboard_id='{{ dashboard_id }}' --required,
@schedule_id='{{ schedule_id }}' --required,
@region='{{ region }}' --required
;