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 UpdateJobQueue operation. Updates a job queue.

Inheritance Hierarchy

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

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

Syntax

C#
public class UpdateJobQueueRequest : AmazonBatchRequest
         IAmazonWebServiceRequest

The UpdateJobQueueRequest type exposes the following members

Constructors

NameDescription
Public Method UpdateJobQueueRequest()

Properties

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

Gets and sets the property ComputeEnvironmentOrder.

Details the set of compute environments mapped to a job queue and their order relative to each other. This is one of the parameters used by the job scheduler to determine which compute environment runs a given job. Compute environments must be in the VALID state before you can associate them with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.

All compute environments that are associated with a job queue must share the same architecture. Batch doesn't support mixing compute environment architecture types in a single job queue.

Public Property JobQueue System.String

Gets and sets the property JobQueue.

The name or the Amazon Resource Name (ARN) of the job queue.

Public Property JobStateTimeLimitActions System.Collections.Generic.List<Amazon.Batch.Model.JobStateTimeLimitAction>

Gets and sets the property JobStateTimeLimitActions.

The set of actions that Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. Batch will perform each action after maxTimeSeconds has passed.

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 the 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. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.

Public Property SchedulingPolicyArn System.String

Gets and sets the property SchedulingPolicyArn.

Amazon Resource Name (ARN) of the fair share scheduling policy. Once a job queue is created, the fair share scheduling policy can be replaced but not removed. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name. For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.

Public Property State Amazon.Batch.JQState

Gets and sets the property State.

Describes the queue's ability to accept new jobs. If the job queue state is ENABLED, it can accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can finish.

Examples

This example disables a job queue so that it can be deleted.

To update a job queue


var client = new AmazonBatchClient();
var response = client.UpdateJobQueue(new UpdateJobQueueRequest 
{
    JobQueue = "GPGPU",
    State = "DISABLED"
});

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

            

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