paws.compute (version 0.1.12)

batch_list_jobs: Returns a list of AWS Batch jobs

Description

Returns a list of AWS Batch jobs.

You must specify only one of the following items:

• 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 don't specify a status, only RUNNING jobs are returned.

Usage

batch_list_jobs(jobQueue, arrayJobId, multiNodeJobId, jobStatus,
  maxResults, nextToken)

Value

A list with the following syntax:

list(
  jobSummaryList = list(
    list(
      jobArn = "string",
      jobId = "string",
      jobName = "string",
      createdAt = 123,
      status = "SUBMITTED"|"PENDING"|"RUNNABLE"|"STARTING"|"RUNNING"|"SUCCEEDED"|"FAILED",
      statusReason = "string",
      startedAt = 123,
      stoppedAt = 123,
      container = list(
        exitCode = 123,
        reason = "string"
      ),
      arrayProperties = list(
        size = 123,
        index = 123
      ),
      nodeProperties = list(
        isMainNode = TRUE|FALSE,
        numNodes = 123,
        nodeIndex = 123
      )
    )
  ),
  nextToken = "string"
)

Arguments

jobQueue

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

arrayJobId

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

multiNodeJobId

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.

jobStatus

The job status used to filter jobs in the specified queue. If you don't specify a status, only RUNNING jobs are returned.

maxResults

The maximum number of results returned by list_jobs in paginated output. When this parameter is used, list_jobs 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 list_jobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then list_jobs returns up to 100 results and a nextToken value if applicable.

nextToken

The nextToken value returned from a previous paginated list_jobs 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.

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

Request syntax

svc$list_jobs(
  jobQueue = "string",
  arrayJobId = "string",
  multiNodeJobId = "string",
  jobStatus = "SUBMITTED"|"PENDING"|"RUNNABLE"|"STARTING"|"RUNNING"|"SUCCEEDED"|"FAILED",
  maxResults = 123,
  nextToken = "string"
)

Examples

if (FALSE) {
# This example lists the running jobs in the HighPriority job queue.
svc$list_jobs(
  jobQueue = "HighPriority"
)

# This example lists jobs in the HighPriority job queue that are in the
# SUBMITTED job status.
svc$list_jobs(
  jobQueue = "HighPriority",
  jobStatus = "SUBMITTED"
)
}