Skip to main content

job_documents

Creates, updates, deletes, gets or lists a job_documents resource.

Overview

Namejob_documents
TypeResource
Idaws.iot.job_documents

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
documentstringThe job document content.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_job_documentselectjob_id, regionbeforeSubstitutionGets 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.

NameDatatypeDescription
job_idstringThe unique identifier you assigned to this job when it was created.
regionstringAWS region (default: us-east-1)
beforeSubstitutionbooleanProvides a view of the job document before and after the substitution parameters have been resolved with their exact values.

SELECT examples

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 }}'
;