DescribeJobDefinitionsRequest Class

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

public class DescribeJobDefinitionsRequest : AmazonBatchRequest
         IAmazonWebServiceRequest

The DescribeJobDefinitionsRequest type exposes the following members

Constructors

	Name	Description
	DescribeJobDefinitionsRequest()

Properties

Name	Type	Description
JobDefinitionName	System.String	Gets and sets the property JobDefinitionName. The name of the job definition to describe.
JobDefinitions	System.Collections.Generic.List<System.String>	Gets and sets the property JobDefinitions. A list of up to 100 job definitions. Each entry in the list can either be an ARN in the format `arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}` or a short version using the form `${JobDefinitionName}:${Revision}`. This parameter can't be used with other parameters.
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 and 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 isn't used, then `DescribeJobDefinitions` returns up to 100 results and a `nextToken` value if applicable.
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. 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.
Status	System.String	Gets and sets the property Status. The status used to filter job definitions.

Examples

This example describes all of your active job definitions.

To describe active job definitions


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

List<JobDefinition> jobDefinitions = response.JobDefinitions;

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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