AWS Documentation » AWS Import Export » Developer Guide » API Reference » Actions » ListJobs	« Previous Next »
	Did this page help you? Yes \| No \| Tell us about it...

ListJobs

Description

This action returns the jobs associated with the requester. AWS Import/Export lists the jobs in reverse chronological order based on the date of creation. For example, if job Test1 was created on 30 December 2009 and Test2 was created 05 February 2010, the ListJobs action would return Test2 followed by Test1.

Request Parameters

For information about the common parameters that all actions use, see Common Query Parameters.

Name Description Required

Name	Description	Required
Action	Specifies the action to invoke. Type: String Default: None Valid Value: ListJobs	Yes
Marker	Specifies the `JOBID` to start after when listing the jobs created with your account. See `MaxJobs`. Type: String Default: None Constraints: Must be a valid job ID	No
MaxJobs	Sets the maximum number of jobs returned in the response. If there are additional jobs that were not returned because `MaxJobs` was exceeded, the response contains <IsTruncated>true</IsTruncated>. To return the additional jobs, see `Marker`. Type: String Default: None Constraints: Must be between 0 and 1000	No

Action

Specifies the action to invoke.

Type: String

Default: None

Valid Value: ListJobs

Yes

Marker

Specifies the JOBID to start after when listing the jobs created with your account. See MaxJobs.

Type: String

Default: None

Constraints: Must be a valid job ID

MaxJobs

Sets the maximum number of jobs returned in the response. If there are additional jobs that were not returned because MaxJobs was exceeded, the response contains <IsTruncated>true</IsTruncated>. To return the additional jobs, see Marker.

Type: String

Default: None

Constraints: Must be between 0 and 1000

Response Elements

Name	Description
CreationDate	Timestamp of the `CreateJob` request in ISO8601 date format. For example, 2010-03-28T20:27:35Z. For more information, go to ISO 8601. Type: String Ancestor: ListJobsResponse.ListJobsResult.Jobs.member
IsCanceled	Indicates whether the job was canceled. Type: String Valid Values: `true` \| `false` Ancestor: ListJobsResponse.ListJobsResult.Jobs.member
IsTruncated	Indicates whether the list of jobs was truncated. If `true`, call `ListJobs` again using the last `JobId` element as the marker. Type: String Valid Values: `true` \| `false` Ancestor: ListJobsResponse.ListJobsResult.Jobs.member
JobId	ID generated by AWS that uniquely identifies the AWS Import/Export job. Type: String Ancestor: ListJobsResponse.ListJobsResult.Jobs.member
Jobs	Container for all jobs. Type: None Ancestor: ListJobsResponse.ListJobsResult Children: member, IsTruncated
JobType	Specifies whether the job is an import or export job. Type: String Ancestor: ListJobsResponse.ListJobsResult.Jobs.member
ListJobsResponse	Container for the response. Type: None Ancestor: None Children: ListJobsResult, Response Metadata
ListJobsResult	Container for jobs. Type: None Ancestor: ListJobsResponse Children: Jobs
member	Container for job information. Type: None Ancestor: ListJobsResponse.ListJobsResult.Jobs Children: creationDate, JobId, IsCanceled
RequestId	ID generated by AWS that uniquely identifies the `ListJobs` request. Type: String Ancestor: ListJobsResponse.ListJobsResult.ResponseMetadata
ResponseMetadata	Container for `RequestId`. Type: None Ancestor: ListJobsResponse.ListJobsResult Children: RequestId

Errors

For a list of common errors, see Error and Status Codes.

Examples

Sample Request

POST / HTTP/1.1
content-type:application/x-www-form-urlencoded;charset=utf-8
host: https://importexport.amazonaws.com
content-length:206

Action=ListJobs&MaxJobs=25&SignatureMethod=HmacSHA256&AWSAccessKeyId= 
&SignatureVersion=2&Version=2010-06-01&Signature=%2FVfkltRBOoSUi1sWxRzN8rw%3D 
&Timestamp=2011-06-18T02%3A29%3A39.202Z

Sample Response

<ListJobsResponse xmlns="http://importexport.amazonaws.com/">
  <ListJobsResult>
    <Jobs>
      <member>
        <JobType>Import</JobType>
        <CreationDate>2010-04-21T22:21:51Z</CreationDate>
        <IsCanceled>false</IsCanceled>
        <JobId>ADP7B</JobId>
      </member>
      <member>
        <JobType>Import</JobType>
        <CreationDate>2010-04-21T22:19:05Z</CreationDate>
        <IsCanceled>false</IsCanceled>
        <JobId>AVEYF</JobId>
      </member>
    </Jobs>
    <IsTruncated>true</IsTruncated>
  </ListJobsResult>
  <ResponseMetadata>
    <RequestId>cc6ea8c0-4da9-11df-81c3-e94d3ca214a8</RequestId>
  </ResponseMetadata>
</ListJobsResponse>

Related actions

The following actions are related to ListJobs.

GetStatus

Document Conventions	« Previous Next »
Terms of Use	Did this page help you? Yes \| No \| Tell us about it...