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

Inherits:

Struct

• Object
• Struct
• Aws::Batch::Types::UpdateJobQueueRequest

Includes:

Structure

Defined in:

lib/aws-sdk-batch/types.rb

Overview

Contains the parameters for ‘UpdateJobQueue`.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #compute_environment_order ⇒ Array<Types::ComputeEnvironmentOrder>

  Details the set of compute environments mapped to a job queue and their order relative to each other.

• #job_queue ⇒ String

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

• #job_state_time_limit_actions ⇒ Array<Types::JobStateTimeLimitAction>

  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.

• #priority ⇒ Integer

  The priority of the job queue.

• #scheduling_policy_arn ⇒ String

  Amazon Resource Name (ARN) of the fair share scheduling policy.

• #state ⇒ String

  Describes the queue’s ability to accept new jobs.

Instance Attribute Details

#compute_environment_order ⇒ Array<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 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.

<note markdown=“1”> 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.

</note>

Returns:

• (Array<Types::ComputeEnvironmentOrder>)

# File 'lib/aws-sdk-batch/types.rb', line 8182

class UpdateJobQueueRequest < Struct.new(
  :job_queue,
  :state,
  :scheduling_policy_arn,
  :priority,
  :compute_environment_order,
  :job_state_time_limit_actions)
  SENSITIVE = []
  include Aws::Structure
end

#job_queue ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-batch/types.rb', line 8182

class UpdateJobQueueRequest < Struct.new(
  :job_queue,
  :state,
  :scheduling_policy_arn,
  :priority,
  :compute_environment_order,
  :job_state_time_limit_actions)
  SENSITIVE = []
  include Aws::Structure
end

#job_state_time_limit_actions ⇒ Array<Types::JobStateTimeLimitAction>

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.

Returns:

• (Array<Types::JobStateTimeLimitAction>)

# File 'lib/aws-sdk-batch/types.rb', line 8182

class UpdateJobQueueRequest < Struct.new(
  :job_queue,
  :state,
  :scheduling_policy_arn,
  :priority,
  :compute_environment_order,
  :job_state_time_limit_actions)
  SENSITIVE = []
  include Aws::Structure
end

#priority ⇒ Integer

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.

Returns:

• (Integer)

# File 'lib/aws-sdk-batch/types.rb', line 8182

class UpdateJobQueueRequest < Struct.new(
  :job_queue,
  :state,
  :scheduling_policy_arn,
  :priority,
  :compute_environment_order,
  :job_state_time_limit_actions)
  SENSITIVE = []
  include Aws::Structure
end

#scheduling_policy_arn ⇒ String

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`.

Returns:

• (String)

# File 'lib/aws-sdk-batch/types.rb', line 8182

class UpdateJobQueueRequest < Struct.new(
  :job_queue,
  :state,
  :scheduling_policy_arn,
  :priority,
  :compute_environment_order,
  :job_state_time_limit_actions)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-batch/types.rb', line 8182

class UpdateJobQueueRequest < Struct.new(
  :job_queue,
  :state,
  :scheduling_policy_arn,
  :priority,
  :compute_environment_order,
  :job_state_time_limit_actions)
  SENSITIVE = []
  include Aws::Structure
end