@aws-sdk/client-batch 3.751.0 → 3.758.0

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

@@ -0,0 +1,129 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
+import { ListConsumableResourcesRequest, ListConsumableResourcesResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListConsumableResourcesCommand}.
+ */
+export interface ListConsumableResourcesCommandInput extends ListConsumableResourcesRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListConsumableResourcesCommand}.
+ */
+export interface ListConsumableResourcesCommandOutput extends ListConsumableResourcesResponse, __MetadataBearer {
+}
+declare const ListConsumableResourcesCommand_base: {
+    new (input: ListConsumableResourcesCommandInput): import("@smithy/smithy-client").CommandImpl<ListConsumableResourcesCommandInput, ListConsumableResourcesCommandOutput, BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [ListConsumableResourcesCommandInput]): import("@smithy/smithy-client").CommandImpl<ListConsumableResourcesCommandInput, ListConsumableResourcesCommandOutput, BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Returns a list of Batch consumable resources.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BatchClient, ListConsumableResourcesCommand } from "@aws-sdk/client-batch"; // ES Modules import
+ * // const { BatchClient, ListConsumableResourcesCommand } = require("@aws-sdk/client-batch"); // CommonJS import
+ * const client = new BatchClient(config);
+ * const input = { // ListConsumableResourcesRequest
+ *   filters: [ // ListConsumableResourcesFilterList
+ *     { // KeyValuesPair
+ *       name: "STRING_VALUE",
+ *       values: [ // StringList
+ *         "STRING_VALUE",
+ *       ],
+ *     },
+ *   ],
+ *   maxResults: Number("int"),
+ *   nextToken: "STRING_VALUE",
+ * };
+ * const command = new ListConsumableResourcesCommand(input);
+ * const response = await client.send(command);
+ * // { // ListConsumableResourcesResponse
+ * //   consumableResources: [ // ConsumableResourceSummaryList // required
+ * //     { // ConsumableResourceSummary
+ * //       consumableResourceArn: "STRING_VALUE", // required
+ * //       consumableResourceName: "STRING_VALUE", // required
+ * //       totalQuantity: Number("long"),
+ * //       inUseQuantity: Number("long"),
+ * //       resourceType: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListConsumableResourcesCommandInput - {@link ListConsumableResourcesCommandInput}
+ * @returns {@link ListConsumableResourcesCommandOutput}
+ * @see {@link ListConsumableResourcesCommandInput} for command's `input` shape.
+ * @see {@link ListConsumableResourcesCommandOutput} 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
+ * @example To get a list of a consumable resources
+ * ```javascript
+ * // Returns a list of the consumable resources for your account.
+ * const input = {
+ *   "filters": [
+ *     {
+ *       "name": "CONSUMABLE_RESOURCE_NAME",
+ *       "values": [
+ *         "my*"
+ *       ]
+ *     }
+ *   ],
+ *   "maxResults": 123
+ * };
+ * const command = new ListConsumableResourcesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "consumableResources": [
+ *     {
+ *       "consumableResourceArn": "arn:aws:batch:us-east-1:012345678910:consumable-resource/myConsumableResource",
+ *       "consumableResourceName": "myConsumableResource",
+ *       "inUseQuantity": 12,
+ *       "resourceType": "REPLENISHABLE",
+ *       "totalQuantity": 123
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-get-a-list-of-a-consumable-resources-1739496071960
+ * ```
+ *
+ */
+export declare class ListConsumableResourcesCommand extends ListConsumableResourcesCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListConsumableResourcesRequest;
+            output: ListConsumableResourcesResponse;
+        };
+        sdk: {
+            input: ListConsumableResourcesCommandInput;
+            output: ListConsumableResourcesCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,154 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
+import { ListJobsByConsumableResourceRequest, ListJobsByConsumableResourceResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListJobsByConsumableResourceCommand}.
+ */
+export interface ListJobsByConsumableResourceCommandInput extends ListJobsByConsumableResourceRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListJobsByConsumableResourceCommand}.
+ */
+export interface ListJobsByConsumableResourceCommandOutput extends ListJobsByConsumableResourceResponse, __MetadataBearer {
+}
+declare const ListJobsByConsumableResourceCommand_base: {
+    new (input: ListJobsByConsumableResourceCommandInput): import("@smithy/smithy-client").CommandImpl<ListJobsByConsumableResourceCommandInput, ListJobsByConsumableResourceCommandOutput, BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: ListJobsByConsumableResourceCommandInput): import("@smithy/smithy-client").CommandImpl<ListJobsByConsumableResourceCommandInput, ListJobsByConsumableResourceCommandOutput, BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Returns a list of Batch jobs that require a specific consumable resource.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BatchClient, ListJobsByConsumableResourceCommand } from "@aws-sdk/client-batch"; // ES Modules import
+ * // const { BatchClient, ListJobsByConsumableResourceCommand } = require("@aws-sdk/client-batch"); // CommonJS import
+ * const client = new BatchClient(config);
+ * const input = { // ListJobsByConsumableResourceRequest
+ *   consumableResource: "STRING_VALUE", // required
+ *   filters: [ // ListJobsByConsumableResourceFilterList
+ *     { // KeyValuesPair
+ *       name: "STRING_VALUE",
+ *       values: [ // StringList
+ *         "STRING_VALUE",
+ *       ],
+ *     },
+ *   ],
+ *   maxResults: Number("int"),
+ *   nextToken: "STRING_VALUE",
+ * };
+ * const command = new ListJobsByConsumableResourceCommand(input);
+ * const response = await client.send(command);
+ * // { // ListJobsByConsumableResourceResponse
+ * //   jobs: [ // ListJobsByConsumableResourceSummaryList // required
+ * //     { // ListJobsByConsumableResourceSummary
+ * //       jobArn: "STRING_VALUE", // required
+ * //       jobQueueArn: "STRING_VALUE", // required
+ * //       jobName: "STRING_VALUE", // required
+ * //       jobDefinitionArn: "STRING_VALUE",
+ * //       shareIdentifier: "STRING_VALUE",
+ * //       jobStatus: "STRING_VALUE", // required
+ * //       quantity: Number("long"), // required
+ * //       statusReason: "STRING_VALUE",
+ * //       startedAt: Number("long"),
+ * //       createdAt: Number("long"), // required
+ * //       consumableResourceProperties: { // ConsumableResourceProperties
+ * //         consumableResourceList: [ // ConsumableResourceList
+ * //           { // ConsumableResourceRequirement
+ * //             consumableResource: "STRING_VALUE",
+ * //             quantity: Number("long"),
+ * //           },
+ * //         ],
+ * //       },
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListJobsByConsumableResourceCommandInput - {@link ListJobsByConsumableResourceCommandInput}
+ * @returns {@link ListJobsByConsumableResourceCommandOutput}
+ * @see {@link ListJobsByConsumableResourceCommandInput} for command's `input` shape.
+ * @see {@link ListJobsByConsumableResourceCommandOutput} 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
+ * @example To get a list of Batch jobs by consumable resource
+ * ```javascript
+ * // Returns a list of Batch jobs that require a specific consumable resource.
+ * const input = {
+ *   "consumableResource": "myConsumableResource",
+ *   "filters": [
+ *     {
+ *       "name": "CONSUMABLE_RESOURCE_NAME",
+ *       "values": [
+ *         "my*"
+ *       ]
+ *     }
+ *   ],
+ *   "maxResults": 123
+ * };
+ * const command = new ListJobsByConsumableResourceCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "jobs": [
+ *     {
+ *       "consumableResourceProperties": {
+ *         "consumableResourceList": [
+ *           {
+ *             "consumableResource": "myConsumableResource",
+ *             "quantity": 123
+ *           }
+ *         ]
+ *       },
+ *       "createdAt": 1480460782010,
+ *       "jobArn": "arn:aws:batch:us-east-1:012345678910:job/myJob",
+ *       "jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/myJobDef",
+ *       "jobName": "myJob",
+ *       "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/myJobQueue",
+ *       "jobStatus": "PENDING",
+ *       "quantity": 123
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-get-a-list-of-batch-jobs-by-consumable-resource-1739496640347
+ * ```
+ *
+ */
+export declare class ListJobsByConsumableResourceCommand extends ListJobsByConsumableResourceCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListJobsByConsumableResourceRequest;
+            output: ListJobsByConsumableResourceResponse;
+        };
+        sdk: {
+            input: ListJobsByConsumableResourceCommandInput;
+            output: ListJobsByConsumableResourceCommandOutput;
+        };
+    };
+}

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

@@ -428,6 +428,14 @@ declare const RegisterJobDefinitionCommand_base: {
  *             shareProcessNamespace: true || false,
  *           },
  *         },
+ *         consumableResourceProperties: { // ConsumableResourceProperties
+ *           consumableResourceList: [ // ConsumableResourceList
+ *             { // ConsumableResourceRequirement
+ *               consumableResource: "STRING_VALUE",
+ *               quantity: Number("long"),
+ *             },
+ *           ],
+ *         },
  *       },
  *     ],
  *   },
@@ -612,6 +620,14 @@ declare const RegisterJobDefinitionCommand_base: {
  *       },
  *     ],
  *   },
+ *   consumableResourceProperties: {
+ *     consumableResourceList: [
+ *       {
+ *         consumableResource: "STRING_VALUE",
+ *         quantity: Number("long"),
+ *       },
+ *     ],
+ *   },
  * };
  * const command = new RegisterJobDefinitionCommand(input);
  * const response = await client.send(command);

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

@@ -34,7 +34,7 @@ declare const SubmitJobCommand_base: {
  *       parameters in a <code>resourceRequirements</code> object that's included in the
  *         <code>containerOverrides</code> parameter.</p>
  *          <note>
- *             <p>Job queues with a scheduling policy are limited to 500 active share identifiers at
+ *             <p>Job queues with a scheduling policy are limited to 500 active fair share identifiers at
  *         a time. </p>
  *          </note>
  *          <important>
@@ -183,6 +183,14 @@ declare const SubmitJobCommand_base: {
  *             },
  *           },
  *         },
+ *         consumableResourcePropertiesOverride: { // ConsumableResourceProperties
+ *           consumableResourceList: [ // ConsumableResourceList
+ *             { // ConsumableResourceRequirement
+ *               consumableResource: "STRING_VALUE",
+ *               quantity: Number("long"),
+ *             },
+ *           ],
+ *         },
  *       },
  *     ],
  *   },
@@ -275,6 +283,14 @@ declare const SubmitJobCommand_base: {
  *       },
  *     ],
  *   },
+ *   consumableResourcePropertiesOverride: {
+ *     consumableResourceList: [
+ *       {
+ *         consumableResource: "STRING_VALUE",
+ *         quantity: Number("long"),
+ *       },
+ *     ],
+ *   },
  * };
  * const command = new SubmitJobCommand(input);
  * const response = await client.send(command);

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

@@ -0,0 +1,104 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
+import { UpdateConsumableResourceRequest, UpdateConsumableResourceResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateConsumableResourceCommand}.
+ */
+export interface UpdateConsumableResourceCommandInput extends UpdateConsumableResourceRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateConsumableResourceCommand}.
+ */
+export interface UpdateConsumableResourceCommandOutput extends UpdateConsumableResourceResponse, __MetadataBearer {
+}
+declare const UpdateConsumableResourceCommand_base: {
+    new (input: UpdateConsumableResourceCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateConsumableResourceCommandInput, UpdateConsumableResourceCommandOutput, BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdateConsumableResourceCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateConsumableResourceCommandInput, UpdateConsumableResourceCommandOutput, BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates a consumable resource.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BatchClient, UpdateConsumableResourceCommand } from "@aws-sdk/client-batch"; // ES Modules import
+ * // const { BatchClient, UpdateConsumableResourceCommand } = require("@aws-sdk/client-batch"); // CommonJS import
+ * const client = new BatchClient(config);
+ * const input = { // UpdateConsumableResourceRequest
+ *   consumableResource: "STRING_VALUE", // required
+ *   operation: "STRING_VALUE",
+ *   quantity: Number("long"),
+ *   clientToken: "STRING_VALUE",
+ * };
+ * const command = new UpdateConsumableResourceCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateConsumableResourceResponse
+ * //   consumableResourceName: "STRING_VALUE", // required
+ * //   consumableResourceArn: "STRING_VALUE", // required
+ * //   totalQuantity: Number("long"),
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateConsumableResourceCommandInput - {@link UpdateConsumableResourceCommandInput}
+ * @returns {@link UpdateConsumableResourceCommandOutput}
+ * @see {@link UpdateConsumableResourceCommandInput} for command's `input` shape.
+ * @see {@link UpdateConsumableResourceCommandOutput} 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
+ * @example To update a consumable resource
+ * ```javascript
+ * // Updates a consumable resource.
+ * const input = {
+ *   "consumableResource": "myConsumableResource",
+ *   "operation": "ADD",
+ *   "quantity": 12
+ * };
+ * const command = new UpdateConsumableResourceCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "consumableResourceArn": "arn:aws:batch:us-east-1:012345678910:consumable-resource/myConsumableResource",
+ *   "consumableResourceName": "myConsumableResource",
+ *   "totalQuantity": 135
+ * }
+ * *\/
+ * // example id: to-update-a-consumable-resource-1739497761692
+ * ```
+ *
+ */
+export declare class UpdateConsumableResourceCommand extends UpdateConsumableResourceCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateConsumableResourceRequest;
+            output: UpdateConsumableResourceResponse;
+        };
+        sdk: {
+            input: UpdateConsumableResourceCommandInput;
+            output: UpdateConsumableResourceCommandOutput;
+        };
+    };
+}

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

@@ -1,17 +1,22 @@
 export * from "./CancelJobCommand";
 export * from "./CreateComputeEnvironmentCommand";
+export * from "./CreateConsumableResourceCommand";
 export * from "./CreateJobQueueCommand";
 export * from "./CreateSchedulingPolicyCommand";
 export * from "./DeleteComputeEnvironmentCommand";
+export * from "./DeleteConsumableResourceCommand";
 export * from "./DeleteJobQueueCommand";
 export * from "./DeleteSchedulingPolicyCommand";
 export * from "./DeregisterJobDefinitionCommand";
 export * from "./DescribeComputeEnvironmentsCommand";
+export * from "./DescribeConsumableResourceCommand";
 export * from "./DescribeJobDefinitionsCommand";
 export * from "./DescribeJobQueuesCommand";
 export * from "./DescribeJobsCommand";
 export * from "./DescribeSchedulingPoliciesCommand";
 export * from "./GetJobQueueSnapshotCommand";
+export * from "./ListConsumableResourcesCommand";
+export * from "./ListJobsByConsumableResourceCommand";
 export * from "./ListJobsCommand";
 export * from "./ListSchedulingPoliciesCommand";
 export * from "./ListTagsForResourceCommand";
@@ -21,5 +26,6 @@ export * from "./TagResourceCommand";
 export * from "./TerminateJobCommand";
 export * from "./UntagResourceCommand";
 export * from "./UpdateComputeEnvironmentCommand";
+export * from "./UpdateConsumableResourceCommand";
 export * from "./UpdateJobQueueCommand";
 export * from "./UpdateSchedulingPolicyCommand";