Class: Aws::Batch::Types::JobQueueDetail

Inherits:

Struct

• Object
• Struct
• Aws::Batch::Types::JobQueueDetail

Defined in:

gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb

Overview

An object that represents the details for an Batch job queue.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #compute_environment_order ⇒ Array<Types::ComputeEnvironmentOrder>

  The compute environments that are attached to the job queue and the order that job placement is preferred.

• #job_queue_arn ⇒ String

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

• #job_queue_name ⇒ String

  The job queue name.

• #job_queue_type ⇒ String

  The type of 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

  The Amazon Resource Name (ARN) of the scheduling policy.

• #service_environment_order ⇒ Array<Types::ServiceEnvironmentOrder>

  The order of the service environment associated with the job queue.

• #state ⇒ String

  Describes the ability of the queue to accept new jobs.

• #status ⇒ String

  The status of the job queue (for example, CREATING or VALID).

• #status_reason ⇒ String

  A short, human-readable string to provide additional details for the current status of the job queue.

• #tags ⇒ Hash<String,String>

  The tags that are applied to the job queue.

Instance Attribute Details

#compute_environment_order ⇒ Array<Types::ComputeEnvironmentOrder>

The compute environments that are attached to the job queue and the order that job placement is preferred. Compute environments are selected for job placement in ascending order.

Returns:

• (Array<Types::ComputeEnvironmentOrder>)

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

class JobQueueDetail < Struct.new(
  :job_queue_name,
  :job_queue_arn,
  :state,
  :scheduling_policy_arn,
  :status,
  :status_reason,
  :priority,
  :compute_environment_order,
  :service_environment_order,
  :job_queue_type,
  :tags,
  :job_state_time_limit_actions)
  SENSITIVE = []
  include Aws::Structure
end

#job_queue_arn ⇒ String

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

Returns:

• (String)

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

class JobQueueDetail < Struct.new(
  :job_queue_name,
  :job_queue_arn,
  :state,
  :scheduling_policy_arn,
  :status,
  :status_reason,
  :priority,
  :compute_environment_order,
  :service_environment_order,
  :job_queue_type,
  :tags,
  :job_state_time_limit_actions)
  SENSITIVE = []
  include Aws::Structure
end

#job_queue_name ⇒ String

The job queue name.

Returns:

• (String)

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

class JobQueueDetail < Struct.new(
  :job_queue_name,
  :job_queue_arn,
  :state,
  :scheduling_policy_arn,
  :status,
  :status_reason,
  :priority,
  :compute_environment_order,
  :service_environment_order,
  :job_queue_type,
  :tags,
  :job_state_time_limit_actions)
  SENSITIVE = []
  include Aws::Structure
end

#job_queue_type ⇒ String

The type of job queue. For service jobs that run on SageMaker Training, this value is SAGEMAKER_TRAINING. For regular container jobs, this value is EKS, ECS, or ECS_FARGATE depending on the compute environment.

Returns:

• (String)

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

class JobQueueDetail < Struct.new(
  :job_queue_name,
  :job_queue_arn,
  :state,
  :scheduling_policy_arn,
  :status,
  :status_reason,
  :priority,
  :compute_environment_order,
  :service_environment_order,
  :job_queue_type,
  :tags,
  :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 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 6072

class JobQueueDetail < Struct.new(
  :job_queue_name,
  :job_queue_arn,
  :state,
  :scheduling_policy_arn,
  :status,
  :status_reason,
  :priority,
  :compute_environment_order,
  :service_environment_order,
  :job_queue_type,
  :tags,
  :job_state_time_limit_actions)
  SENSITIVE = []
  include Aws::Structure
end

#priority ⇒ Integer

The priority of the job queue. Job queue priority determines the order that job queues are evaluated when multiple queues dispatch jobs within a shared compute environment. A higher value for priority indicates a higher priority. Queues are evaluated in cycles, in descending order by priority. For example, a job queue with a priority value of 10 is evaluated before a queue with a priority value of 1. All of the compute environments must be either Amazon EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). Amazon EC2 and Fargate compute environments can't be mixed.

Job queue priority doesn't guarantee that a particular job executes before a job in a lower priority queue. Jobs added to higher priority queues during the queue evaluation cycle might not be evaluated until the next cycle. A job is dispatched from a queue only if resources are available when the queue is evaluated. If there are insufficient resources available at that time, the cycle proceeds to the next queue. This means that jobs added to higher priority queues might have to wait for jobs in multiple lower priority queues to complete before they are dispatched. You can use job dependencies to control the order for jobs from queues with different priorities. For more information, see Job Dependencies in the Batch User Guide.

Returns:

• (Integer)

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

class JobQueueDetail < Struct.new(
  :job_queue_name,
  :job_queue_arn,
  :state,
  :scheduling_policy_arn,
  :status,
  :status_reason,
  :priority,
  :compute_environment_order,
  :service_environment_order,
  :job_queue_type,
  :tags,
  :job_state_time_limit_actions)
  SENSITIVE = []
  include Aws::Structure
end

#scheduling_policy_arn ⇒ String

The Amazon Resource Name (ARN) of the scheduling policy. 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 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 6072

class JobQueueDetail < Struct.new(
  :job_queue_name,
  :job_queue_arn,
  :state,
  :scheduling_policy_arn,
  :status,
  :status_reason,
  :priority,
  :compute_environment_order,
  :service_environment_order,
  :job_queue_type,
  :tags,
  :job_state_time_limit_actions)
  SENSITIVE = []
  include Aws::Structure
end

#service_environment_order ⇒ Array<Types::ServiceEnvironmentOrder>

The order of the service environment associated with the job queue. Job queues with a higher priority are evaluated first when associated with the same service environment.

Returns:

• (Array<Types::ServiceEnvironmentOrder>)

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

class JobQueueDetail < Struct.new(
  :job_queue_name,
  :job_queue_arn,
  :state,
  :scheduling_policy_arn,
  :status,
  :status_reason,
  :priority,
  :compute_environment_order,
  :service_environment_order,
  :job_queue_type,
  :tags,
  :job_state_time_limit_actions)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

Describes the ability of the queue 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 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 6072

class JobQueueDetail < Struct.new(
  :job_queue_name,
  :job_queue_arn,
  :state,
  :scheduling_policy_arn,
  :status,
  :status_reason,
  :priority,
  :compute_environment_order,
  :service_environment_order,
  :job_queue_type,
  :tags,
  :job_state_time_limit_actions)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the job queue (for example, CREATING or VALID).

Returns:

• (String)

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

class JobQueueDetail < Struct.new(
  :job_queue_name,
  :job_queue_arn,
  :state,
  :scheduling_policy_arn,
  :status,
  :status_reason,
  :priority,
  :compute_environment_order,
  :service_environment_order,
  :job_queue_type,
  :tags,
  :job_state_time_limit_actions)
  SENSITIVE = []
  include Aws::Structure
end

#status_reason ⇒ String

A short, human-readable string to provide additional details for the current status of the job queue.

Returns:

• (String)

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

class JobQueueDetail < Struct.new(
  :job_queue_name,
  :job_queue_arn,
  :state,
  :scheduling_policy_arn,
  :status,
  :status_reason,
  :priority,
  :compute_environment_order,
  :service_environment_order,
  :job_queue_type,
  :tags,
  :job_state_time_limit_actions)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags that are applied to the job queue. For more information, see Tagging your Batch resources in Batch User Guide.

Returns:

• (Hash<String,String>)

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

class JobQueueDetail < Struct.new(
  :job_queue_name,
  :job_queue_arn,
  :state,
  :scheduling_policy_arn,
  :status,
  :status_reason,
  :priority,
  :compute_environment_order,
  :service_environment_order,
  :job_queue_type,
  :tags,
  :job_state_time_limit_actions)
  SENSITIVE = []
  include Aws::Structure
end