JobQueueDetail - Amazon Batch
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

JobQueueDetail

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

Contents

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.

Type: Array of ComputeEnvironmentOrder objects

Required: Yes

jobQueueArn

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

Type: String

Required: Yes

jobQueueName

The job queue name.

Type: String

Required: Yes

priority

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.

Note

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 Amazon Batch User Guide.

Type: Integer

Required: Yes

state

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.

Type: String

Valid Values: ENABLED | DISABLED

Required: Yes

jobStateTimeLimitActions

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

Type: Array of JobStateTimeLimitAction objects

Required: No

schedulingPolicyArn

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.

Type: String

Required: No

status

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

Type: String

Valid Values: CREATING | UPDATING | DELETING | DELETED | VALID | INVALID

Required: No

statusReason

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

Type: String

Required: No

tags

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

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: