/job-templates/{jobTemplateId}

Returns information about a job template.

{ "jobTemplateArn": "string", "jobTemplateId": "string", "description": "string", "documentSource": "string", "document": "string", "createdAt": "string", "presignedUrlConfig": { "roleArn": "string", "expiresInSec": 0 }, "jobExecutionsRolloutConfig": { "maximumPerMinute": 0, "exponentialRate": { "baseRatePerMinute": 0, "incrementFactor": 0, "rateIncreaseCriteria": { "numberOfNotifiedThings": 0, "numberOfSucceededThings": 0 } } }, "abortConfig": { "criteriaList": [] }, "timeoutConfig": { "inProgressTimeoutInMinutes": 0 } }

Responses

🟢200Success

application/json

Body

jobTemplateArn

string

optional

The ARN of the job template.

>= 1 characters<= 1600 characters

Match pattern:

^arn:[!-~]+$

jobTemplateId

string

optional

The unique identifier of the job template.

>= 1 characters<= 64 characters

Match pattern:

[a-zA-Z0-9_-]+

description

string

optional

A description of the job template.

<= 2028 characters

Match pattern:

[^\p{C}]+

documentSource

string

optional

An S3 link to the job document.

>= 1 characters<= 1350 characters

document

string

optional

The job document.

<= 32768 characters

createdAt

string <date-time>

optional

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

presignedUrlConfig

object (PresignedUrlConfig)

optional

Configuration for pre-signed S3 URLs.

roleArn

string

optional

The ARN of an IAM role that grants 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.

>= 20 characters<= 2048 characters

expiresInSec

integer

optional

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.

>= 60<= 3600

jobExecutionsRolloutConfig

object (JobExecutionsRolloutConfig)

optional

Allows you to create a staged rollout of a job.

maximumPerMinute

integer

optional

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

>= 1

exponentialRate

object

optional

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

abortConfig

object (AbortConfig)

optional

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

criteriaList

array[object (AbortCriteria) {4}]

required

The list of criteria that determine when and how to abort the job.

>= 1 items

timeoutConfig

object (TimeoutConfig)

optional

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.

inProgressTimeoutInMinutes

integer

optional

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.

🟠480InvalidRequestException

🟠481ResourceNotFoundException

🟠482ThrottlingException

🟠483InternalFailureException