| CARVIEW |
UpdateJobPriority
Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations in the Amazon S3 User Guide.
- Permissions
-
To use the
UpdateJobPriorityoperation, you must have permission to perform thes3:UpdateJobPriorityaction.
Related actions include:
Request Syntax
POST /v20180820/jobs/id/priority?priority=Priority 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 for the job whose priority you want to update.
Length Constraints: Minimum length of 5. Maximum length of 36.
Pattern:
[a-zA-Z0-9\-\_]+Required: Yes
- priority
-
The priority you want to assign to this job.
Valid Range: Minimum value of 0. Maximum value of 2147483647.
Required: Yes
- 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"?>
<UpdateJobPriorityResult>
<JobId>string</JobId>
<Priority>integer</Priority>
</UpdateJobPriorityResult>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.
- UpdateJobPriorityResult
-
Root level tag for the UpdateJobPriorityResult parameters.
Required: Yes
- JobId
-
The ID for the job whose priority Amazon S3 updated.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 36.
Pattern:
[a-zA-Z0-9\-\_]+ - Priority
-
The new priority assigned to the specified job.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 2147483647.
Errors
- BadRequestException
-
HTTP Status Code: 400
- InternalServiceException
-
HTTP Status Code: 500
- 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:
Thanks for letting us know we're doing a good job!
If you've got a moment, please tell us what we did right so we can do more of it.
Thanks for letting us know this page needs work. We're sorry we let you down.
If you've got a moment, please tell us how we can make the documentation better.