paws.compute (version 0.1.0)

batch_list_jobs: Returns a list of AWS Batch jobs

Description

Returns a list of AWS Batch jobs.

Usage

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

Arguments

jobQueue

The name or full Amazon Resource Name (ARN) of the job queue with which 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 with which to filter jobs in the specified queue. If you do not specify a status, only RUNNING jobs are returned.

maxResults

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.

nextToken

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.

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.

Request syntax

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

Details

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.

Examples

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