batch/aws.sdk.kotlin.services.batch.model/ListJobsRequest/Builder

Builder

Properties

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

filters

var filters: List<KeyValuesPair>?

The filter to apply to the query. Only one filter can be used at a time. When the filter is used, jobStatus is ignored. The filter doesn't apply to child jobs in an array or multi-node parallel (MNP) jobs. The results are sorted by the createdAt field, with the most recent jobs being first.

jobQueue

var jobQueue: String?

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

jobStatus

var jobStatus: JobStatus?

The job status used to filter jobs in the specified queue. If the filters parameter is specified, the jobStatus parameter is ignored and jobs with any status are returned. If you don't specify a status, only RUNNING jobs are returned.

maxResults

var maxResults: Int?

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 and 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 isn't used, then ListJobs returns up to 100 results and a nextToken value if applicable.

multiNodeJobId

var multiNodeJobId: 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.

nextToken

var nextToken: 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.