Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateJobTemplate

Creates a job template.

Requires permission to access the CreateJobTemplate action.

Request Syntax


PUT /job-templates/jobTemplateId HTTP/1.1
Content-type: application/json

{
   "abortConfig": { 
      "criteriaList": [ 
         { 
            "action": "string",
            "failureType": "string",
            "minNumberOfExecutedThings": number,
            "thresholdPercentage": number
         }
      ]
   },
   "description": "string",
   "destinationPackageVersions": [ "string" ],
   "document": "string",
   "documentSource": "string",
   "jobArn": "string",
   "jobExecutionsRetryConfig": { 
      "criteriaList": [ 
         { 
            "failureType": "string",
            "numberOfRetries": number
         }
      ]
   },
   "jobExecutionsRolloutConfig": { 
      "exponentialRate": { 
         "baseRatePerMinute": number,
         "incrementFactor": number,
         "rateIncreaseCriteria": { 
            "numberOfNotifiedThings": number,
            "numberOfSucceededThings": number
         }
      },
      "maximumPerMinute": number
   },
   "maintenanceWindows": [ 
      { 
         "durationInMinutes": number,
         "startTime": "string"
      }
   ],
   "presignedUrlConfig": { 
      "expiresInSec": number,
      "roleArn": "string"
   },
   "tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "timeoutConfig": { 
      "inProgressTimeoutInMinutes": number
   }
}

URI Request Parameters

The request uses the following URI parameters.

jobTemplateId

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

Length Constraints: Minimum length of 1. Maximum length of 64.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

abortConfig

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

Type: AbortConfig object

Required: No

description

A description of the job document.

Type: String

Length Constraints: Maximum length of 2028.

Pattern: [^\p{C}]+

Required: Yes

destinationPackageVersions

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.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:[!-~]+$

Required: No

document

The job document. Required if you don't specify a value for documentSource.

Type: String

Length Constraints: Maximum length of 32768.

Required: No

documentSource

An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document.

For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0

For more information, see Methods for accessing a bucket.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1350.

Required: No

jobArn

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

Type: String

Required: No

jobExecutionsRetryConfig

Allows you to create the criteria to retry a job.

Type: JobExecutionsRetryConfig object

Required: No

jobExecutionsRolloutConfig

Allows you to create a staged rollout of a job.

Type: JobExecutionsRolloutConfig object

Required: No

maintenanceWindows

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.

Type: Array of MaintenanceWindow objects

Required: No

presignedUrlConfig

Configuration for pre-signed S3 URLs.

Type: PresignedUrlConfig object

Required: No

tags

Metadata that can be used to manage the job template.

Type: Array of Tag objects

Required: No

timeoutConfig

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.

Type: TimeoutConfig object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "jobTemplateArn": "string",
   "jobTemplateId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

jobTemplateArn

The ARN of the job template.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:[!-~]+$

jobTemplateId

The unique identifier of the job template.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

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

Errors

ConflictException

A resource with the same name already exists.

HTTP Status Code: 409

InternalFailureException

An unexpected error has occurred.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

LimitExceededException

A limit has been exceeded.

HTTP Status Code: 410

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 400