Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . batch ]

list-jobs

Description

Returns a list of AWS Batch jobs. You must specify either a job queue to return a list of jobs in that job queue, or an array job ID to return a list of that job's children. You cannot specify both a job queue and an array job ID.

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.

Synopsis

  list-jobs
[--job-queue <value>]
[--array-job-id <value>]
[--job-status <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--job-queue (string)

The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs. You must specify either a job queue or an array job ID.

--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. You must specify either a job queue or an array job ID.

--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

--max-results (integer)

The maximum number of results returned by ListJobs in paginated output. When this parameter is used, ListJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListJobs returns up to 100 results and a nextToken value if applicable.

--next-token (string)

The nextToken value returned from a previous paginated ListJobs request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

Note

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

--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.

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 time stamp 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 time stamp for when the job was started (when the job transitioned from the STARTING state to the RUNNING state).

stoppedAt -> (long)

The Unix time stamp 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.

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.