ListJobs
Lists current S3 Batch Operations jobs as well as the jobs that have ended within the last 90 days for the AWS account making the request. For more information, see S3 Batch Operations in the Amazon S3 User Guide.
- Permissions
-
To use the
ListJobsoperation, you must have permission to perform thes3:ListJobsaction.
Related actions include:
Request Syntax
GET /v20180820/jobs?jobStatuses=JobStatuses&maxResults=MaxResults&nextToken=NextToken HTTP/1.1
Host: s3-control.amazonaws.com
x-amz-account-id: AccountId
URI Request Parameters
The request uses the following URI parameters.
- jobStatuses
-
The
List Jobsrequest returns jobs that match the statuses listed in this element.Valid Values:
Active | Cancelled | Cancelling | Complete | Completing | Failed | Failing | New | Paused | Pausing | Preparing | Ready | Suspended - maxResults
-
The maximum number of jobs that Amazon S3 will include in the
List Jobsresponse. If there are more jobs than this number, the response will include a pagination token in theNextTokenfield to enable you to retrieve the next page of results.Valid Range: Minimum value of 0. Maximum value of 1000.
- nextToken
-
A pagination token to request the next page of results. Use the token that Amazon S3 returned in the
NextTokenelement of theListJobsResultfrom the previousList Jobsrequest.Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
^[A-Za-z0-9\+\:\/\=\?\#-_]+$ - 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"?>
<ListJobsResult>
<NextToken>string</NextToken>
<Jobs>
<JobListDescriptor>
<CreationTime>timestamp</CreationTime>
<Description>string</Description>
<JobId>string</JobId>
<Operation>string</Operation>
<Priority>integer</Priority>
<ProgressSummary>
<NumberOfTasksFailed>long</NumberOfTasksFailed>
<NumberOfTasksSucceeded>long</NumberOfTasksSucceeded>
<Timers>
<ElapsedTimeInActiveSeconds>long</ElapsedTimeInActiveSeconds>
</Timers>
<TotalNumberOfTasks>long</TotalNumberOfTasks>
</ProgressSummary>
<Status>string</Status>
<TerminationDate>timestamp</TerminationDate>
</JobListDescriptor>
</Jobs>
</ListJobsResult>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.
- ListJobsResult
-
Root level tag for the ListJobsResult parameters.
Required: Yes
- Jobs
-
The list of current jobs and jobs that have ended within the last 30 days.
Type: Array of JobListDescriptor data types
- NextToken
-
If the
List Jobsrequest produced more than the maximum number of results, you can pass this value into a subsequentList Jobsrequest in order to retrieve the next page of results.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
^[A-Za-z0-9\+\:\/\=\?\#-_]+$
Errors
- InternalServiceException
-
HTTP Status Code: 500
- InvalidNextTokenException
-
HTTP Status Code: 400
- InvalidRequestException
-
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
