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 CreateJobQueue operation. Creates an AWS Batch job queue. When you create a job queue, you associate one or more compute environments to the queue and assign an order of preference for the compute environments.

You also set a priority to the job queue that determines the order in which the AWS Batch scheduler places jobs onto its associated compute environments. For example, if a compute environment is associated with more than one job queue, the job queue with a higher priority is given preference for scheduling jobs to that compute environment.

Inheritance Hierarchy

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

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

Syntax

C#
public class CreateJobQueueRequest : AmazonBatchRequest
         IAmazonWebServiceRequest

The CreateJobQueueRequest type exposes the following members

Constructors

NameDescription
Public Method CreateJobQueueRequest()

Properties

NameTypeDescription
Public Property ComputeEnvironmentOrder System.Collections.Generic.List<Amazon.Batch.Model.ComputeEnvironmentOrder>

Gets and sets the property ComputeEnvironmentOrder.

The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment should execute a given job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to 3 compute environments with a job queue.

Public Property JobQueueName System.String

Gets and sets the property JobQueueName.

The name of the job queue.

Public Property Priority System.Int32

Gets and sets the property Priority.

The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with same compute environment. Priority is determined in descending order, for example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1.

Public Property State Amazon.Batch.JQState

Gets and sets the property State.

The state of the job queue. If the job queue state is ENABLED, it is able to accept jobs.

Examples

This example creates a job queue called LowPriority that uses the M4Spot compute environment.

To create a job queue with a single compute environment


var response = client.CreateJobQueue(new CreateJobQueueRequest 
{
    ComputeEnvironmentOrder = new List {
        new ComputeEnvironmentOrder {
            ComputeEnvironment = "M4Spot",
            Order = 1
        }
    },
    JobQueueName = "LowPriority",
    Priority = 1,
    State = "ENABLED"
});

string jobQueueArn = response.JobQueueArn;
string jobQueueName = response.JobQueueName;

            

This example creates a job queue called HighPriority that uses the C4OnDemand compute environment with an order of 1 and the M4Spot compute environment with an order of 2.

To create a job queue with multiple compute environments


var response = client.CreateJobQueue(new CreateJobQueueRequest 
{
    ComputeEnvironmentOrder = new List {
        new ComputeEnvironmentOrder {
            ComputeEnvironment = "C4OnDemand",
            Order = 1
        },
        new ComputeEnvironmentOrder {
            ComputeEnvironment = "M4Spot",
            Order = 2
        }
    },
    JobQueueName = "HighPriority",
    Priority = 10,
    State = "ENABLED"
});

string jobQueueArn = response.JobQueueArn;
string jobQueueName = response.JobQueueName;

            

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