Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. batch
  5. getJobQueue

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.batch.getJobQueue

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Batch::JobQueue

    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(job_queue_arn: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetJobQueueResult
def get_job_queue_output(job_queue_arn: Optional[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-native:batch:getJobQueue
  arguments:
    # arguments dictionary

    The following arguments are supported:

    JobQueueArn string
    Returns the job queue ARN, such as batch: *us-east-1* : *111122223333* :job-queue/ *JobQueueName* .
    JobQueueArn string
    Returns the job queue ARN, such as batch: *us-east-1* : *111122223333* :job-queue/ *JobQueueName* .
    jobQueueArn String
    Returns the job queue ARN, such as batch: *us-east-1* : *111122223333* :job-queue/ *JobQueueName* .
    jobQueueArn string
    Returns the job queue ARN, such as batch: *us-east-1* : *111122223333* :job-queue/ *JobQueueName* .
    job_queue_arn str
    Returns the job queue ARN, such as batch: *us-east-1* : *111122223333* :job-queue/ *JobQueueName* .
    jobQueueArn String
    Returns the job queue ARN, such as batch: *us-east-1* : *111122223333* :job-queue/ *JobQueueName* .

    getJobQueue Result

    The following output properties are available:

    ComputeEnvironmentOrder List<Pulumi.AwsNative.Batch.Outputs.JobQueueComputeEnvironmentOrder>

    The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment runs a specific job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. 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.

    All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.

    JobQueueArn string
    Returns the job queue ARN, such as batch: *us-east-1* : *111122223333* :job-queue/ *JobQueueName* .
    JobStateTimeLimitActions List<Pulumi.AwsNative.Batch.Outputs.JobQueueJobStateTimeLimitAction>
    The set of actions that AWS Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. AWS Batch will perform each action after maxTimeSeconds has passed.
    Priority int
    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.
    SchedulingPolicyArn 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 .
    State Pulumi.AwsNative.Batch.JobQueueState
    The state of the job queue. If the job queue state is ENABLED , it is able to 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.
    ComputeEnvironmentOrder []JobQueueComputeEnvironmentOrder

    The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment runs a specific job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. 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.

    All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.

    JobQueueArn string
    Returns the job queue ARN, such as batch: *us-east-1* : *111122223333* :job-queue/ *JobQueueName* .
    JobStateTimeLimitActions []JobQueueJobStateTimeLimitAction
    The set of actions that AWS Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. AWS Batch will perform each action after maxTimeSeconds has passed.
    Priority int
    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.
    SchedulingPolicyArn 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 .
    State JobQueueStateEnum
    The state of the job queue. If the job queue state is ENABLED , it is able to 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.
    computeEnvironmentOrder List<JobQueueComputeEnvironmentOrder>

    The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment runs a specific job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. 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.

    All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.

    jobQueueArn String
    Returns the job queue ARN, such as batch: *us-east-1* : *111122223333* :job-queue/ *JobQueueName* .
    jobStateTimeLimitActions List<JobQueueJobStateTimeLimitAction>
    The set of actions that AWS Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. AWS Batch will perform each action after maxTimeSeconds has passed.
    priority Integer
    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.
    schedulingPolicyArn 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 .
    state JobQueueState
    The state of the job queue. If the job queue state is ENABLED , it is able to 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.
    computeEnvironmentOrder JobQueueComputeEnvironmentOrder[]

    The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment runs a specific job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. 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.

    All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.

    jobQueueArn string
    Returns the job queue ARN, such as batch: *us-east-1* : *111122223333* :job-queue/ *JobQueueName* .
    jobStateTimeLimitActions JobQueueJobStateTimeLimitAction[]
    The set of actions that AWS Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. AWS Batch will perform each action after maxTimeSeconds has passed.
    priority number
    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.
    schedulingPolicyArn 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 .
    state JobQueueState
    The state of the job queue. If the job queue state is ENABLED , it is able to 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.
    compute_environment_order Sequence[JobQueueComputeEnvironmentOrder]

    The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment runs a specific job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. 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.

    All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.

    job_queue_arn str
    Returns the job queue ARN, such as batch: *us-east-1* : *111122223333* :job-queue/ *JobQueueName* .
    job_state_time_limit_actions Sequence[JobQueueJobStateTimeLimitAction]
    The set of actions that AWS Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. AWS Batch will perform each action after maxTimeSeconds has passed.
    priority int
    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.
    scheduling_policy_arn str
    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 .
    state JobQueueState
    The state of the job queue. If the job queue state is ENABLED , it is able to 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.
    computeEnvironmentOrder List<Property Map>

    The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment runs a specific job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. 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.

    All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.

    jobQueueArn String
    Returns the job queue ARN, such as batch: *us-east-1* : *111122223333* :job-queue/ *JobQueueName* .
    jobStateTimeLimitActions List<Property Map>
    The set of actions that AWS Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. AWS Batch will perform each action after maxTimeSeconds has passed.
    priority Number
    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.
    schedulingPolicyArn 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 .
    state "DISABLED" | "ENABLED"
    The state of the job queue. If the job queue state is ENABLED , it is able to 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.

    Supporting Types

    JobQueueComputeEnvironmentOrder

    ComputeEnvironment string
    The Amazon Resource Name (ARN) of the compute environment.
    Order int
    The order of the compute environment. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first.
    ComputeEnvironment string
    The Amazon Resource Name (ARN) of the compute environment.
    Order int
    The order of the compute environment. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first.
    computeEnvironment String
    The Amazon Resource Name (ARN) of the compute environment.
    order Integer
    The order of the compute environment. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first.
    computeEnvironment string
    The Amazon Resource Name (ARN) of the compute environment.
    order number
    The order of the compute environment. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first.
    compute_environment str
    The Amazon Resource Name (ARN) of the compute environment.
    order int
    The order of the compute environment. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first.
    computeEnvironment String
    The Amazon Resource Name (ARN) of the compute environment.
    order Number
    The order of the compute environment. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first.

    JobQueueJobStateTimeLimitAction

    Action Pulumi.AwsNative.Batch.JobQueueJobStateTimeLimitActionAction
    The action to take when a job is at the head of the job queue in the specified state for the specified period of time. The only supported value is CANCEL , which will cancel the job.
    MaxTimeSeconds int
    The approximate amount of time, in seconds, that must pass with the job in the specified state before the action is taken. The minimum value is 600 (10 minutes) and the maximum value is 86,400 (24 hours).
    Reason string
    The reason to log for the action being taken.
    State Pulumi.AwsNative.Batch.JobQueueJobStateTimeLimitActionState
    The state of the job needed to trigger the action. The only supported value is RUNNABLE .
    Action JobQueueJobStateTimeLimitActionAction
    The action to take when a job is at the head of the job queue in the specified state for the specified period of time. The only supported value is CANCEL , which will cancel the job.
    MaxTimeSeconds int
    The approximate amount of time, in seconds, that must pass with the job in the specified state before the action is taken. The minimum value is 600 (10 minutes) and the maximum value is 86,400 (24 hours).
    Reason string
    The reason to log for the action being taken.
    State JobQueueJobStateTimeLimitActionState
    The state of the job needed to trigger the action. The only supported value is RUNNABLE .
    action JobQueueJobStateTimeLimitActionAction
    The action to take when a job is at the head of the job queue in the specified state for the specified period of time. The only supported value is CANCEL , which will cancel the job.
    maxTimeSeconds Integer
    The approximate amount of time, in seconds, that must pass with the job in the specified state before the action is taken. The minimum value is 600 (10 minutes) and the maximum value is 86,400 (24 hours).
    reason String
    The reason to log for the action being taken.
    state JobQueueJobStateTimeLimitActionState
    The state of the job needed to trigger the action. The only supported value is RUNNABLE .
    action JobQueueJobStateTimeLimitActionAction
    The action to take when a job is at the head of the job queue in the specified state for the specified period of time. The only supported value is CANCEL , which will cancel the job.
    maxTimeSeconds number
    The approximate amount of time, in seconds, that must pass with the job in the specified state before the action is taken. The minimum value is 600 (10 minutes) and the maximum value is 86,400 (24 hours).
    reason string
    The reason to log for the action being taken.
    state JobQueueJobStateTimeLimitActionState
    The state of the job needed to trigger the action. The only supported value is RUNNABLE .
    action JobQueueJobStateTimeLimitActionAction
    The action to take when a job is at the head of the job queue in the specified state for the specified period of time. The only supported value is CANCEL , which will cancel the job.
    max_time_seconds int
    The approximate amount of time, in seconds, that must pass with the job in the specified state before the action is taken. The minimum value is 600 (10 minutes) and the maximum value is 86,400 (24 hours).
    reason str
    The reason to log for the action being taken.
    state JobQueueJobStateTimeLimitActionState
    The state of the job needed to trigger the action. The only supported value is RUNNABLE .
    action "CANCEL"
    The action to take when a job is at the head of the job queue in the specified state for the specified period of time. The only supported value is CANCEL , which will cancel the job.
    maxTimeSeconds Number
    The approximate amount of time, in seconds, that must pass with the job in the specified state before the action is taken. The minimum value is 600 (10 minutes) and the maximum value is 86,400 (24 hours).
    reason String
    The reason to log for the action being taken.
    state "RUNNABLE"
    The state of the job needed to trigger the action. The only supported value is RUNNABLE .

    JobQueueJobStateTimeLimitActionAction

    JobQueueJobStateTimeLimitActionState

    JobQueueState

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native