Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-142381,278956.3 KB

Creates a job template.

Requires permission to access the CreateJobTemplate action.

put/job-templates/{jobTemplateId}

Path parameters

jobTemplateIdstring required

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

Request body

jobArnstring

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

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

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

descriptionstring required

A description of the job document.

Response

Success

jobTemplateArnstring

The ARN of the job template.

jobTemplateIdstring

The unique identifier of the job template.