PUT

/job-templates/{jobTemplateId}

http://iot.{region}.amazonaws.com/job-templates/{jobTemplateId}

Creates a job template. Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CreateJobTemplate</a> action.

Access Token Required: API Key

Path Parameters

jobTemplateIdstringrequired

A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.

Body Params

tagsarray

Metadata that can be used to manage the job template.

jobArnstring

The ARN of the job to use as the basis for the job template.

documentstring

The job document. Required if you don't specify a value for <code>documentSource</code>.

abortConfigobject

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

descriptionstringrequired

A description of the job document.

timeoutConfigobject

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 <code>IN_PROGRESS</code>. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to <code>TIMED_OUT</code>.

documentSourcestring

An S3 link to the job document to use in the template. Required if you don't specify a value for <code>document</code>. <note> If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document. The placeholder link is of the following form: <code>${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}</code> where bucket is your bucket name and key is the object in the bucket to which you are linking. </note>

maintenanceWindowsarray

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.

presignedUrlConfigobject

Configuration for pre-signed S3 URLs.

jobExecutionsRetryConfigobject

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

jobExecutionsRolloutConfigobject

Allows you to create a staged rollout of a job.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'http://iot.{region}.amazonaws.com/job-templates/{jobTemplateId}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}