@aws-sdk/client-batch 3.587.0 → 3.589.0

package/README.md

@@ -317,6 +317,14 @@ DescribeSchedulingPolicies
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/batch/command/DescribeSchedulingPoliciesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-batch/Interface/DescribeSchedulingPoliciesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-batch/Interface/DescribeSchedulingPoliciesCommandOutput/)
 
+</details>
+<details>
+<summary>
+GetJobQueueSnapshot
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/batch/command/GetJobQueueSnapshotCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-batch/Interface/GetJobQueueSnapshotCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-batch/Interface/GetJobQueueSnapshotCommandOutput/)
+
 </details>
 <details>
 <summary>

package/dist-cjs/index.js

@@ -49,6 +49,7 @@ __export(src_exports, {
   DeviceCgroupPermission: () => DeviceCgroupPermission,
   EFSAuthorizationConfigIAM: () => EFSAuthorizationConfigIAM,
   EFSTransitEncryption: () => EFSTransitEncryption,
+  GetJobQueueSnapshotCommand: () => GetJobQueueSnapshotCommand,
   JQState: () => JQState,
   JQStatus: () => JQStatus,
   JobDefinitionType: () => JobDefinitionType,
@@ -619,6 +620,21 @@ var se_DescribeSchedulingPoliciesCommand = /* @__PURE__ */ __name(async (input,
   b.m("POST").h(headers).b(body);
   return b.build();
 }, "se_DescribeSchedulingPoliciesCommand");
+var se_GetJobQueueSnapshotCommand = /* @__PURE__ */ __name(async (input, context) => {
+  const b = (0, import_core.requestBuilder)(input, context);
+  const headers = {
+    "content-type": "application/json"
+  };
+  b.bp("/v1/getjobqueuesnapshot");
+  let body;
+  body = JSON.stringify(
+    (0, import_smithy_client.take)(input, {
+      jobQueue: []
+    })
+  );
+  b.m("POST").h(headers).b(body);
+  return b.build();
+}, "se_GetJobQueueSnapshotCommand");
 var se_ListJobsCommand = /* @__PURE__ */ __name(async (input, context) => {
   const b = (0, import_core.requestBuilder)(input, context);
   const headers = {
@@ -993,6 +1009,20 @@ var de_DescribeSchedulingPoliciesCommand = /* @__PURE__ */ __name(async (output,
   Object.assign(contents, doc);
   return contents;
 }, "de_DescribeSchedulingPoliciesCommand");
+var de_GetJobQueueSnapshotCommand = /* @__PURE__ */ __name(async (output, context) => {
+  if (output.statusCode !== 200 && output.statusCode >= 300) {
+    return de_CommandError(output, context);
+  }
+  const contents = (0, import_smithy_client.map)({
+    $metadata: deserializeMetadata(output)
+  });
+  const data = (0, import_smithy_client.expectNonNull)((0, import_smithy_client.expectObject)(await (0, import_core2.parseJsonBody)(output.body, context)), "body");
+  const doc = (0, import_smithy_client.take)(data, {
+    frontOfQueue: import_smithy_client._json
+  });
+  Object.assign(contents, doc);
+  return contents;
+}, "de_GetJobQueueSnapshotCommand");
 var de_ListJobsCommand = /* @__PURE__ */ __name(async (output, context) => {
   if (output.statusCode !== 200 && output.statusCode >= 300) {
     return de_CommandError(output, context);
@@ -1555,6 +1585,23 @@ var _DescribeSchedulingPoliciesCommand = class _DescribeSchedulingPoliciesComman
 __name(_DescribeSchedulingPoliciesCommand, "DescribeSchedulingPoliciesCommand");
 var DescribeSchedulingPoliciesCommand = _DescribeSchedulingPoliciesCommand;
 
+// src/commands/GetJobQueueSnapshotCommand.ts
+
+
+
+
+var _GetJobQueueSnapshotCommand = class _GetJobQueueSnapshotCommand extends import_smithy_client.Command.classBuilder().ep({
+  ...commonParams
+}).m(function(Command, cs, config, o) {
+  return [
+    (0, import_middleware_serde.getSerdePlugin)(config, this.serialize, this.deserialize),
+    (0, import_middleware_endpoint.getEndpointPlugin)(config, Command.getEndpointParameterInstructions())
+  ];
+}).s("AWSBatchV20160810", "GetJobQueueSnapshot", {}).n("BatchClient", "GetJobQueueSnapshotCommand").f(void 0, void 0).ser(se_GetJobQueueSnapshotCommand).de(de_GetJobQueueSnapshotCommand).build() {
+};
+__name(_GetJobQueueSnapshotCommand, "GetJobQueueSnapshotCommand");
+var GetJobQueueSnapshotCommand = _GetJobQueueSnapshotCommand;
+
 // src/commands/ListJobsCommand.ts
 
 
@@ -1757,6 +1804,7 @@ var commands = {
   DescribeJobQueuesCommand,
   DescribeJobsCommand,
   DescribeSchedulingPoliciesCommand,
+  GetJobQueueSnapshotCommand,
   ListJobsCommand,
   ListSchedulingPoliciesCommand,
   ListTagsForResourceCommand,
@@ -1815,6 +1863,7 @@ var paginateListSchedulingPolicies = (0, import_core.createPaginator)(BatchClien
   DescribeJobQueuesCommand,
   DescribeJobsCommand,
   DescribeSchedulingPoliciesCommand,
+  GetJobQueueSnapshotCommand,
   ListJobsCommand,
   ListSchedulingPoliciesCommand,
   ListTagsForResourceCommand,

package/dist-es/Batch.js

@@ -13,6 +13,7 @@ import { DescribeJobDefinitionsCommand, } from "./commands/DescribeJobDefinition
 import { DescribeJobQueuesCommand, } from "./commands/DescribeJobQueuesCommand";
 import { DescribeJobsCommand, } from "./commands/DescribeJobsCommand";
 import { DescribeSchedulingPoliciesCommand, } from "./commands/DescribeSchedulingPoliciesCommand";
+import { GetJobQueueSnapshotCommand, } from "./commands/GetJobQueueSnapshotCommand";
 import { ListJobsCommand } from "./commands/ListJobsCommand";
 import { ListSchedulingPoliciesCommand, } from "./commands/ListSchedulingPoliciesCommand";
 import { ListTagsForResourceCommand, } from "./commands/ListTagsForResourceCommand";
@@ -38,6 +39,7 @@ const commands = {
     DescribeJobQueuesCommand,
     DescribeJobsCommand,
     DescribeSchedulingPoliciesCommand,
+    GetJobQueueSnapshotCommand,
     ListJobsCommand,
     ListSchedulingPoliciesCommand,
     ListTagsForResourceCommand,

package/dist-es/commands/GetJobQueueSnapshotCommand.js

@@ -0,0 +1,24 @@
+import { getEndpointPlugin } from "@smithy/middleware-endpoint";
+import { getSerdePlugin } from "@smithy/middleware-serde";
+import { Command as $Command } from "@smithy/smithy-client";
+import { commonParams } from "../endpoint/EndpointParameters";
+import { de_GetJobQueueSnapshotCommand, se_GetJobQueueSnapshotCommand } from "../protocols/Aws_restJson1";
+export { $Command };
+export class GetJobQueueSnapshotCommand extends $Command
+    .classBuilder()
+    .ep({
+    ...commonParams,
+})
+    .m(function (Command, cs, config, o) {
+    return [
+        getSerdePlugin(config, this.serialize, this.deserialize),
+        getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
+    ];
+})
+    .s("AWSBatchV20160810", "GetJobQueueSnapshot", {})
+    .n("BatchClient", "GetJobQueueSnapshotCommand")
+    .f(void 0, void 0)
+    .ser(se_GetJobQueueSnapshotCommand)
+    .de(de_GetJobQueueSnapshotCommand)
+    .build() {
+}

package/dist-es/commands/index.js

@@ -11,6 +11,7 @@ export * from "./DescribeJobDefinitionsCommand";
 export * from "./DescribeJobQueuesCommand";
 export * from "./DescribeJobsCommand";
 export * from "./DescribeSchedulingPoliciesCommand";
+export * from "./GetJobQueueSnapshotCommand";
 export * from "./ListJobsCommand";
 export * from "./ListSchedulingPoliciesCommand";
 export * from "./ListTagsForResourceCommand";

package/dist-es/protocols/Aws_restJson1.js

@@ -196,6 +196,19 @@ export const se_DescribeSchedulingPoliciesCommand = async (input, context) => {
     b.m("POST").h(headers).b(body);
     return b.build();
 };
+export const se_GetJobQueueSnapshotCommand = async (input, context) => {
+    const b = rb(input, context);
+    const headers = {
+        "content-type": "application/json",
+    };
+    b.bp("/v1/getjobqueuesnapshot");
+    let body;
+    body = JSON.stringify(take(input, {
+        jobQueue: [],
+    }));
+    b.m("POST").h(headers).b(body);
+    return b.build();
+};
 export const se_ListJobsCommand = async (input, context) => {
     const b = rb(input, context);
     const headers = {
@@ -552,6 +565,20 @@ export const de_DescribeSchedulingPoliciesCommand = async (output, context) => {
     Object.assign(contents, doc);
     return contents;
 };
+export const de_GetJobQueueSnapshotCommand = async (output, context) => {
+    if (output.statusCode !== 200 && output.statusCode >= 300) {
+        return de_CommandError(output, context);
+    }
+    const contents = map({
+        $metadata: deserializeMetadata(output),
+    });
+    const data = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
+    const doc = take(data, {
+        frontOfQueue: _json,
+    });
+    Object.assign(contents, doc);
+    return contents;
+};
 export const de_ListJobsCommand = async (output, context) => {
     if (output.statusCode !== 200 && output.statusCode >= 300) {
         return de_CommandError(output, context);

package/dist-types/Batch.d.ts

@@ -13,6 +13,7 @@ import { DescribeJobDefinitionsCommandInput, DescribeJobDefinitionsCommandOutput
 import { DescribeJobQueuesCommandInput, DescribeJobQueuesCommandOutput } from "./commands/DescribeJobQueuesCommand";
 import { DescribeJobsCommandInput, DescribeJobsCommandOutput } from "./commands/DescribeJobsCommand";
 import { DescribeSchedulingPoliciesCommandInput, DescribeSchedulingPoliciesCommandOutput } from "./commands/DescribeSchedulingPoliciesCommand";
+import { GetJobQueueSnapshotCommandInput, GetJobQueueSnapshotCommandOutput } from "./commands/GetJobQueueSnapshotCommand";
 import { ListJobsCommandInput, ListJobsCommandOutput } from "./commands/ListJobsCommand";
 import { ListSchedulingPoliciesCommandInput, ListSchedulingPoliciesCommandOutput } from "./commands/ListSchedulingPoliciesCommand";
 import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
@@ -106,6 +107,12 @@ export interface Batch {
     describeSchedulingPolicies(args: DescribeSchedulingPoliciesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeSchedulingPoliciesCommandOutput>;
     describeSchedulingPolicies(args: DescribeSchedulingPoliciesCommandInput, cb: (err: any, data?: DescribeSchedulingPoliciesCommandOutput) => void): void;
     describeSchedulingPolicies(args: DescribeSchedulingPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSchedulingPoliciesCommandOutput) => void): void;
+    /**
+     * @see {@link GetJobQueueSnapshotCommand}
+     */
+    getJobQueueSnapshot(args: GetJobQueueSnapshotCommandInput, options?: __HttpHandlerOptions): Promise<GetJobQueueSnapshotCommandOutput>;
+    getJobQueueSnapshot(args: GetJobQueueSnapshotCommandInput, cb: (err: any, data?: GetJobQueueSnapshotCommandOutput) => void): void;
+    getJobQueueSnapshot(args: GetJobQueueSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetJobQueueSnapshotCommandOutput) => void): void;
     /**
      * @see {@link ListJobsCommand}
      */

package/dist-types/BatchClient.d.ts

@@ -20,6 +20,7 @@ import { DescribeJobDefinitionsCommandInput, DescribeJobDefinitionsCommandOutput
 import { DescribeJobQueuesCommandInput, DescribeJobQueuesCommandOutput } from "./commands/DescribeJobQueuesCommand";
 import { DescribeJobsCommandInput, DescribeJobsCommandOutput } from "./commands/DescribeJobsCommand";
 import { DescribeSchedulingPoliciesCommandInput, DescribeSchedulingPoliciesCommandOutput } from "./commands/DescribeSchedulingPoliciesCommand";
+import { GetJobQueueSnapshotCommandInput, GetJobQueueSnapshotCommandOutput } from "./commands/GetJobQueueSnapshotCommand";
 import { ListJobsCommandInput, ListJobsCommandOutput } from "./commands/ListJobsCommand";
 import { ListSchedulingPoliciesCommandInput, ListSchedulingPoliciesCommandOutput } from "./commands/ListSchedulingPoliciesCommand";
 import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
@@ -37,11 +38,11 @@ export { __Client };
 /**
  * @public
  */
-export type ServiceInputTypes = CancelJobCommandInput | CreateComputeEnvironmentCommandInput | CreateJobQueueCommandInput | CreateSchedulingPolicyCommandInput | DeleteComputeEnvironmentCommandInput | DeleteJobQueueCommandInput | DeleteSchedulingPolicyCommandInput | DeregisterJobDefinitionCommandInput | DescribeComputeEnvironmentsCommandInput | DescribeJobDefinitionsCommandInput | DescribeJobQueuesCommandInput | DescribeJobsCommandInput | DescribeSchedulingPoliciesCommandInput | ListJobsCommandInput | ListSchedulingPoliciesCommandInput | ListTagsForResourceCommandInput | RegisterJobDefinitionCommandInput | SubmitJobCommandInput | TagResourceCommandInput | TerminateJobCommandInput | UntagResourceCommandInput | UpdateComputeEnvironmentCommandInput | UpdateJobQueueCommandInput | UpdateSchedulingPolicyCommandInput;
+export type ServiceInputTypes = CancelJobCommandInput | CreateComputeEnvironmentCommandInput | CreateJobQueueCommandInput | CreateSchedulingPolicyCommandInput | DeleteComputeEnvironmentCommandInput | DeleteJobQueueCommandInput | DeleteSchedulingPolicyCommandInput | DeregisterJobDefinitionCommandInput | DescribeComputeEnvironmentsCommandInput | DescribeJobDefinitionsCommandInput | DescribeJobQueuesCommandInput | DescribeJobsCommandInput | DescribeSchedulingPoliciesCommandInput | GetJobQueueSnapshotCommandInput | ListJobsCommandInput | ListSchedulingPoliciesCommandInput | ListTagsForResourceCommandInput | RegisterJobDefinitionCommandInput | SubmitJobCommandInput | TagResourceCommandInput | TerminateJobCommandInput | UntagResourceCommandInput | UpdateComputeEnvironmentCommandInput | UpdateJobQueueCommandInput | UpdateSchedulingPolicyCommandInput;
 /**
  * @public
  */
-export type ServiceOutputTypes = CancelJobCommandOutput | CreateComputeEnvironmentCommandOutput | CreateJobQueueCommandOutput | CreateSchedulingPolicyCommandOutput | DeleteComputeEnvironmentCommandOutput | DeleteJobQueueCommandOutput | DeleteSchedulingPolicyCommandOutput | DeregisterJobDefinitionCommandOutput | DescribeComputeEnvironmentsCommandOutput | DescribeJobDefinitionsCommandOutput | DescribeJobQueuesCommandOutput | DescribeJobsCommandOutput | DescribeSchedulingPoliciesCommandOutput | ListJobsCommandOutput | ListSchedulingPoliciesCommandOutput | ListTagsForResourceCommandOutput | RegisterJobDefinitionCommandOutput | SubmitJobCommandOutput | TagResourceCommandOutput | TerminateJobCommandOutput | UntagResourceCommandOutput | UpdateComputeEnvironmentCommandOutput | UpdateJobQueueCommandOutput | UpdateSchedulingPolicyCommandOutput;
+export type ServiceOutputTypes = CancelJobCommandOutput | CreateComputeEnvironmentCommandOutput | CreateJobQueueCommandOutput | CreateSchedulingPolicyCommandOutput | DeleteComputeEnvironmentCommandOutput | DeleteJobQueueCommandOutput | DeleteSchedulingPolicyCommandOutput | DeregisterJobDefinitionCommandOutput | DescribeComputeEnvironmentsCommandOutput | DescribeJobDefinitionsCommandOutput | DescribeJobQueuesCommandOutput | DescribeJobsCommandOutput | DescribeSchedulingPoliciesCommandOutput | GetJobQueueSnapshotCommandOutput | ListJobsCommandOutput | ListSchedulingPoliciesCommandOutput | ListTagsForResourceCommandOutput | RegisterJobDefinitionCommandOutput | SubmitJobCommandOutput | TagResourceCommandOutput | TerminateJobCommandOutput | UntagResourceCommandOutput | UpdateComputeEnvironmentCommandOutput | UpdateJobQueueCommandOutput | UpdateSchedulingPolicyCommandOutput;
 /**
  * @public
  */

package/dist-types/commands/GetJobQueueSnapshotCommand.d.ts

@@ -0,0 +1,75 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
+import { GetJobQueueSnapshotRequest, GetJobQueueSnapshotResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetJobQueueSnapshotCommand}.
+ */
+export interface GetJobQueueSnapshotCommandInput extends GetJobQueueSnapshotRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetJobQueueSnapshotCommand}.
+ */
+export interface GetJobQueueSnapshotCommandOutput extends GetJobQueueSnapshotResponse, __MetadataBearer {
+}
+declare const GetJobQueueSnapshotCommand_base: {
+    new (input: GetJobQueueSnapshotCommandInput): import("@smithy/smithy-client").CommandImpl<GetJobQueueSnapshotCommandInput, GetJobQueueSnapshotCommandOutput, BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: GetJobQueueSnapshotCommandInput): import("@smithy/smithy-client").CommandImpl<GetJobQueueSnapshotCommandInput, GetJobQueueSnapshotCommandOutput, BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Provides a list of the first 100 <code>RUNNABLE</code> jobs associated to a single job queue.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BatchClient, GetJobQueueSnapshotCommand } from "@aws-sdk/client-batch"; // ES Modules import
+ * // const { BatchClient, GetJobQueueSnapshotCommand } = require("@aws-sdk/client-batch"); // CommonJS import
+ * const client = new BatchClient(config);
+ * const input = { // GetJobQueueSnapshotRequest
+ *   jobQueue: "STRING_VALUE", // required
+ * };
+ * const command = new GetJobQueueSnapshotCommand(input);
+ * const response = await client.send(command);
+ * // { // GetJobQueueSnapshotResponse
+ * //   frontOfQueue: { // FrontOfQueueDetail
+ * //     jobs: [ // FrontOfQueueJobSummaryList
+ * //       { // FrontOfQueueJobSummary
+ * //         jobArn: "STRING_VALUE",
+ * //         earliestTimeAtPosition: Number("long"),
+ * //       },
+ * //     ],
+ * //     lastUpdatedAt: Number("long"),
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetJobQueueSnapshotCommandInput - {@link GetJobQueueSnapshotCommandInput}
+ * @returns {@link GetJobQueueSnapshotCommandOutput}
+ * @see {@link GetJobQueueSnapshotCommandInput} for command's `input` shape.
+ * @see {@link GetJobQueueSnapshotCommandOutput} for command's `response` shape.
+ * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
+ *
+ * @throws {@link ClientException} (client fault)
+ *  <p>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.</p>
+ *
+ * @throws {@link ServerException} (server fault)
+ *  <p>These errors are usually caused by a server issue.</p>
+ *
+ * @throws {@link BatchServiceException}
+ * <p>Base exception class for all service exceptions from Batch service.</p>
+ *
+ * @public
+ */
+export declare class GetJobQueueSnapshotCommand extends GetJobQueueSnapshotCommand_base {
+}

package/dist-types/commands/index.d.ts

@@ -11,6 +11,7 @@ export * from "./DescribeJobDefinitionsCommand";
 export * from "./DescribeJobQueuesCommand";
 export * from "./DescribeJobsCommand";
 export * from "./DescribeSchedulingPoliciesCommand";
+export * from "./GetJobQueueSnapshotCommand";
 export * from "./ListJobsCommand";
 export * from "./ListSchedulingPoliciesCommand";
 export * from "./ListTagsForResourceCommand";

package/dist-types/models/models_0.d.ts

@@ -5124,6 +5124,58 @@ export interface DescribeSchedulingPoliciesResponse {
      */
     schedulingPolicies?: SchedulingPolicyDetail[];
 }
+/**
+ * @public
+ */
+export interface GetJobQueueSnapshotRequest {
+    /**
+     * <p>The job queue’s name or full queue Amazon Resource Name (ARN).</p>
+     * @public
+     */
+    jobQueue: string | undefined;
+}
+/**
+ * <p>An object that represents summary details for the first 100 <code>RUNNABLE</code> jobs in a job queue.</p>
+ * @public
+ */
+export interface FrontOfQueueJobSummary {
+    /**
+     * <p>The ARN for a job in a named job queue.</p>
+     * @public
+     */
+    jobArn?: string;
+    /**
+     * <p>The Unix timestamp (in milliseconds) for when the job transitioned to its current position in the job queue.</p>
+     * @public
+     */
+    earliestTimeAtPosition?: number;
+}
+/**
+ * <p>Contains a list of the first 100 <code>RUNNABLE</code> jobs associated to a single job queue.</p>
+ * @public
+ */
+export interface FrontOfQueueDetail {
+    /**
+     * <p>The Amazon Resource Names (ARNs) of the first 100 <code>RUNNABLE</code> jobs in a named job queue. For first-in-first-out (FIFO) job queues, jobs are ordered based on their submission time. For fair share scheduling (FSS) job queues, jobs are ordered based on their job priority and share usage.</p>
+     * @public
+     */
+    jobs?: FrontOfQueueJobSummary[];
+    /**
+     * <p>The Unix timestamp (in milliseconds) for when each of the first 100 <code>RUNNABLE</code> jobs were last updated. </p>
+     * @public
+     */
+    lastUpdatedAt?: number;
+}
+/**
+ * @public
+ */
+export interface GetJobQueueSnapshotResponse {
+    /**
+     * <p>The list of the first 100 <code>RUNNABLE</code> jobs in each job queue. For first-in-first-out (FIFO) job queues, jobs are ordered based on their submission time. For fair share scheduling (FSS) job queues, jobs are ordered based on their job priority and share usage.</p>
+     * @public
+     */
+    frontOfQueue?: FrontOfQueueDetail;
+}
 /**
  * <p>A filter name and value pair that's used to return a more specific list of results from a
  *     <code>ListJobs</code> API operation.</p>
@@ -5172,13 +5224,23 @@ export interface ListJobsRequest {
      */
     jobStatus?: JobStatus;
     /**
-     * <p>The maximum number of results returned by <code>ListJobs</code> in paginated output. When
-     *       this parameter is used, <code>ListJobs</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>ListJobs</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>ListJobs</code> returns up to
-     *       100 results and a <code>nextToken</code> value if applicable.</p>
+     * <p>The maximum number of results returned by <code>ListJobs</code> in a paginated output. When this parameter is used, <code>ListJobs</code> returns up to <code>maxResults</code> results in a single page and a <code>nextToken</code> response element, if applicable. The remaining results of the initial request can be seen by sending another <code>ListJobs</code> request with the returned <code>nextToken</code> value.</p>
+     *          <p>The following outlines key parameters and limitations:</p>
+     *          <ul>
+     *             <li>
+     *                <p>The minimum value is 1. </p>
+     *             </li>
+     *             <li>
+     *                <p>When <code>--job-status</code> is used, Batch returns up to 1000 values. </p>
+     *             </li>
+     *             <li>
+     *                <p>When <code>--filters</code> is used, Batch returns up to 100 values.</p>
+     *             </li>
+     *             <li>
+     *                <p>If neither parameter is used, then <code>ListJobs</code> returns up to
+     *       1000 results (jobs that are in the <code>RUNNING</code> status) and a <code>nextToken</code> value, if applicable.</p>
+     *             </li>
+     *          </ul>
      * @public
      */
     maxResults?: number;

package/dist-types/protocols/Aws_restJson1.d.ts

@@ -13,6 +13,7 @@ import { DescribeJobDefinitionsCommandInput, DescribeJobDefinitionsCommandOutput
 import { DescribeJobQueuesCommandInput, DescribeJobQueuesCommandOutput } from "../commands/DescribeJobQueuesCommand";
 import { DescribeJobsCommandInput, DescribeJobsCommandOutput } from "../commands/DescribeJobsCommand";
 import { DescribeSchedulingPoliciesCommandInput, DescribeSchedulingPoliciesCommandOutput } from "../commands/DescribeSchedulingPoliciesCommand";
+import { GetJobQueueSnapshotCommandInput, GetJobQueueSnapshotCommandOutput } from "../commands/GetJobQueueSnapshotCommand";
 import { ListJobsCommandInput, ListJobsCommandOutput } from "../commands/ListJobsCommand";
 import { ListSchedulingPoliciesCommandInput, ListSchedulingPoliciesCommandOutput } from "../commands/ListSchedulingPoliciesCommand";
 import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "../commands/ListTagsForResourceCommand";
@@ -76,6 +77,10 @@ export declare const se_DescribeJobsCommand: (input: DescribeJobsCommandInput, c
  * serializeAws_restJson1DescribeSchedulingPoliciesCommand
  */
 export declare const se_DescribeSchedulingPoliciesCommand: (input: DescribeSchedulingPoliciesCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1GetJobQueueSnapshotCommand
+ */
+export declare const se_GetJobQueueSnapshotCommand: (input: GetJobQueueSnapshotCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
 /**
  * serializeAws_restJson1ListJobsCommand
  */
@@ -172,6 +177,10 @@ export declare const de_DescribeJobsCommand: (output: __HttpResponse, context: _
  * deserializeAws_restJson1DescribeSchedulingPoliciesCommand
  */
 export declare const de_DescribeSchedulingPoliciesCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DescribeSchedulingPoliciesCommandOutput>;
+/**
+ * deserializeAws_restJson1GetJobQueueSnapshotCommand
+ */
+export declare const de_GetJobQueueSnapshotCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetJobQueueSnapshotCommandOutput>;
 /**
  * deserializeAws_restJson1ListJobsCommand
  */

package/dist-types/ts3.4/Batch.d.ts

@@ -52,6 +52,10 @@ import {
   DescribeSchedulingPoliciesCommandInput,
   DescribeSchedulingPoliciesCommandOutput,
 } from "./commands/DescribeSchedulingPoliciesCommand";
+import {
+  GetJobQueueSnapshotCommandInput,
+  GetJobQueueSnapshotCommandOutput,
+} from "./commands/GetJobQueueSnapshotCommand";
 import {
   ListJobsCommandInput,
   ListJobsCommandOutput,
@@ -269,6 +273,19 @@ export interface Batch {
     options: __HttpHandlerOptions,
     cb: (err: any, data?: DescribeSchedulingPoliciesCommandOutput) => void
   ): void;
+  getJobQueueSnapshot(
+    args: GetJobQueueSnapshotCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<GetJobQueueSnapshotCommandOutput>;
+  getJobQueueSnapshot(
+    args: GetJobQueueSnapshotCommandInput,
+    cb: (err: any, data?: GetJobQueueSnapshotCommandOutput) => void
+  ): void;
+  getJobQueueSnapshot(
+    args: GetJobQueueSnapshotCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: GetJobQueueSnapshotCommandOutput) => void
+  ): void;
   listJobs(): Promise<ListJobsCommandOutput>;
   listJobs(
     args: ListJobsCommandInput,

package/dist-types/ts3.4/BatchClient.d.ts

@@ -97,6 +97,10 @@ import {
   DescribeSchedulingPoliciesCommandInput,
   DescribeSchedulingPoliciesCommandOutput,
 } from "./commands/DescribeSchedulingPoliciesCommand";
+import {
+  GetJobQueueSnapshotCommandInput,
+  GetJobQueueSnapshotCommandOutput,
+} from "./commands/GetJobQueueSnapshotCommand";
 import {
   ListJobsCommandInput,
   ListJobsCommandOutput,
@@ -162,6 +166,7 @@ export type ServiceInputTypes =
   | DescribeJobQueuesCommandInput
   | DescribeJobsCommandInput
   | DescribeSchedulingPoliciesCommandInput
+  | GetJobQueueSnapshotCommandInput
   | ListJobsCommandInput
   | ListSchedulingPoliciesCommandInput
   | ListTagsForResourceCommandInput
@@ -187,6 +192,7 @@ export type ServiceOutputTypes =
   | DescribeJobQueuesCommandOutput
   | DescribeJobsCommandOutput
   | DescribeSchedulingPoliciesCommandOutput
+  | GetJobQueueSnapshotCommandOutput
   | ListJobsCommandOutput
   | ListSchedulingPoliciesCommandOutput
   | ListTagsForResourceCommandOutput

package/dist-types/ts3.4/commands/GetJobQueueSnapshotCommand.d.ts

@@ -0,0 +1,39 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import {
+  BatchClientResolvedConfig,
+  ServiceInputTypes,
+  ServiceOutputTypes,
+} from "../BatchClient";
+import {
+  GetJobQueueSnapshotRequest,
+  GetJobQueueSnapshotResponse,
+} from "../models/models_0";
+export { __MetadataBearer, $Command };
+export interface GetJobQueueSnapshotCommandInput
+  extends GetJobQueueSnapshotRequest {}
+export interface GetJobQueueSnapshotCommandOutput
+  extends GetJobQueueSnapshotResponse,
+    __MetadataBearer {}
+declare const GetJobQueueSnapshotCommand_base: {
+  new (
+    input: GetJobQueueSnapshotCommandInput
+  ): import("@smithy/smithy-client").CommandImpl<
+    GetJobQueueSnapshotCommandInput,
+    GetJobQueueSnapshotCommandOutput,
+    BatchClientResolvedConfig,
+    ServiceInputTypes,
+    ServiceOutputTypes
+  >;
+  new (
+    __0_0: GetJobQueueSnapshotCommandInput
+  ): import("@smithy/smithy-client").CommandImpl<
+    GetJobQueueSnapshotCommandInput,
+    GetJobQueueSnapshotCommandOutput,
+    BatchClientResolvedConfig,
+    ServiceInputTypes,
+    ServiceOutputTypes
+  >;
+  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+export declare class GetJobQueueSnapshotCommand extends GetJobQueueSnapshotCommand_base {}

package/dist-types/ts3.4/commands/index.d.ts

@@ -11,6 +11,7 @@ export * from "./DescribeJobDefinitionsCommand";
 export * from "./DescribeJobQueuesCommand";
 export * from "./DescribeJobsCommand";
 export * from "./DescribeSchedulingPoliciesCommand";
+export * from "./GetJobQueueSnapshotCommand";
 export * from "./ListJobsCommand";
 export * from "./ListSchedulingPoliciesCommand";
 export * from "./ListTagsForResourceCommand";

package/dist-types/ts3.4/models/models_0.d.ts

@@ -781,6 +781,20 @@ export interface SchedulingPolicyDetail {
 export interface DescribeSchedulingPoliciesResponse {
   schedulingPolicies?: SchedulingPolicyDetail[];
 }
+export interface GetJobQueueSnapshotRequest {
+  jobQueue: string | undefined;
+}
+export interface FrontOfQueueJobSummary {
+  jobArn?: string;
+  earliestTimeAtPosition?: number;
+}
+export interface FrontOfQueueDetail {
+  jobs?: FrontOfQueueJobSummary[];
+  lastUpdatedAt?: number;
+}
+export interface GetJobQueueSnapshotResponse {
+  frontOfQueue?: FrontOfQueueDetail;
+}
 export interface KeyValuesPair {
   name?: string;
   values?: string[];

package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts

@@ -55,6 +55,10 @@ import {
   DescribeSchedulingPoliciesCommandInput,
   DescribeSchedulingPoliciesCommandOutput,
 } from "../commands/DescribeSchedulingPoliciesCommand";
+import {
+  GetJobQueueSnapshotCommandInput,
+  GetJobQueueSnapshotCommandOutput,
+} from "../commands/GetJobQueueSnapshotCommand";
 import {
   ListJobsCommandInput,
   ListJobsCommandOutput,
@@ -151,6 +155,10 @@ export declare const se_DescribeSchedulingPoliciesCommand: (
   input: DescribeSchedulingPoliciesCommandInput,
   context: __SerdeContext
 ) => Promise<__HttpRequest>;
+export declare const se_GetJobQueueSnapshotCommand: (
+  input: GetJobQueueSnapshotCommandInput,
+  context: __SerdeContext
+) => Promise<__HttpRequest>;
 export declare const se_ListJobsCommand: (
   input: ListJobsCommandInput,
   context: __SerdeContext
@@ -247,6 +255,10 @@ export declare const de_DescribeSchedulingPoliciesCommand: (
   output: __HttpResponse,
   context: __SerdeContext
 ) => Promise<DescribeSchedulingPoliciesCommandOutput>;
+export declare const de_GetJobQueueSnapshotCommand: (
+  output: __HttpResponse,
+  context: __SerdeContext
+) => Promise<GetJobQueueSnapshotCommandOutput>;
 export declare const de_ListJobsCommand: (
   output: __HttpResponse,
   context: __SerdeContext

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-batch",
   "description": "AWS SDK for JavaScript Batch Client for Node.js, Browser and React Native",
-  "version": "3.587.0",
+  "version": "3.589.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-batch",
@@ -20,10 +20,10 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sso-oidc": "3.587.0",
-    "@aws-sdk/client-sts": "3.587.0",
-    "@aws-sdk/core": "3.587.0",
-    "@aws-sdk/credential-provider-node": "3.587.0",
+    "@aws-sdk/client-sso-oidc": "3.588.0",
+    "@aws-sdk/client-sts": "3.588.0",
+    "@aws-sdk/core": "3.588.0",
+    "@aws-sdk/credential-provider-node": "3.588.0",
     "@aws-sdk/middleware-host-header": "3.577.0",
     "@aws-sdk/middleware-logger": "3.577.0",
     "@aws-sdk/middleware-recursion-detection": "3.577.0",