You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Batch::Types::UpdateJobQueueRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb

Overview

Note:

When making an API call, you may pass UpdateJobQueueRequest data as a hash:

{
  job_queue: "String", # required
  state: "ENABLED", # accepts ENABLED, DISABLED
  priority: 1,
  compute_environment_order: [
    {
      order: 1, # required
      compute_environment: "String", # required
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#compute_environment_orderArray<Types::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 execute a given job.

Returns:



2041
2042
2043
2044
2045
2046
2047
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 2041

class UpdateJobQueueRequest < Struct.new(
  :job_queue,
  :state,
  :priority,
  :compute_environment_order)
  include Aws::Structure
end

#job_queueString

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

Returns:

  • (String)


2041
2042
2043
2044
2045
2046
2047
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 2041

class UpdateJobQueueRequest < Struct.new(
  :job_queue,
  :state,
  :priority,
  :compute_environment_order)
  include Aws::Structure
end

#priorityInteger

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.

Returns:

  • (Integer)


2041
2042
2043
2044
2045
2046
2047
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 2041

class UpdateJobQueueRequest < Struct.new(
  :job_queue,
  :state,
  :priority,
  :compute_environment_order)
  include Aws::Structure
end

#stateString

Describes the queue's ability to accept new jobs.

Returns:

  • (String)


2041
2042
2043
2044
2045
2046
2047
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 2041

class UpdateJobQueueRequest < Struct.new(
  :job_queue,
  :state,
  :priority,
  :compute_environment_order)
  include Aws::Structure
end