AWS Classic v5.29.1, Feb 4 23

aws.batch.getJobQueue

The Batch Job Queue data source allows access to details of a specific job queue within AWS Batch.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test_queue = Aws.Batch.GetJobQueue.Invoke(new()
    {
        Name = "tf-test-batch-job-queue",
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/batch"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := batch.LookupJobQueue(ctx, &batch.LookupJobQueueArgs{
			Name: "tf-test-batch-job-queue",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.batch.BatchFunctions;
import com.pulumi.aws.batch.inputs.GetJobQueueArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var test-queue = BatchFunctions.getJobQueue(GetJobQueueArgs.builder()
            .name("tf-test-batch-job-queue")
            .build());

    }
}

import pulumi
import pulumi_aws as aws

test_queue = aws.batch.get_job_queue(name="tf-test-batch-job-queue")

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test-queue = aws.batch.getJobQueue({
    name: "tf-test-batch-job-queue",
});

variables:
  test-queue:
    fn::invoke:
      Function: aws:batch:getJobQueue
      Arguments:
        name: tf-test-batch-job-queue

Using getJobQueue

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getJobQueue(args: GetJobQueueArgs, opts?: InvokeOptions): Promise<GetJobQueueResult>
function getJobQueueOutput(args: GetJobQueueOutputArgs, opts?: InvokeOptions): Output<GetJobQueueResult>

def get_job_queue(name: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = None,
                  opts: Optional[InvokeOptions] = None) -> GetJobQueueResult
def get_job_queue_output(name: Optional[pulumi.Input[str]] = None,
                  tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetJobQueueResult]

func LookupJobQueue(ctx *Context, args *LookupJobQueueArgs, opts ...InvokeOption) (*LookupJobQueueResult, error)
func LookupJobQueueOutput(ctx *Context, args *LookupJobQueueOutputArgs, opts ...InvokeOption) LookupJobQueueResultOutput

> Note: This function is named LookupJobQueue in the Go SDK.

public static class GetJobQueue 
{
    public static Task<GetJobQueueResult> InvokeAsync(GetJobQueueArgs args, InvokeOptions? opts = null)
    public static Output<GetJobQueueResult> Invoke(GetJobQueueInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetJobQueueResult> getJobQueue(GetJobQueueArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws:batch/getJobQueue:getJobQueue
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: Name of the job queue.
Tags Dictionary<string, string>: Key-value map of resource tags

Name string: Name of the job queue.
Tags map[string]string: Key-value map of resource tags

name String: Name of the job queue.
tags Map<String,String>: Key-value map of resource tags

name string: Name of the job queue.
tags {[key: string]: string}: Key-value map of resource tags

name str: Name of the job queue.
tags Mapping[str, str]: Key-value map of resource tags

name String: Name of the job queue.
tags Map<String>: Key-value map of resource tags

getJobQueue Result

The following output properties are available:

Arn string

ARN of the job queue.

ComputeEnvironmentOrders List<GetJobQueueComputeEnvironmentOrder>

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

compute_environment_order.#.order - The order of the compute environment.
compute_environment_order.#.compute_environment - The ARN of the compute environment.

Id string

The provider-assigned unique ID for this managed resource.

Name string

Priority int

Priority of the job queue. Job queues with a higher priority are evaluated first when associated with the same compute environment.

SchedulingPolicyArn string

The ARN of the fair share scheduling policy. If this attribute has a value, the job queue uses a fair share scheduling policy. If this attribute does not have a value, the job queue uses a first in, first out (FIFO) scheduling policy.

State string

Describes the ability of the queue to accept new jobs (for example, ENABLED or DISABLED).

Status string

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

StatusReason string

Short, human-readable string to provide additional details about the current status of the job queue.

Tags Dictionary<string, string>

Key-value map of resource tags

Arn string

ARN of the job queue.

ComputeEnvironmentOrders []GetJobQueueComputeEnvironmentOrder

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

compute_environment_order.#.order - The order of the compute environment.
compute_environment_order.#.compute_environment - The ARN of the compute environment.

Id string

The provider-assigned unique ID for this managed resource.

Name string

Priority int

Priority of the job queue. Job queues with a higher priority are evaluated first when associated with the same compute environment.

SchedulingPolicyArn string

State string

Describes the ability of the queue to accept new jobs (for example, ENABLED or DISABLED).

Status string

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

StatusReason string

Short, human-readable string to provide additional details about the current status of the job queue.

Tags map[string]string

Key-value map of resource tags

arn String

ARN of the job queue.

computeEnvironmentOrders List<GetJobQueueComputeEnvironmentOrder>

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

compute_environment_order.#.order - The order of the compute environment.
compute_environment_order.#.compute_environment - The ARN of the compute environment.

id String

The provider-assigned unique ID for this managed resource.

name String

priority Integer

Priority of the job queue. Job queues with a higher priority are evaluated first when associated with the same compute environment.

schedulingPolicyArn String

state String

Describes the ability of the queue to accept new jobs (for example, ENABLED or DISABLED).

status String

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

statusReason String

Short, human-readable string to provide additional details about the current status of the job queue.

tags Map<String,String>

Key-value map of resource tags

arn string

ARN of the job queue.

computeEnvironmentOrders GetJobQueueComputeEnvironmentOrder[]

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

compute_environment_order.#.order - The order of the compute environment.
compute_environment_order.#.compute_environment - The ARN of the compute environment.

id string

The provider-assigned unique ID for this managed resource.

name string

priority number

Priority of the job queue. Job queues with a higher priority are evaluated first when associated with the same compute environment.

schedulingPolicyArn string

state string

Describes the ability of the queue to accept new jobs (for example, ENABLED or DISABLED).

status string

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

statusReason string

Short, human-readable string to provide additional details about the current status of the job queue.

tags {[key: string]: string}

Key-value map of resource tags

arn str

ARN of the job queue.

compute_environment_orders Sequence[GetJobQueueComputeEnvironmentOrder]

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

compute_environment_order.#.order - The order of the compute environment.
compute_environment_order.#.compute_environment - The ARN of the compute environment.

id str

The provider-assigned unique ID for this managed resource.

name str

priority int

Priority of the job queue. Job queues with a higher priority are evaluated first when associated with the same compute environment.

scheduling_policy_arn str

state str

Describes the ability of the queue to accept new jobs (for example, ENABLED or DISABLED).

status str

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

status_reason str

Short, human-readable string to provide additional details about the current status of the job queue.

tags Mapping[str, str]

Key-value map of resource tags

arn String

ARN of the job queue.

computeEnvironmentOrders List<Property Map>

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

compute_environment_order.#.order - The order of the compute environment.
compute_environment_order.#.compute_environment - The ARN of the compute environment.

id String