AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . batch ]

get-job-queue-snapshot

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.

See also: AWS API Documentation

Synopsis

  get-job-queue-snapshot
--job-queue <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--job-queue (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

frontOfQueue -> (structure)

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.

jobs -> (list)

The Amazon Resource Names (ARNs) of the first 100 RUNNABLE jobs in a named job queue. For first-in-first-out (FIFO) job queues, jobs are ordered based on their submission time. For fair-share scheduling (FSS) job queues, jobs are ordered based on their job priority and share usage.

(structure)

An object that represents summary details for the first 100 RUNNABLE jobs in a job queue.

jobArn -> (string)

The ARN for a job in a named job queue.

earliestTimeAtPosition -> (long)

The Unix timestamp (in milliseconds) for when the job transitioned to its current position in the job queue.

lastUpdatedAt -> (long)

The Unix timestamp (in milliseconds) for when each of the first 100 RUNNABLE jobs were last updated.

frontOfQuotaShares -> (structure)

The first RUNNABLE job in each quota share. Jobs are ordered based on their job priority and share usage.

quotaShares -> (map)

Contains a list of the first RUNNABLE job in each named quota share.

key -> (string)

value -> (list)

(structure)

An object that represents summary details for the first RUNNABLE job in a quota share.

jobArn -> (string)

The ARN for a job in a named quota share.

earliestTimeAtPosition -> (long)

The Unix timestamp (in milliseconds) for when the job transitioned to its current position in the quota share.

lastUpdatedAt -> (long)

The Unix timestamp (in milliseconds) for when the first RUNNABLE job per quota share were all last updated.

queueUtilization -> (structure)

The job queue’s capacity utilization, including total usage and breakdown per given share.

totalCapacityUsage -> (list)

The total capacity usage for the entire job queue.

(structure)

The configured capacity usage for a job queue snapshot, including the unit of measure and quantity of resources being used.

capacityUnit -> (string)

The unit of measure for the capacity usage. For compute jobs, this is VCPU for Amazon EC2 and cpu for Amazon EKS. For service jobs, this is the instance type.

quantity -> (double)

The quantity of capacity being used in the queue snapshot, measured in the units specified by capacityUnit .

fairshareUtilization -> (structure)

The utilization information for a fairshare scheduling job queues, including active share count and top capacity utilization by share.

activeShareCount -> (long)

The total number of active shares in the fairshare scheduling job queue that are currently utilizing capacity.

topCapacityUtilization -> (list)

A list of the top 20 shares with the highest capacity utilization, ordered by usage amount.

(structure)

The capacity utilization for a specific share in a fairshare scheduling job queue, including the share identifier and its current usage.

shareIdentifier -> (string)

The share identifier for the fairshare scheduling job queue.

capacityUsage -> (list)

The capacity usage information for this share, including the unit of measure and quantity being used. This is VCPU for Amazon EC2 and cpu for Amazon EKS.

(structure)

The capacity usage for a fairshare scheduling job queue.

capacityUnit -> (string)

The unit of measure for the capacity usage. For compute jobs, this is VCPU for Amazon EC2 and cpu for Amazon EKS. For service jobs, this is the instance type.

quantity -> (double)

The quantity of capacity being used, measured in the units specified by capacityUnit .

quotaShareUtilization -> (structure)

The utilization information for a job queue with a quota share scheduling policy.

topCapacityUtilization -> (list)

A list of the top capacity utilizations across quota shares associated with a job queue.

(structure)

The capacity utilization for a specific quota share, including the quota share name and its current usage.

quotaShareName -> (string)

The name of the quota share.

capacityUsage -> (list)

The capacity usage information for this quota share, including the units of compute capacity and quantity being used.

(structure)

The capacity usage for a quota share, including units of compute capacity and quantity of resources being used.

capacityUnit -> (string)

The unit of compute capacity for the capacity usage.

quantity -> (double)

The quantity of capacity being used.

lastUpdatedAt -> (long)

The Unix timestamp (in milliseconds) for when the queue utilization information was last updated.