job_queue_snapshots
Creates, updates, deletes, gets or lists a job_queue_snapshots resource.
Overview
| Name | job_queue_snapshots |
| Type | Resource |
| Id | aws.batch.job_queue_snapshots |
Fields
The following fields are returned by SELECT queries:
- get_job_queue_snapshot
| Name | Datatype | Description |
|---|---|---|
front_of_queue | object | The list of the first 100 RUNNABLE jobs in each job queue. For first-in-first-out (FIFO) job queues, jobs are ordered based on their submission time. For job queues with an attached fair-share scheduling (FSS) or quota-share policy, jobs are ordered based on their job priority and share usage. |
front_of_quota_shares | object | The first RUNNABLE job in each quota share. Jobs are ordered based on their job priority and share usage. |
queue_utilization | object | The job queue's capacity utilization, including total usage and breakdown per given share. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_job_queue_snapshot | select | region | 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. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_job_queue_snapshot
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.
SELECT
front_of_queue,
front_of_quota_shares,
queue_utilization
FROM aws.batch.job_queue_snapshots
WHERE region = '{{ region }}' -- required
;