feat(client-batch): Add support for listing jobs by share identifier and getting snapshots of active capacity utilization by job queue and share.

Author: awstools

clients/client-batch/src/commands/DescribeServiceJobCommand.ts

@@ -53,6 +53,12 @@ export interface DescribeServiceJobCommandOutput extends DescribeServiceJobRespo
  * //       statusReason: "STRING_VALUE",
  * //     },
  * //   ],
+ * //   capacityUsage: [ // ServiceJobCapacityUsageDetailList
+ * //     { // ServiceJobCapacityUsageDetail
+ * //       capacityUnit: "STRING_VALUE",
+ * //       quantity: Number("double"),
+ * //     },
+ * //   ],
  * //   createdAt: Number("long"),
  * //   isTerminated: true || false,
  * //   jobArn: "STRING_VALUE",
@@ -74,6 +80,7 @@ export interface DescribeServiceJobCommandOutput extends DescribeServiceJobRespo
  * //       },
  * //     ],
  * //   },
+ * //   scheduledAt: Number("long"),
  * //   schedulingPriority: Number("int"),
  * //   serviceRequestPayload: "STRING_VALUE",
  * //   serviceJobType: "SAGEMAKER_TRAINING", // required

clients/client-batch/src/commands/GetJobQueueSnapshotCommand.ts

@@ -27,7 +27,8 @@ export interface GetJobQueueSnapshotCommandInput extends GetJobQueueSnapshotRequ
 export interface GetJobQueueSnapshotCommandOutput extends GetJobQueueSnapshotResponse, __MetadataBearer {}
 
 /**
- * <p>Provides a list of the first 100 <code>RUNNABLE</code> jobs associated to a single job queue.</p>
+ * <p>Provides a list of the first 100 <code>RUNNABLE</code> jobs associated to a single job
+ *       queue and includes capacity utilization, including total usage and breakdown by share for fairshare scheduling job queues. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -51,6 +52,29 @@ export interface GetJobQueueSnapshotCommandOutput extends GetJobQueueSnapshotRes
  * //     ],
  * //     lastUpdatedAt: Number("long"),
  * //   },
+ * //   queueUtilization: { // QueueSnapshotUtilizationDetail
+ * //     totalCapacityUsage: [ // QueueSnapshotCapacityUsageList
+ * //       { // QueueSnapshotCapacityUsage
+ * //         capacityUnit: "STRING_VALUE",
+ * //         quantity: Number("double"),
+ * //       },
+ * //     ],
+ * //     fairshareUtilization: { // FairshareUtilizationDetail
+ * //       activeShareCount: Number("long"),
+ * //       topCapacityUtilization: [ // FairshareCapacityUtilizationList
+ * //         { // FairshareCapacityUtilization
+ * //           shareIdentifier: "STRING_VALUE",
+ * //           capacityUsage: [ // FairshareCapacityUsageList
+ * //             { // FairshareCapacityUsage
+ * //               capacityUnit: "STRING_VALUE",
+ * //               quantity: Number("double"),
+ * //             },
+ * //           ],
+ * //         },
+ * //       ],
+ * //     },
+ * //     lastUpdatedAt: Number("long"),
+ * //   },
  * // };
  *
  * ```

clients/client-batch/src/commands/ListJobsCommand.ts

@@ -40,8 +40,6 @@ export interface ListJobsCommandOutput extends ListJobsResponse, __MetadataBeare
  *                <p>An array job ID to return a list of the children for that job</p>
  *             </li>
  *          </ul>
- *          <p>You can filter the results by job status with the <code>jobStatus</code> parameter. If you
- *       don't specify a status, only <code>RUNNING</code> jobs are returned.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -74,7 +72,15 @@ export interface ListJobsCommandOutput extends ListJobsResponse, __MetadataBeare
  * //       jobArn: "STRING_VALUE",
  * //       jobId: "STRING_VALUE", // required
  * //       jobName: "STRING_VALUE", // required
+ * //       capacityUsage: [ // JobCapacityUsageSummaryList
+ * //         { // JobCapacityUsageSummary
+ * //           capacityUnit: "STRING_VALUE",
+ * //           quantity: Number("double"),
+ * //         },
+ * //       ],
  * //       createdAt: Number("long"),
+ * //       scheduledAt: Number("long"),
+ * //       shareIdentifier: "STRING_VALUE",
  * //       status: "SUBMITTED" || "PENDING" || "RUNNABLE" || "STARTING" || "RUNNING" || "SUCCEEDED" || "FAILED",
  * //       statusReason: "STRING_VALUE",
  * //       startedAt: Number("long"),

clients/client-batch/src/commands/ListServiceJobsCommand.ts

@@ -61,10 +61,17 @@ export interface ListServiceJobsCommandOutput extends ListServiceJobsResponse, _
  * //           value: "STRING_VALUE", // required
  * //         },
  * //       },
+ * //       capacityUsage: [ // ServiceJobCapacityUsageSummaryList
+ * //         { // ServiceJobCapacityUsageSummary
+ * //           capacityUnit: "STRING_VALUE",
+ * //           quantity: Number("double"),
+ * //         },
+ * //       ],
  * //       createdAt: Number("long"),
  * //       jobArn: "STRING_VALUE",
  * //       jobId: "STRING_VALUE", // required
  * //       jobName: "STRING_VALUE", // required
+ * //       scheduledAt: Number("long"),
  * //       serviceJobType: "SAGEMAKER_TRAINING", // required
  * //       shareIdentifier: "STRING_VALUE",
  * //       status: "SUBMITTED" || "PENDING" || "RUNNABLE" || "SCHEDULED" || "STARTING" || "RUNNING" || "SUCCEEDED" || "FAILED",