Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1424200374.6 KB

Describes one or more of your job queues.

post/v1/describejobqueues

Query parameters

maxResultsstring

Pagination limit

nextTokenstring

Pagination token

Request body

jobQueuesString[]

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

maxResultsinteger

The maximum number of results returned by <code>DescribeJobQueues</code> in paginated output. When this parameter is used, <code>DescribeJobQueues</code> only returns <code>maxResults</code> results in a single page and a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeJobQueues</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter isn't used, then <code>DescribeJobQueues</code> returns up to 100 results and a <code>nextToken</code> value if applicable.

nextTokenstring
<p>The <code>nextToken</code> value returned from a previous paginated <code>DescribeJobQueues</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</p> <note> <p>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.</p> </note>

Response

Success

nextTokenstring

The <code>nextToken</code> value to include in a future <code>DescribeJobQueues</code> request. When the results of a <code>DescribeJobQueues</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.

Example response

{
  "jobQueues": [
    {
      "computeEnvironmentOrder": [
        {
          "computeEnvironment": "arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand",
          "order": 1
        }
      ],
      "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority",
      "jobQueueName": "HighPriority",
      "priority": 1,
      "state": "ENABLED",
      "status": "VALID",
      "statusReason": "JobQueue Healthy"
    }
  ]
}