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 DescribeJobDefinitions operation. Describes a list of job definitions. You can specify a status (such as ACTIVE) to only return job definitions that match that status.

Inheritance Hierarchy

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

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

Syntax

C#
public class DescribeJobDefinitionsRequest : AmazonBatchRequest
         IAmazonWebServiceRequest

The DescribeJobDefinitionsRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property JobDefinitionName System.String

Gets and sets the property JobDefinitionName.

The name of the job definition to describe.

Public Property JobDefinitions System.Collections.Generic.List<System.String>

Gets and sets the property JobDefinitions.

A space-separated list of up to 100 job definition names or full Amazon Resource Name (ARN) entries.

Public Property MaxResults System.Int32

Gets and sets the property MaxResults.

The maximum number of results returned by DescribeJobDefinitions in paginated output. When this parameter is used, DescribeJobDefinitions 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 DescribeJobDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then DescribeJobDefinitions 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 DescribeJobDefinitions 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.

Public Property Status System.String

Gets and sets the property Status.

The status with which to filter job definitions.

Examples

This example describes all of your active job definitions.

To describe active job definitions


var response = client.DescribeJobDefinitions(new DescribeJobDefinitionsRequest 
{
    Status = "ACTIVE"
});

List jobDefinitions = response.JobDefinitions;

            

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