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.

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.

Note:

For PCL this operation is only available in asynchronous form. Please refer to ListJobsAsync.

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

Syntax

C#
public abstract ListJobsResponse ListJobs(
         ListJobsRequest request
)
Parameters
request
Type: Amazon.Batch.Model.ListJobsRequest

Container for the necessary parameters to execute the ListJobs service method.

Return Value
The response from the ListJobs service method, as returned by Batch.

Exceptions

ExceptionCondition
ClientException These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.
ServerException These errors are usually caused by a server issue.

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 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

See Also