PATCH

/jobs/{jobId}

http://iot.{region}.amazonaws.com/jobs/{jobId}

Updates supported fields of the specified job. Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateJob</a> action.

Access Token Required: API Key

Path Parameters

jobIdstringrequired

The ID of the job to be updated.

Query Params

namespaceIdstring

The namespace used to indicate that a job is a customer-managed job. 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. <code>$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/</code> <note> The <code>namespaceId</code> feature is in public preview. </note>

Body Params

abortConfigobject

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

descriptionstring

A short text description of the job.

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>.

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 PATCH \
2     --url 'http://iot.{region}.amazonaws.com/jobs/{jobId}' \
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}