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 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 of10
is given scheduling preference over a job queue with a priority value of1
. All of the compute environments must be either Amazon EC2 (EC2
orSPOT
) or Fargate (FARGATE
orFARGATE_SPOT
). Amazon EC2 and Fargate compute environments can't be mixed.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 isDISABLED
, 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
orVALID
).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
-
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: