job_documents
Creates, updates, deletes, gets or lists a job_documents resource.
Overview
| Name | job_documents |
| Type | Resource |
| Id | aws.iot.job_documents |
Fields
The following fields are returned by SELECT queries:
- get_job_document
| Name | Datatype | Description |
|---|---|---|
document | string | The job document content. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_job_document | select | job_id, region | beforeSubstitution | Gets a job document. Requires permission to access the GetJobDocument action. |
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 |
|---|---|---|
job_id | string | The unique identifier you assigned to this job when it was created. |
region | string | AWS region (default: us-east-1) |
beforeSubstitution | boolean | Provides a view of the job document before and after the substitution parameters have been resolved with their exact values. |
SELECT examples
- get_job_document
Gets a job document. Requires permission to access the GetJobDocument action.
SELECT
document
FROM aws.iot.job_documents
WHERE job_id = '{{ job_id }}' -- required
AND region = '{{ region }}' -- required
AND beforeSubstitution = '{{ beforeSubstitution }}'
;