IAmazonBatch.DescribeJobDefinitions Method (DescribeJobDefinitionsRequest)

Describes a list of job definitions. You can specify a status (such as ACTIVE) to only return job definitions that match that status.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to DescribeJobDefinitionsAsync.

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

Syntax

public abstract DescribeJobDefinitionsResponse DescribeJobDefinitions(
         DescribeJobDefinitionsRequest request
)

Parameters

request: Type: Amazon.Batch.Model.DescribeJobDefinitionsRequest

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

Return Value

Type: DescribeJobDefinitionsResponse

The response from the DescribeJobDefinitions service method, as returned by Batch.

Exceptions

Exception	Condition
ClientException	These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.
ServerException	These errors are usually caused by a server issue.

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 Framework:
Supported in: 4.5, 4.0, 3.5

IAmazonBatch.DescribeJobDefinitions (DescribeJobDefinitionsRequest)

Method