batch/aws.sdk.kotlin.services.batch/BatchClient/listJobs

listJobs

abstract suspend fun listJobs(input: ListJobsRequest = ListJobsRequest { }): ListJobsResponse

Returns a list of 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 nodes for that job
An array job ID to return a list of the children for that job

Samples

// This example lists the running jobs in the HighPriority job queue.
val resp = batchClient.listJobs {
    jobQueue = "HighPriority"
}

// This example lists jobs in the HighPriority job queue that are in the SUBMITTED job status.
val resp = batchClient.listJobs {
    jobQueue = "HighPriority"
    jobStatus = JobStatus.fromValue("SUBMITTED")
}