/jobs/{jobId}

The AWS IoT Wireless multi-region endpoint

https://api.iotwireless.{region}.amazonaws.com

PATCH

/jobs/{jobId}

Updates supported fields of the specified job.

Requires permission to access the UpdateJob action.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request PATCH 'https://api.iotwireless.{region}.amazonaws.com/jobs/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description": "string",
    "presignedUrlConfig": {
        "roleArn": "string",
        "expiresInSec": 0
    },
    "jobExecutionsRolloutConfig": {
        "maximumPerMinute": 0,
        "exponentialRate": {
            "baseRatePerMinute": 0,
            "incrementFactor": 0,
            "rateIncreaseCriteria": {
                "numberOfNotifiedThings": 0,
                "numberOfSucceededThings": 0
            }
        }
    },
    "abortConfig": {
        "criteriaList": []
    },
    "timeoutConfig": {
        "inProgressTimeoutInMinutes": 0
    }
}'

Response Example

200 - Example 1

{}

Request

Path Params

jobId

string

required

The ID of the job to be updated.

Query Params

namespaceId

string

optional

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.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

Body Params application/json

description

string

optional

A short text description of the job.

<= 2028 characters

Match pattern:

[^\p{C}]+

presignedUrlConfig

object

optional

Configuration for pre-signed S3 URLs.

roleArn

string

optional

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.

>= 20 characters<= 2048 characters

expiresInSec

integer

optional

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.

>= 60<= 3600

jobExecutionsRolloutConfig

object

optional

Allows you to create a staged rollout of a job.

maximumPerMinute

integer

optional

The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.

>= 1

exponentialRate

object

optional

The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout.

abortConfig

object

optional

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

criteriaList

array[object (AbortCriteria) {4}]

optional

The list of criteria that determine when and how to abort the job.

>= 1 items

timeoutConfig

object

optional

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.

inProgressTimeoutInMinutes

integer

optional

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

Examples

Responses

🟢200Success

application/json

Body

object {0}

🟠480InvalidRequestException

🟠481ResourceNotFoundException

🟠482ThrottlingException

🟠483ServiceUnavailableException

Modified at 2022-09-10 23:12:13

/wireless-devices/{Id}/test

/tags