Skip to content

aws.iot.describe_job_template

Example SQL Queries

SELECT * FROM
aws.iot.describe_job_template
WHERE
"job_template_id" = 'VALUE';

Description

Returns information about a job template.

Table Definition

Column NameColumn Data Type
job_template_id Required Input Column

The unique identifier of the job template.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
abort_config

The criteria that determine when and how a job abort takes place.

STRUCT(
"criteria_list" STRUCT(
"failure_type" VARCHAR,
"action" VARCHAR,
"threshold_percentage" DOUBLE,
"min_number_of_executed_things" BIGINT
)[]
)
Show child fields
abort_config.criteria_list[]
Show child fields
abort_config.criteria_list[].action

The type of job action to take to initiate the job abort.

abort_config.criteria_list[].failure_type

The type of job execution failures that can initiate a job abort.

abort_config.criteria_list[].min_number_of_executed_things

The minimum number of things which must receive job execution notifications before the job can be aborted.

abort_config.criteria_list[].threshold_percentage

The minimum percentage of job execution failures that must occur to initiate the job abort.

Amazon Web Services IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).

created_at

The time, in seconds since the epoch, when the job template was created.

TIMESTAMP_S
description

A description of the job template.

VARCHAR
destination_package_versions

The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.

Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

VARCHAR[]
Show child fields
destination_package_versions[]
document

The job document.

VARCHAR
document_source

An S3 link to the job document.

VARCHAR
job_executions_retry_config

The configuration that determines how many retries are allowed for each failure type for a job.

STRUCT(
"criteria_list" STRUCT(
"failure_type" VARCHAR,
"number_of_retries" BIGINT
)[]
)
Show child fields
job_executions_retry_config.criteria_list[]
Show child fields
job_executions_retry_config.criteria_list[].failure_type

The type of job execution failures that can initiate a job retry.

job_executions_retry_config.criteria_list[].number_of_retries

The number of retries allowed for a failure type for the job.

job_executions_rollout_config

Allows you to create a staged rollout of a job.

STRUCT(
"maximum_per_minute" BIGINT,
"exponential_rate" STRUCT(
"base_rate_per_minute" BIGINT,
"increment_factor" DOUBLE,
"rate_increase_criteria" STRUCT(
"number_of_notified_things" BIGINT,
"number_of_succeeded_things" BIGINT
)
)
)
Show child fields
job_executions_rollout_config.exponential_rate

The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout.

Show child fields
job_executions_rollout_config.exponential_rate.base_rate_per_minute

The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout.

job_executions_rollout_config.exponential_rate.increment_factor

The exponential factor to increase the rate of rollout for a job.

Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).

job_executions_rollout_config.exponential_rate.rate_increase_criteria

The criteria to initiate the increase in rate of rollout for a job.

Show child fields
job_executions_rollout_config.exponential_rate.rate_increase_criteria.number_of_notified_things

The threshold for number of notified things that will initiate the increase in rate of rollout.

job_executions_rollout_config.exponential_rate.rate_increase_criteria.number_of_succeeded_things

The threshold for number of succeeded things that will initiate the increase in rate of rollout.

job_executions_rollout_config.maximum_per_minute

The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.

job_template_arn

The ARN of the job template.

VARCHAR
maintenance_windows

Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.

STRUCT(
"start_time" VARCHAR,
"duration_in_minutes" BIGINT
)[]
Show child fields
maintenance_windows[]
Show child fields
maintenance_windows[].duration_in_minutes

Displays the duration of the next maintenance window.

maintenance_windows[].start_time

Displays the start time of the next maintenance window.

presigned_url_config

Configuration for pre-signed S3 URLs.

STRUCT(
"role_arn" VARCHAR,
"expires_in_sec" BIGINT
)
Show child fields
presigned_url_config.expires_in_sec

How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 3600 seconds. Pre-signed URLs are generated when Jobs receives an MQTT request for the job document.

presigned_url_config.role_arn

The ARN of an IAM role that grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files.

For information about addressing the confused deputy problem, see cross-service confused deputy prevention in the Amazon Web Services IoT Core developer guide.

timeout_config

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

STRUCT(
"in_progress_timeout_in_minutes" BIGINT
)
Show child fields
timeout_config.in_progress_timeout_in_minutes

Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal TIMED_OUT status.