Get Job Queue Snapshot

batch_get_job_queue_snapshot

R Documentation

Provides a snapshot of job queue state, including ordering of RUNNABLE jobs, as well as capacity utilization for already dispatched jobs

Description

Provides a snapshot of job queue state, including ordering of RUNNABLE jobs, as well as capacity utilization for already dispatched jobs. The first 100 RUNNABLE jobs in the job queue are listed in order of dispatch. For job queues with an attached quota-share policy, the first RUNNABLE job in each quota share is also listed. Capacity utilization for the job queue is provided, as well as break downs by share for job queues with attached fair-share or quota-share scheduling policies.

Usage

batch_get_job_queue_snapshot(jobQueue)

Arguments

jobQueue

[required] The job queue’s name or full queue Amazon Resource Name (ARN).

Value

A list with the following syntax:

list(
  frontOfQueue = list(
    jobs = list(
      list(
        jobArn = "string",
        earliestTimeAtPosition = 123
      )
    ),
    lastUpdatedAt = 123
  ),
  frontOfQuotaShares = list(
    quotaShares = list(
      list(
        list(
          jobArn = "string",
          earliestTimeAtPosition = 123
        )
      )
    ),
    lastUpdatedAt = 123
  ),
  queueUtilization = list(
    totalCapacityUsage = list(
      list(
        capacityUnit = "string",
        quantity = 123.0
      )
    ),
    fairshareUtilization = list(
      activeShareCount = 123,
      topCapacityUtilization = list(
        list(
          shareIdentifier = "string",
          capacityUsage = list(
            list(
              capacityUnit = "string",
              quantity = 123.0
            )
          )
        )
      )
    ),
    quotaShareUtilization = list(
      topCapacityUtilization = list(
        list(
          quotaShareName = "string",
          capacityUsage = list(
            list(
              capacityUnit = "string",
              quantity = 123.0
            )
          )
        )
      )
    ),
    lastUpdatedAt = 123
  )
)

Request syntax

svc$get_job_queue_snapshot(
  jobQueue = "string"
)