AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the ListJobs operation. Returns a list of task jobs for a specified job queue. You can filter the results by job status with the jobStatus parameter. If you do not specify a status, only RUNNING jobs are returned.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Batch.AmazonBatchRequest
      Amazon.Batch.Model.ListJobsRequest

Namespace: Amazon.Batch.Model
Assembly: AWSSDK.Batch.dll
Version: 3.x.y.z

Syntax

C#
public class ListJobsRequest : AmazonBatchRequest
         IAmazonWebServiceRequest

The ListJobsRequest type exposes the following members

Constructors

NameDescription
Public Method ListJobsRequest()

Properties

NameTypeDescription
Public Property JobQueue System.String

Gets and sets the property JobQueue.

The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.

Public Property JobStatus Amazon.Batch.JobStatus

Gets and sets the property JobStatus.

The job status with which to filter jobs in the specified queue. If you do not specify a status, only RUNNING jobs are returned.

Public Property MaxResults System.Int32

Gets and sets the property MaxResults.

The maximum number of results returned by ListJobs in paginated output. When this parameter is used, ListJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListJobs returns up to 100 results and a nextToken value if applicable.

Public Property NextToken System.String

Gets and sets the property NextToken.

The nextToken value returned from a previous paginated ListJobs request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Examples

This example lists the running jobs in the HighPriority job queue.

To list running jobs


var response = client.ListJobs(new ListJobsRequest 
{
    JobQueue = "HighPriority"
});

List jobSummaryList = response.JobSummaryList;

            

This example lists jobs in the HighPriority job queue that are in the SUBMITTED job status.

To list submitted jobs


var response = client.ListJobs(new ListJobsRequest 
{
    JobQueue = "HighPriority",
    JobStatus = "SUBMITTED"
});

List jobSummaryList = response.JobSummaryList;

            

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms