CancelJob
Cancels a job.
Requires permission to access the CancelJob action.
Request Syntax
PUT /jobs/jobId/cancel?force=force HTTP/1.1
Content-type: application/json
{
"comment": "string",
"reasonCode": "string"
}URI Request Parameters
The request uses the following URI parameters.
- force
-
(Optional) If
truejob executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default isfalse.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.
- jobId
-
The unique identifier you assigned to this job when it was created.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9_-]+Required: Yes
Request Body
The request accepts the following data in JSON format.
- comment
-
An optional comment string describing why the job was canceled.
Type: String
Length Constraints: Maximum length of 2028.
Pattern:
[^\p{C}]+Required: No
- reasonCode
-
(Optional)A reason code string that explains why the job was canceled.
Type: String
Length Constraints: Maximum length of 128.
Pattern:
[\p{Upper}\p{Digit}_]+Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"description": "string",
"jobArn": "string",
"jobId": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- description
-
A short text description of the job.
Type: String
Length Constraints: Maximum length of 2028.
Pattern:
[^\p{C}]+ - jobArn
-
The job ARN.
Type: String
- jobId
-
The unique identifier you assigned to this job when it was created.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9_-]+
Errors
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
- LimitExceededException
-
A limit has been exceeded.
HTTP Status Code: 410
- ResourceNotFoundException
-
The specified resource does not exist.
HTTP Status Code: 404
- ServiceUnavailableException
-
The service is temporarily unavailable.
HTTP Status Code: 503
- ThrottlingException
-
The rate exceeds the limit.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
