AWS CLI Command Reference

[ aws . batch ]

list-jobs

Description

Returns a list of AWS Batch jobs.

You must specify only one of the following:

  • a job queue ID to return a list of jobs in that job queue

  • a multi-node parallel job ID to return a list of that job’s nodes

  • an array job ID to return a list of that job’s children

You can filter the results by job status with the jobStatus parameter. If you do not specify a status, only RUNNING jobs are returned.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-jobs is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: jobSummaryList

Synopsis

  list-jobs
[--job-queue <value>]
[--array-job-id <value>]
[--multi-node-job-id <value>]
[--job-status <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--job-queue (string)

The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.

--array-job-id (string)

The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.

--multi-node-job-id (string)

The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.

--job-status (string)

The job status with which to filter jobs in the specified queue. If you do not specify a status, only RUNNING jobs are returned.

Possible values:

  • SUBMITTED

  • PENDING

  • RUNNABLE

  • STARTING

  • RUNNING

  • SUCCEEDED

  • FAILED

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To list running jobs

This example lists the running jobs in the HighPriority job queue.

Command:

aws batch list-jobs --job-queue HighPriority

Output:

{
    "jobSummaryList": [
        {
            "jobName": "example",
            "jobId": "e66ff5fd-a1ff-4640-b1a2-0b0a142f49bb"
        }
    ]
}

To list submitted jobs

This example lists jobs in the HighPriority job queue that are in the SUBMITTED job status.

Command:

aws batch list-jobs --job-queue HighPriority --job-status SUBMITTED

Output:

{
    "jobSummaryList": [
        {
            "jobName": "example",
            "jobId": "68f0c163-fbd4-44e6-9fd1-25b14a434786"
        }
    ]
}

Output

jobSummaryList -> (list)

A list of job summaries that match the request.

(structure)

An object representing summary details of a job.

jobId -> (string)

The ID of the job.

jobName -> (string)

The name of the job.

createdAt -> (long)

The Unix timestamp for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state (at the time SubmitJob was called). For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state.

status -> (string)

The current status for the job.

statusReason -> (string)

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

startedAt -> (long)

The Unix timestamp for when the job was started (when the job transitioned from the STARTING state to the RUNNING state).

stoppedAt -> (long)

The Unix timestamp for when the job was stopped (when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED ).

container -> (structure)

An object representing the details of the container that is associated with the job.

exitCode -> (integer)

The exit code to return upon completion.

reason -> (string)

A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

arrayProperties -> (structure)

The array properties of the job, if it is an array job.

size -> (integer)

The size of the array job. This parameter is returned for parent array jobs.

index -> (integer)

The job index within the array that is associated with this job. This parameter is returned for children of array jobs.

nodeProperties -> (structure)

The node properties for a single node in a job summary list.

isMainNode -> (boolean)

Specifies whether the current node is the main node for a multi-node parallel job.

numNodes -> (integer)

The number of nodes associated with a multi-node parallel job.

nodeIndex -> (integer)

The node index for the node. Node index numbering begins at zero. This index is also available on the node with the AWS_BATCH_JOB_NODE_INDEX environment variable.

nextToken -> (string)

The nextToken value to include in a future ListJobs request. When the results of a ListJobs request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

© Copyright 2018, Amazon Web Services. Created using Sphinx.