{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/aws-batch/json-schema/aws-batch-list-jobs-request-schema.json",
  "title": "ListJobsRequest",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/aws-batch-jobs-api-openapi.yml#/components/schemas/ListJobsRequest",
  "type": "object",
  "properties": {
    "jobQueue": {
      "type": "string",
      "description": "The name or full Amazon Resource Name (ARN) of the job queue used to list jobs."
    },
    "arrayJobId": {
      "type": "string",
      "description": "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": {
      "type": "string",
      "description": "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": {
      "type": "string",
      "enum": [
        "SUBMITTED",
        "PENDING",
        "RUNNABLE",
        "STARTING",
        "RUNNING",
        "SUCCEEDED",
        "FAILED"
      ],
      "description": "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. The exception is the SHARE_IDENTIFIER filter and jobStatus can be used together. If you don't specify a status, only RUNNING jobs are returned. Array job parents are updated to PENDING when any child job is updated to RUNNABLE and remain in PENDING status while child jobs are running. To view these jobs, filter by PENDING status until all child jobs reach a terminal state."
    },
    "maxResults": {
      "type": "integer",
      "description": "The maximum number of results returned by ListJobs in a paginated output. When this parameter is used, ListJobs returns up to maxResults results in a single page and a nextToken response element, if applicable. The remaining results of the initial request can be seen by sending another ListJobs request with the returned nextToken value. The following outlines key parameters and limitations: The minimum value is 1. When --job-status is used, Batch returns up to 1000 values. When --filters is used, Batch returns up to 100 values. If neither parameter is used, then ListJobs returns up to 1000 res"
    },
    "nextToken": {
      "type": "string",
      "description": "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. Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes."
    },
    "filters": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/KeyValuesPair"
      },
      "description": "The filter to apply to the query. Only one filter can be used at a time. When the filter is used, jobStatus is ignored with the exception that SHARE_IDENTIFIER and jobStatus can be used together. 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. The SHARE_IDENTIFIER filter and the jobStatus field can be used together to filter results. JOB_NAME The value of the filter is a case-insensitive match for the job name. If the value ends with an asterisk (*), the filter matches an"
    }
  },
  "$defs": {
    "KeyValuesPair": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the filter. Filter names are case sensitive."
        },
        "values": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The filter values."
        }
      }
    }
  }
}