- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeJobQueuesCommand
Describes one or more of your job queues.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { BatchClient, DescribeJobQueuesCommand } from "@aws-sdk/client-batch"; // ES Modules import
// const { BatchClient, DescribeJobQueuesCommand } = require("@aws-sdk/client-batch"); // CommonJS import
const client = new BatchClient(config);
const input = { // DescribeJobQueuesRequest
jobQueues: [ // StringList
"STRING_VALUE",
],
maxResults: Number("int"),
nextToken: "STRING_VALUE",
};
const command = new DescribeJobQueuesCommand(input);
const response = await client.send(command);
// { // DescribeJobQueuesResponse
// jobQueues: [ // JobQueueDetailList
// { // JobQueueDetail
// jobQueueName: "STRING_VALUE", // required
// jobQueueArn: "STRING_VALUE", // required
// state: "ENABLED" || "DISABLED", // required
// schedulingPolicyArn: "STRING_VALUE",
// status: "CREATING" || "UPDATING" || "DELETING" || "DELETED" || "VALID" || "INVALID",
// statusReason: "STRING_VALUE",
// priority: Number("int"), // required
// computeEnvironmentOrder: [ // ComputeEnvironmentOrders // required
// { // ComputeEnvironmentOrder
// order: Number("int"), // required
// computeEnvironment: "STRING_VALUE", // required
// },
// ],
// tags: { // TagrisTagsMap
// "<keys>": "STRING_VALUE",
// },
// jobStateTimeLimitActions: [ // JobStateTimeLimitActions
// { // JobStateTimeLimitAction
// reason: "STRING_VALUE", // required
// state: "RUNNABLE", // required
// maxTimeSeconds: Number("int"), // required
// action: "CANCEL", // required
// },
// ],
// },
// ],
// nextToken: "STRING_VALUE",
// };
Example Usage
DescribeJobQueuesCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
jobQueues | string[] | undefined | A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries. |
maxResults | number | undefined | The maximum number of results returned by |
nextToken | string | undefined | The 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. |
DescribeJobQueuesCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
jobQueues | JobQueueDetail[] | undefined | The list of job queues. |
nextToken | string | undefined | The |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
ClientException | client | These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid. |
ServerException | server | These errors are usually caused by a server issue. |
BatchServiceException | Base exception class for all service exceptions from Batch service. |