ListJobsRequest Class | AWS SDK for .NET V3

Container for the parameters to the ListJobs operation. Returns a list of Batch jobs.

You must specify only one of the following items:

A job queue ID to return a list of jobs in that job queue
A multi-node parallel job ID to return a list of nodes for that job
An array job ID to return a list of the children for that job

You can filter the results by job status with the jobStatus parameter. If you don't 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

public class ListJobsRequest : AmazonBatchRequest
         IAmazonWebServiceRequest

The ListJobsRequest type exposes the following members

Constructors

	Name	Description
	ListJobsRequest()

Properties

Name	Type	Description
ArrayJobId	System.String	Gets and sets the property ArrayJobId. The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.
Filters	System.Collections.Generic.List<Amazon.Batch.Model.KeyValuesPair>	Gets and sets the property Filters. The filter to apply to the query. Only one filter can be used at a time. When the filter is used, `jobStatus` is ignored. The filter doesn't apply to child jobs in an array or multi-node parallel (MNP) jobs. The results are sorted by the `createdAt` field, with the most recent jobs being first. JOB_NAME The value of the filter is a case-insensitive match for the job name. If the value ends with an asterisk (), the filter matches any job name that begins with the string before the ''. This corresponds to the `jobName` value. For example, `test1` matches both `Test1` and `test1`, and `test1` matches both `test1` and `Test10`. When the `JOB_NAME` filter is used, the results are grouped by the job name and version. JOB_DEFINITION The value for the filter is the name or Amazon Resource Name (ARN) of the job definition. This corresponds to the `jobDefinition` value. The value is case sensitive. When the value for the filter is the job definition name, the results include all the jobs that used any revision of that job definition name. If the value ends with an asterisk (), the filter matches any job definition name that begins with the string before the ''. For example, `jd1` matches only `jd1`, and `jd1` matches both `jd1` and `jd1A`. The version of the job definition that's used doesn't affect the sort order. When the `JOB_DEFINITION` filter is used and the ARN is used (which is in the form `arn:${Partition}:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}`), the results include jobs that used the specified revision of the job definition. Asterisk (*) isn't supported when the ARN is used. BEFORE_CREATED_AT The value for the filter is the time that's before the job was created. This corresponds to the `createdAt` value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970. AFTER_CREATED_AT The value for the filter is the time that's after the job was created. This corresponds to the `createdAt` value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.
JobQueue	System.String	Gets and sets the property JobQueue. The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.
JobStatus	Amazon.Batch.JobStatus	Gets and sets the property JobStatus. The job status used to filter jobs in the specified queue. If the `filters` parameter is specified, the `jobStatus` parameter is ignored and jobs with any status are returned. If you don't specify a status, only `RUNNING` jobs are returned.
MaxResults	System.Int32	Gets and sets the property MaxResults. The maximum number of results returned by `ListJobs` in a paginated output. When this parameter is used, `ListJobs` returns up to `maxResults` results in a single page and a `nextToken` response element, if applicable. The remaining results of the initial request can be seen by sending another `ListJobs` request with the returned `nextToken` value. The following outlines key parameters and limitations: The minimum value is 1. When `--job-status` is used, Batch returns up to 1000 values. When `--filters` is used, Batch returns up to 100 values. If neither parameter is used, then `ListJobs` returns up to 1000 results (jobs that are in the `RUNNING` status) and a `nextToken` value, if applicable.
MultiNodeJobId	System.String	Gets and sets the property MultiNodeJobId. The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.
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. Treat this token as an opaque identifier that's 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 client = new AmazonBatchClient();
var response = client.ListJobs(new ListJobsRequest 
{
    JobQueue = "HighPriority"
});

List<JobSummary> jobSummaryList = response.JobSummaryList;

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

To list submitted jobs


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

List<JobSummary> jobSummaryList = response.JobSummaryList;

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5