/jobs/{jobId}/cancel - AWS IoT Wireless

Cancels a job.

Requires permission to access the CancelJob action.

curl --location -g --request PUT 'https://api.iotwireless.{region}.amazonaws.com/jobs//cancel' \ --header 'Content-Type: application/json' \ --data-raw '{ "reasonCode": "string", "comment": "string" }'

Request

Path Params

jobId

string

required

The unique identifier you assigned to this job when it was created.

Query Params

force

string

optional

(Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false.

Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.

Body Params application/json

reasonCode

string

optional

(Optional)A reason code string that explains why the job was canceled.

<= 128 characters

Match pattern:

[\p{Upper}\p{Digit}_]+

comment

string

optional

An optional comment string describing why the job was canceled.

<= 2028 characters

Match pattern:

[^\p{C}]+

Examples

Responses

🟢200Success

application/json

Body

jobArn

string

optional

The job ARN.

jobId

string

optional

The unique identifier you assigned to this job when it was created.

>= 1 characters<= 64 characters

Match pattern:

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

description

string

optional

A short text description of the job.

<= 2028 characters

Match pattern:

[^\p{C}]+

🟠480InvalidRequestException

🟠481ResourceNotFoundException

🟠482ThrottlingException

🟠483ServiceUnavailableException