paws.compute (version 0.1.12)

batch_update_job_queue: Updates a job queue

Description

Updates a job queue.

Usage

batch_update_job_queue(jobQueue, state, priority,
  computeEnvironmentOrder)

Value

A list with the following syntax:

list(
  jobQueueName = "string",
  jobQueueArn = "string"
)

Arguments

jobQueue

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

state

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

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 cannot be mixed.

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 should run 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. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.

Request syntax

svc$update_job_queue(
  jobQueue = "string",
  state = "ENABLED"|"DISABLED",
  priority = 123,
  computeEnvironmentOrder = list(
    list(
      order = 123,
      computeEnvironment = "string"
    )
  )
)

Examples

if (FALSE) {
# This example disables a job queue so that it can be deleted.
svc$update_job_queue(
  jobQueue = "GPGPU",
  state = "DISABLED"
)
}