managed_job_templates

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

Overview

Name	managed_job_templates
Type	Resource
Id	aws.iot.managed_job_templates

Fields

The following fields are returned by SELECT queries:

describe_managed_job_template

Name	Datatype	Description
description	string	The unique description of a managed template. (pattern: <code>[^\p{C}]+</code>)
document	string	The document schema for a managed job template.
document_parameters	array	A map of key-value pairs that you can use as guidance to specify the inputs for creating a job from a managed template. documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them.
environments	array	A list of environments that are supported with the managed job template.
template_arn	string	The unique Amazon Resource Name (ARN) of the managed template. (pattern: <code>^arn:[!-~]+$</code>)
template_name	string	The unique name of a managed template, such as AWS-Reboot.
template_version	string	The version for a managed template. (pattern: <code>^[1-9]+.[0-9]+</code>)

list_managed_job_templates

Name	Datatype	Description
description	string	The description for a managed template. (pattern: <code>[^\p{C}]+</code>)
environments	array	A list of environments that are supported with the managed job template.
template_arn	string	The Amazon Resource Name (ARN) for a managed template. (pattern: <code>^arn:[!-~]+$</code>)
template_name	string	The unique Name for a managed template.
template_version	string	The version for a managed template. (pattern: <code>^[1-9]+.[0-9]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_managed_job_template	select	template_name, region	templateVersion	View details of a managed job template.
list_managed_job_templates	select	region	templateName, maxResults, nextToken	Returns a list of managed job templates.

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
region	string	AWS region (default: us-east-1)
template_name	string	The unique name of a managed job template, which is required.
maxResults	integer	Maximum number of entries that can be returned.
nextToken	string	The token to retrieve the next set of results.
templateName	string	An optional parameter for template name. If specified, only the versions of the managed job templates that have the specified template name will be returned.
templateVersion	string	An optional parameter to specify version of a managed template. If not specified, the pre-defined default version is returned.

SELECT examples

describe_managed_job_template

View details of a managed job template.

SELECT
description,
document,
document_parameters,
environments,
template_arn,
template_name,
template_version
FROM aws.iot.managed_job_templates
WHERE template_name = '{{ template_name }}' -- required
AND region = '{{ region }}' -- required
AND templateVersion = '{{ templateVersion }}'
;

list_managed_job_templates

Returns a list of managed job templates.

SELECT
description,
environments,
template_arn,
template_name,
template_version
FROM aws.iot.managed_job_templates
WHERE region = '{{ region }}' -- required
AND templateName = '{{ templateName }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;