POST

/v20180820/jobs/{id}/status#x-amz-account-id&requestedJobStatus

http://s3-control.{region}.amazonaws.com/v20180820/jobs/{id}/status#x-amz-account-id&requestedJobStatus

Updates the status for the specified job. Use this action to confirm that you want to run a job or to cancel an existing job. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html">S3 Batch Operations</a> in the Amazon S3 User Guide. Related actions include: <ul> <li> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html">CreateJob</a> </li> <li> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html">ListJobs</a> </li> <li> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html">DescribeJob</a> </li> <li> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html">UpdateJobStatus</a> </li> </ul>

Access Token Required: API Key

Path Parameters

idstringrequired

The ID of the job whose status you want to update.

Query Params

requestedJobStatusstringrequired

The status that you want to move the specified job to.

Allowed:

statusUpdateReasonstring

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.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://s3-control.{region}.amazonaws.com/v20180820/jobs/{id}/status#x-amz-account-id&requestedJobStatus' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}