Documentation

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

See: newJobQueueDetail smart constructor.

Create a value of JobQueueDetail with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:schedulingPolicyArn:JobQueueDetail', jobQueueDetail_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.

$sel:status:JobQueueDetail', jobQueueDetail_status - The status of the job queue (for example, CREATING or VALID).

$sel:statusReason:JobQueueDetail', jobQueueDetail_statusReason - A short, human-readable string to provide additional details for the current status of the job queue.

$sel:tags:JobQueueDetail', jobQueueDetail_tags - The tags that are applied to the job queue. For more information, see Tagging your Batch resources in Batch User Guide.

$sel:jobQueueName:JobQueueDetail', jobQueueDetail_jobQueueName - The job queue name.

$sel:jobQueueArn:JobQueueDetail', jobQueueDetail_jobQueueArn - The Amazon Resource Name (ARN) of the job queue.

$sel:state:JobQueueDetail', jobQueueDetail_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.

$sel:priority:JobQueueDetail', jobQueueDetail_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 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.

$sel:computeEnvironmentOrder:JobQueueDetail', jobQueueDetail_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.

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.

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

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

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

The job queue name.

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

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.

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.

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.