@aws-sdk/client-batch 3.855.0 → 3.856.0

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

@@ -0,0 +1,79 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
+import { TerminateServiceJobRequest, TerminateServiceJobResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link TerminateServiceJobCommand}.
+ */
+export interface TerminateServiceJobCommandInput extends TerminateServiceJobRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link TerminateServiceJobCommand}.
+ */
+export interface TerminateServiceJobCommandOutput extends TerminateServiceJobResponse, __MetadataBearer {
+}
+declare const TerminateServiceJobCommand_base: {
+    new (input: TerminateServiceJobCommandInput): import("@smithy/smithy-client").CommandImpl<TerminateServiceJobCommandInput, TerminateServiceJobCommandOutput, BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: TerminateServiceJobCommandInput): import("@smithy/smithy-client").CommandImpl<TerminateServiceJobCommandInput, TerminateServiceJobCommandOutput, BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Terminates a service job in a job queue. </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BatchClient, TerminateServiceJobCommand } from "@aws-sdk/client-batch"; // ES Modules import
+ * // const { BatchClient, TerminateServiceJobCommand } = require("@aws-sdk/client-batch"); // CommonJS import
+ * const client = new BatchClient(config);
+ * const input = { // TerminateServiceJobRequest
+ *   jobId: "STRING_VALUE", // required
+ *   reason: "STRING_VALUE", // required
+ * };
+ * const command = new TerminateServiceJobCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param TerminateServiceJobCommandInput - {@link TerminateServiceJobCommandInput}
+ * @returns {@link TerminateServiceJobCommandOutput}
+ * @see {@link TerminateServiceJobCommandInput} for command's `input` shape.
+ * @see {@link TerminateServiceJobCommandOutput} 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 TerminateServiceJobCommand extends TerminateServiceJobCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: TerminateServiceJobRequest;
+            output: {};
+        };
+        sdk: {
+            input: TerminateServiceJobCommandInput;
+            output: TerminateServiceJobCommandOutput;
+        };
+    };
+}

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

@@ -45,12 +45,18 @@ declare const UpdateJobQueueCommand_base: {
  *       computeEnvironment: "STRING_VALUE", // required
  *     },
  *   ],
+ *   serviceEnvironmentOrder: [ // ServiceEnvironmentOrders
+ *     { // ServiceEnvironmentOrder
+ *       order: Number("int"), // required
+ *       serviceEnvironment: "STRING_VALUE", // required
+ *     },
+ *   ],
  *   jobStateTimeLimitActions: [ // JobStateTimeLimitActions
  *     { // JobStateTimeLimitAction
  *       reason: "STRING_VALUE", // required
  *       state: "RUNNABLE", // required
  *       maxTimeSeconds: Number("int"), // required
- *       action: "CANCEL", // required
+ *       action: "CANCEL" || "TERMINATE", // required
  *     },
  *   ],
  * };

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

@@ -0,0 +1,88 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
+import { UpdateServiceEnvironmentRequest, UpdateServiceEnvironmentResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateServiceEnvironmentCommand}.
+ */
+export interface UpdateServiceEnvironmentCommandInput extends UpdateServiceEnvironmentRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateServiceEnvironmentCommand}.
+ */
+export interface UpdateServiceEnvironmentCommandOutput extends UpdateServiceEnvironmentResponse, __MetadataBearer {
+}
+declare const UpdateServiceEnvironmentCommand_base: {
+    new (input: UpdateServiceEnvironmentCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateServiceEnvironmentCommandInput, UpdateServiceEnvironmentCommandOutput, BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: UpdateServiceEnvironmentCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateServiceEnvironmentCommandInput, UpdateServiceEnvironmentCommandOutput, BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates a service environment. You can update the state of a service environment from <code>ENABLED</code> to <code>DISABLED</code> to prevent new service jobs from being placed in the service environment.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BatchClient, UpdateServiceEnvironmentCommand } from "@aws-sdk/client-batch"; // ES Modules import
+ * // const { BatchClient, UpdateServiceEnvironmentCommand } = require("@aws-sdk/client-batch"); // CommonJS import
+ * const client = new BatchClient(config);
+ * const input = { // UpdateServiceEnvironmentRequest
+ *   serviceEnvironment: "STRING_VALUE", // required
+ *   state: "ENABLED" || "DISABLED",
+ *   capacityLimits: [ // CapacityLimits
+ *     { // CapacityLimit
+ *       maxCapacity: Number("int"),
+ *       capacityUnit: "STRING_VALUE",
+ *     },
+ *   ],
+ * };
+ * const command = new UpdateServiceEnvironmentCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateServiceEnvironmentResponse
+ * //   serviceEnvironmentName: "STRING_VALUE", // required
+ * //   serviceEnvironmentArn: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateServiceEnvironmentCommandInput - {@link UpdateServiceEnvironmentCommandInput}
+ * @returns {@link UpdateServiceEnvironmentCommandOutput}
+ * @see {@link UpdateServiceEnvironmentCommandInput} for command's `input` shape.
+ * @see {@link UpdateServiceEnvironmentCommandOutput} 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 UpdateServiceEnvironmentCommand extends UpdateServiceEnvironmentCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateServiceEnvironmentRequest;
+            output: UpdateServiceEnvironmentResponse;
+        };
+        sdk: {
+            input: UpdateServiceEnvironmentCommandInput;
+            output: UpdateServiceEnvironmentCommandOutput;
+        };
+    };
+}

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

@@ -3,10 +3,12 @@ export * from "./CreateComputeEnvironmentCommand";
 export * from "./CreateConsumableResourceCommand";
 export * from "./CreateJobQueueCommand";
 export * from "./CreateSchedulingPolicyCommand";
+export * from "./CreateServiceEnvironmentCommand";
 export * from "./DeleteComputeEnvironmentCommand";
 export * from "./DeleteConsumableResourceCommand";
 export * from "./DeleteJobQueueCommand";
 export * from "./DeleteSchedulingPolicyCommand";
+export * from "./DeleteServiceEnvironmentCommand";
 export * from "./DeregisterJobDefinitionCommand";
 export * from "./DescribeComputeEnvironmentsCommand";
 export * from "./DescribeConsumableResourceCommand";
@@ -14,18 +16,24 @@ export * from "./DescribeJobDefinitionsCommand";
 export * from "./DescribeJobQueuesCommand";
 export * from "./DescribeJobsCommand";
 export * from "./DescribeSchedulingPoliciesCommand";
+export * from "./DescribeServiceEnvironmentsCommand";
+export * from "./DescribeServiceJobCommand";
 export * from "./GetJobQueueSnapshotCommand";
 export * from "./ListConsumableResourcesCommand";
 export * from "./ListJobsByConsumableResourceCommand";
 export * from "./ListJobsCommand";
 export * from "./ListSchedulingPoliciesCommand";
+export * from "./ListServiceJobsCommand";
 export * from "./ListTagsForResourceCommand";
 export * from "./RegisterJobDefinitionCommand";
 export * from "./SubmitJobCommand";
+export * from "./SubmitServiceJobCommand";
 export * from "./TagResourceCommand";
 export * from "./TerminateJobCommand";
+export * from "./TerminateServiceJobCommand";
 export * from "./UntagResourceCommand";
 export * from "./UpdateComputeEnvironmentCommand";
 export * from "./UpdateConsumableResourceCommand";
 export * from "./UpdateJobQueueCommand";
 export * from "./UpdateSchedulingPolicyCommand";
+export * from "./UpdateServiceEnvironmentCommand";