UpdateJobStatus
Updates the status for the specified job. Use this operation to confirm that you want to run a job or to cancel an existing job. For more information, see S3 Batch Operations in the Amazon S3 User Guide.
- Permissions
-
To use the
UpdateJobStatusoperation, you must have permission to perform thes3:UpdateJobStatusaction.
Related actions include:
Request Syntax
POST /v20180820/jobs/id/status?requestedJobStatus=RequestedJobStatus&statusUpdateReason=StatusUpdateReason HTTP/1.1
Host: s3-control.amazonaws.com
x-amz-account-id: AccountId
URI Request Parameters
The request uses the following URI parameters.
- id
-
The ID of the job whose status you want to update.
Length Constraints: Minimum length of 5. Maximum length of 36.
Pattern:
[a-zA-Z0-9\-\_]+Required: Yes
- requestedJobStatus
-
The status that you want to move the specified job to.
Valid Values:
Cancelled | ReadyRequired: Yes
- statusUpdateReason
-
A description of the reason why you want to change the specified job's status. This field can be any string up to the maximum length.
Length Constraints: Minimum length of 1. Maximum length of 256.
- x-amz-account-id
-
The AWS account ID associated with the S3 Batch Operations job.
Length Constraints: Maximum length of 64.
Pattern:
^\d{12}$Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<UpdateJobStatusResult>
<JobId>string</JobId>
<Status>string</Status>
<StatusUpdateReason>string</StatusUpdateReason>
</UpdateJobStatusResult>Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in XML format by the service.
- UpdateJobStatusResult
-
Root level tag for the UpdateJobStatusResult parameters.
Required: Yes
- JobId
-
The ID for the job whose status was updated.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 36.
Pattern:
[a-zA-Z0-9\-\_]+ - Status
-
The current status for the specified job.
Type: String
Valid Values:
Active | Cancelled | Cancelling | Complete | Completing | Failed | Failing | New | Paused | Pausing | Preparing | Ready | Suspended - StatusUpdateReason
-
The reason that the specified job's status was updated.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Errors
- BadRequestException
-
HTTP Status Code: 400
- InternalServiceException
-
HTTP Status Code: 500
- JobStatusException
-
HTTP Status Code: 400
- NotFoundException
-
HTTP Status Code: 400
- TooManyRequestsException
-
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
