automation_jobs
Creates, updates, deletes, gets or lists an automation_jobs resource.
Overview
| Name | automation_jobs |
| Type | Resource |
| Id | aws.quicksight.automation_jobs |
Fields
The following fields are returned by SELECT queries:
- describe_automation_job
| Name | Datatype | Description |
|---|---|---|
arn | string | The Amazon Resource Name (ARN) of the automation job. |
created_at | string (date-time) | The time that the automation job was created. |
ended_at | string (date-time) | The time that the automation job finished running. |
input_payload | string | The input payload that was provided when the automation job was started. This field is only included when IncludeInputPayload is set to true in the request. (pattern: <code>[\s\S][{[].[}]]\s*</code>) |
job_status | string | The current status of the automation job. (FAILED, RUNNING, SUCCEEDED, QUEUED, STOPPED) |
output_payload | string | The output payload that was generated by the automation job. This field is only included when IncludeOutputPayload is set to true in the request. (pattern: <code>[\s\S][{[].[}]]\s*</code>) |
request_id | string | The Amazon Web Services request ID for this operation. |
started_at | string (date-time) | The time that the automation job started running. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_automation_job | select | aws_account_id, automation_group_id, automation_id, job_id, region | includeInputPayload, includeOutputPayload | Retrieves the status and details of a specified automation job, including its status and outputs. |
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 |
|---|---|---|
automation_group_id | string | The ID of the automation group that contains the automation. |
automation_id | string | The ID of the automation that the job belongs to. |
aws_account_id | string | The ID of the Amazon Web Services account that contains the automation job. |
job_id | string | The ID of the automation job to describe. |
region | string | AWS region (default: us-east-1) |
includeInputPayload | boolean | A Boolean value that indicates whether to include the input payload in the response. If set to true, the input payload will be included. If set to false, the input payload will be returned as null. |
includeOutputPayload | boolean | A Boolean value that indicates whether to include the output payload in the response. If set to true, the output payload will be included. If set to false, the output payload will be returned as null. |
SELECT examples
- describe_automation_job
Retrieves the status and details of a specified automation job, including its status and outputs.
SELECT
arn,
created_at,
ended_at,
input_payload,
job_status,
output_payload,
request_id,
started_at
FROM aws.quicksight.automation_jobs
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND automation_group_id = '{{ automation_group_id }}' -- required
AND automation_id = '{{ automation_id }}' -- required
AND job_id = '{{ job_id }}' -- required
AND region = '{{ region }}' -- required
AND includeInputPayload = '{{ includeInputPayload }}'
AND includeOutputPayload = '{{ includeOutputPayload }}'
;