---
title: "PUT /jobs/{jobId}"
method: PUT
path: "/jobs/{jobId}"
---

# PUT /jobs/{jobId}

`PUT /jobs/{jobId}`

Creates a job.

Requires permission to access the [CreateJob](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

## Path parameters

- `jobId` string, required

## Request body

- object
  - `targets` TargetArn[], required — A list of things and thing groups to which the job should be sent.
  - `documentSource` string — <p>An S3 link to the job document. 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>
  - `document` string — The job document. Required if you don't specify a value for <code>documentSource</code>.
  - `description` string — A short text description of the job.
  - `presignedUrlConfig` object — Configuration for pre-signed S3 URLs.
    - `roleArn` string — <p>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.</p> <important> <p>For information about addressing the confused deputy problem, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/cross-service-confused-deputy-prevention.html">cross-service confused deputy prevention</a> in the <i>Amazon Web Services IoT Core developer guide</i>.</p> </important>
    - `expiresInSec` integer — 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.
  - `targetSelection` 'CONTINUOUS' | 'SNAPSHOT' — <p>Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.</p> <note> <p>We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.</p> </note>
  - `jobExecutionsRolloutConfig` object — Allows you to create a staged rollout of a job.
    - `maximumPerMinute` integer — The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.
    - `exponentialRate` object — The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout.
      - `baseRatePerMinute` integer, required — 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.
      - `incrementFactor` number, double, required — <p>The exponential factor to increase the rate of rollout for a job.</p> <p>Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).</p>
      - `rateIncreaseCriteria` object, required — The criteria to initiate the increase in rate of rollout for a job.
        - `numberOfNotifiedThings` integer — The threshold for number of notified things that will initiate the increase in rate of rollout.
        - `numberOfSucceededThings` integer — The threshold for number of succeeded things that will initiate the increase in rate of rollout.
  - `abortConfig` object — The criteria that determine when and how a job abort takes place.
    - `criteriaList` AbortCriteria[] — The list of criteria that determine when and how to abort the job.
      - `failureType` 'FAILED' | 'REJECTED' | 'TIMED_OUT' | 'ALL', required — The type of job execution failures that can initiate a job abort.
      - `action` 'CANCEL', required — The type of job action to take to initiate the job abort.
      - `thresholdPercentage` number, double, required — <p>The minimum percentage of job execution failures that must occur to initiate the job abort.</p> <p>Amazon Web Services IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).</p>
      - `minNumberOfExecutedThings` integer, required — The minimum number of things which must receive job execution notifications before the job can be aborted.
  - `timeoutConfig` object — 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>.
    - `inProgressTimeoutInMinutes` integer — 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 <code>TIMED_OUT</code> status.
  - `tags` Tag[] — Metadata which can be used to manage the job.
    - `Key` string, required — The tag's key.
    - `Value` string — The tag's value.
  - `namespaceId` string — <p>The namespace used to indicate that a job is a customer-managed job.</p> <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.</p> <p> <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code> </p> <note> <p>The <code>namespaceId</code> feature is in public preview.</p> </note>
  - `jobTemplateArn` string — The ARN of the job template used to create the job.
  - `jobExecutionsRetryConfig` object — The configuration that determines how many retries are allowed for each failure type for a job.
    - `criteriaList` RetryCriteria[] — The list of criteria that determines how many retries are allowed for each failure type for a job.
      - `failureType` 'FAILED' | 'TIMED_OUT' | 'ALL', required — The type of job execution failures that can initiate a job retry.
      - `numberOfRetries` integer, required — The number of retries allowed for a failure type for the job.
  - `documentParameters` object — <p>Parameters of an Amazon Web Services managed template that you can specify to create the job document.</p> <note> <p> <code>documentParameters</code> can only be used when creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them.</p> </note>
  - `schedulingConfig` object — Specifies the date and time that a job will begin the rollout of the job document to all devices in the target group. Additionally, you can specify the end behavior for each job execution when it reaches the scheduled end time.
    - `startTime` string — The time a job will begin rollout of the job document to all devices in the target group for a job. The <code>startTime</code> can be scheduled up to a year in advance and must be scheduled a minimum of thirty minutes from the current time. The date and time format for the <code>startTime</code> is YYYY-MM-DD for the date and HH:MM for the time.
    - `endTime` string — The time a job will stop rollout of the job document to all devices in the target group for a job. The <code>endTime</code> must take place no later than two years from the current time and be scheduled a minimum of thirty minutes from the current time. The minimum duration between <code>startTime</code> and <code>endTime</code> is thirty minutes. The maximum duration between <code>startTime</code> and <code>endTime</code> is two years. The date and time format for the <code>endTime</code> is YYYY-MM-DD for the date and HH:MM for the time.
    - `endBehavior` 'STOP_ROLLOUT' | 'CANCEL' | 'FORCE_CANCEL' — Specifies the end behavior for all job executions after a job reaches the selected <code>endTime</code>. If <code>endTime</code> is not selected when creating the job, then <code>endBehavior</code> does not apply.
    - `maintenanceWindows` MaintenanceWindow[] — An optional configuration within the <code>SchedulingConfig</code> to setup a recurring maintenance window with a predetermined start time and duration for the rollout of a job document to all devices in a target group for a job.
      - `startTime` string, required — Displays the start time of the next maintenance window.
      - `durationInMinutes` integer, required — Displays the duration of the next maintenance window.

## Response `200`

Success

- CreateJobResponse
  - `jobArn` string — The job ARN.
  - `jobId` string — The unique identifier you assigned to this job.
  - `description` string — The job description.

## Other responses

- `480` — InvalidRequestException
- `481` — ResourceNotFoundException
- `482` — ResourceAlreadyExistsException
- `483` — LimitExceededException
- `484` — ThrottlingException
- `485` — ServiceUnavailableException

---

[API](https://skmtc.net/aws/apis/iot.md) · [All operations](https://skmtc.net/aws/apis/iot/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/iot/versions/deef5c4b09f0/schema)