feat(client-emr): Add support for customers to modify cluster attribute auto-terminate post cluster launch

awstools · awstools · commit 7a3e95b38ef9 · 2023-12-27T19:13:01.000Z
diff --git a/clients/client-emr/README.md b/clients/client-emr/README.md
@@ -580,6 +580,14 @@ RunJobFlow
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/emr/command/RunJobFlowCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-emr/Interface/RunJobFlowCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-emr/Interface/RunJobFlowCommandOutput/)
 
+</details>
+<details>
+<summary>
+SetKeepJobFlowAliveWhenNoSteps
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/emr/command/SetKeepJobFlowAliveWhenNoStepsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-emr/Interface/SetKeepJobFlowAliveWhenNoStepsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-emr/Interface/SetKeepJobFlowAliveWhenNoStepsCommandOutput/)
+
 </details>
 <details>
 <summary>
diff --git a/clients/client-emr/src/EMR.ts b/clients/client-emr/src/EMR.ts
@@ -213,6 +213,11 @@ import {
 } from "./commands/RemoveManagedScalingPolicyCommand";
 import { RemoveTagsCommand, RemoveTagsCommandInput, RemoveTagsCommandOutput } from "./commands/RemoveTagsCommand";
 import { RunJobFlowCommand, RunJobFlowCommandInput, RunJobFlowCommandOutput } from "./commands/RunJobFlowCommand";
+import {
+  SetKeepJobFlowAliveWhenNoStepsCommand,
+  SetKeepJobFlowAliveWhenNoStepsCommandInput,
+  SetKeepJobFlowAliveWhenNoStepsCommandOutput,
+} from "./commands/SetKeepJobFlowAliveWhenNoStepsCommand";
 import {
   SetTerminationProtectionCommand,
   SetTerminationProtectionCommandInput,
@@ -298,6 +303,7 @@ const commands = {
   RemoveManagedScalingPolicyCommand,
   RemoveTagsCommand,
   RunJobFlowCommand,
+  SetKeepJobFlowAliveWhenNoStepsCommand,
   SetTerminationProtectionCommand,
   SetVisibleToAllUsersCommand,
   StartNotebookExecutionCommand,
@@ -1026,6 +1032,23 @@ export interface EMR {
     cb: (err: any, data?: RunJobFlowCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link SetKeepJobFlowAliveWhenNoStepsCommand}
+   */
+  setKeepJobFlowAliveWhenNoSteps(
+    args: SetKeepJobFlowAliveWhenNoStepsCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<SetKeepJobFlowAliveWhenNoStepsCommandOutput>;
+  setKeepJobFlowAliveWhenNoSteps(
+    args: SetKeepJobFlowAliveWhenNoStepsCommandInput,
+    cb: (err: any, data?: SetKeepJobFlowAliveWhenNoStepsCommandOutput) => void
+  ): void;
+  setKeepJobFlowAliveWhenNoSteps(
+    args: SetKeepJobFlowAliveWhenNoStepsCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: SetKeepJobFlowAliveWhenNoStepsCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link SetTerminationProtectionCommand}
    */
diff --git a/clients/client-emr/src/EMRClient.ts b/clients/client-emr/src/EMRClient.ts
@@ -173,6 +173,10 @@ import {
 } from "./commands/RemoveManagedScalingPolicyCommand";
 import { RemoveTagsCommandInput, RemoveTagsCommandOutput } from "./commands/RemoveTagsCommand";
 import { RunJobFlowCommandInput, RunJobFlowCommandOutput } from "./commands/RunJobFlowCommand";
+import {
+  SetKeepJobFlowAliveWhenNoStepsCommandInput,
+  SetKeepJobFlowAliveWhenNoStepsCommandOutput,
+} from "./commands/SetKeepJobFlowAliveWhenNoStepsCommand";
 import {
   SetTerminationProtectionCommandInput,
   SetTerminationProtectionCommandOutput,
@@ -257,6 +261,7 @@ export type ServiceInputTypes =
   | RemoveManagedScalingPolicyCommandInput
   | RemoveTagsCommandInput
   | RunJobFlowCommandInput
+  | SetKeepJobFlowAliveWhenNoStepsCommandInput
   | SetTerminationProtectionCommandInput
   | SetVisibleToAllUsersCommandInput
   | StartNotebookExecutionCommandInput
@@ -316,6 +321,7 @@ export type ServiceOutputTypes =
   | RemoveManagedScalingPolicyCommandOutput
   | RemoveTagsCommandOutput
   | RunJobFlowCommandOutput
+  | SetKeepJobFlowAliveWhenNoStepsCommandOutput
   | SetTerminationProtectionCommandOutput
   | SetVisibleToAllUsersCommandOutput
   | StartNotebookExecutionCommandOutput
diff --git a/clients/client-emr/src/commands/SetKeepJobFlowAliveWhenNoStepsCommand.ts b/clients/client-emr/src/commands/SetKeepJobFlowAliveWhenNoStepsCommand.ts
@@ -0,0 +1,92 @@
+// smithy-typescript generated code
+import { getEndpointPlugin } from "@smithy/middleware-endpoint";
+import { getSerdePlugin } from "@smithy/middleware-serde";
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+
+import { EMRClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EMRClient";
+import { commonParams } from "../endpoint/EndpointParameters";
+import { SetKeepJobFlowAliveWhenNoStepsInput } from "../models/models_0";
+import {
+  de_SetKeepJobFlowAliveWhenNoStepsCommand,
+  se_SetKeepJobFlowAliveWhenNoStepsCommand,
+} from "../protocols/Aws_json1_1";
+
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link SetKeepJobFlowAliveWhenNoStepsCommand}.
+ */
+export interface SetKeepJobFlowAliveWhenNoStepsCommandInput extends SetKeepJobFlowAliveWhenNoStepsInput {}
+/**
+ * @public
+ *
+ * The output of {@link SetKeepJobFlowAliveWhenNoStepsCommand}.
+ */
+export interface SetKeepJobFlowAliveWhenNoStepsCommandOutput extends __MetadataBearer {}
+
+/**
+ * @public
+ * <p>You can use the <code>SetKeepJobFlowAliveWhenNoSteps</code> to configure a cluster (job flow) to terminate after the step execution, i.e., all your
+ *          steps are executed. If you want a transient cluster that shuts down after the last of the current executing steps are completed,
+ *          you can configure <code>SetKeepJobFlowAliveWhenNoSteps</code> to false. If you want a long running cluster, configure <code>SetKeepJobFlowAliveWhenNoSteps</code> to true.</p>
+ *          <p>For more information, see <a href="https://docs.aws.amazon.com/emr/latest/ManagementGuide/UsingEMR_TerminationProtection.html">Managing Cluster Termination</a> in the <i>Amazon EMR Management Guide</i>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { EMRClient, SetKeepJobFlowAliveWhenNoStepsCommand } from "@aws-sdk/client-emr"; // ES Modules import
+ * // const { EMRClient, SetKeepJobFlowAliveWhenNoStepsCommand } = require("@aws-sdk/client-emr"); // CommonJS import
+ * const client = new EMRClient(config);
+ * const input = { // SetKeepJobFlowAliveWhenNoStepsInput
+ *   JobFlowIds: [ // XmlStringList // required
+ *     "STRING_VALUE",
+ *   ],
+ *   KeepJobFlowAliveWhenNoSteps: true || false, // required
+ * };
+ * const command = new SetKeepJobFlowAliveWhenNoStepsCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param SetKeepJobFlowAliveWhenNoStepsCommandInput - {@link SetKeepJobFlowAliveWhenNoStepsCommandInput}
+ * @returns {@link SetKeepJobFlowAliveWhenNoStepsCommandOutput}
+ * @see {@link SetKeepJobFlowAliveWhenNoStepsCommandInput} for command's `input` shape.
+ * @see {@link SetKeepJobFlowAliveWhenNoStepsCommandOutput} for command's `response` shape.
+ * @see {@link EMRClientResolvedConfig | config} for EMRClient's `config` shape.
+ *
+ * @throws {@link InternalServerError} (server fault)
+ *  <p>Indicates that an error occurred while processing the request and that the request was
+ *          not completed.</p>
+ *
+ * @throws {@link EMRServiceException}
+ * <p>Base exception class for all service exceptions from EMR service.</p>
+ *
+ */
+export class SetKeepJobFlowAliveWhenNoStepsCommand extends $Command
+  .classBuilder<
+    SetKeepJobFlowAliveWhenNoStepsCommandInput,
+    SetKeepJobFlowAliveWhenNoStepsCommandOutput,
+    EMRClientResolvedConfig,
+    ServiceInputTypes,
+    ServiceOutputTypes
+  >()
+  .ep({
+    ...commonParams,
+  })
+  .m(function (this: any, Command: any, cs: any, config: EMRClientResolvedConfig, o: any) {
+    return [
+      getSerdePlugin(config, this.serialize, this.deserialize),
+      getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
+    ];
+  })
+  .s("ElasticMapReduce", "SetKeepJobFlowAliveWhenNoSteps", {})
+  .n("EMRClient", "SetKeepJobFlowAliveWhenNoStepsCommand")
+  .f(void 0, void 0)
+  .ser(se_SetKeepJobFlowAliveWhenNoStepsCommand)
+  .de(de_SetKeepJobFlowAliveWhenNoStepsCommand)
+  .build() {}
diff --git a/clients/client-emr/src/commands/index.ts b/clients/client-emr/src/commands/index.ts
@@ -46,6 +46,7 @@ export * from "./RemoveAutoTerminationPolicyCommand";
 export * from "./RemoveManagedScalingPolicyCommand";
 export * from "./RemoveTagsCommand";
 export * from "./RunJobFlowCommand";
+export * from "./SetKeepJobFlowAliveWhenNoStepsCommand";
 export * from "./SetTerminationProtectionCommand";
 export * from "./SetVisibleToAllUsersCommand";
 export * from "./StartNotebookExecutionCommand";
diff --git a/clients/client-emr/src/models/models_0.ts b/clients/client-emr/src/models/models_0.ts
@@ -5726,6 +5726,25 @@ export interface RunJobFlowOutput {
   ClusterArn?: string;
 }
 
+/**
+ * @public
+ */
+export interface SetKeepJobFlowAliveWhenNoStepsInput {
+  /**
+   * @public
+   * <p>A list of strings that uniquely identify the clusters to protect. This identifier is returned by
+   *          <a href="https://docs.aws.amazon.com/emr/latest/APIReference/API_RunJobFlow.html">RunJobFlow</a> and can also
+   *          be obtained from <a href="https://docs.aws.amazon.com/emr/latest/APIReference/API_DescribeJobFlows.html">DescribeJobFlows</a>.</p>
+   */
+  JobFlowIds: string[] | undefined;
+
+  /**
+   * @public
+   * <p>A Boolean that indicates whether to terminate the cluster after all steps are executed.</p>
+   */
+  KeepJobFlowAliveWhenNoSteps: boolean | undefined;
+}
+
 /**
  * @public
  * <p> The input argument to the <a>TerminationProtection</a> operation. </p>
diff --git a/clients/client-emr/src/protocols/Aws_json1_1.ts b/clients/client-emr/src/protocols/Aws_json1_1.ts
@@ -150,6 +150,10 @@ import {
 } from "../commands/RemoveManagedScalingPolicyCommand";
 import { RemoveTagsCommandInput, RemoveTagsCommandOutput } from "../commands/RemoveTagsCommand";
 import { RunJobFlowCommandInput, RunJobFlowCommandOutput } from "../commands/RunJobFlowCommand";
+import {
+  SetKeepJobFlowAliveWhenNoStepsCommandInput,
+  SetKeepJobFlowAliveWhenNoStepsCommandOutput,
+} from "../commands/SetKeepJobFlowAliveWhenNoStepsCommand";
 import {
   SetTerminationProtectionCommandInput,
   SetTerminationProtectionCommandOutput,
@@ -313,6 +317,7 @@ import {
   SecurityConfigurationSummary,
   SessionMappingDetail,
   SessionMappingSummary,
+  SetKeepJobFlowAliveWhenNoStepsInput,
   SetTerminationProtectionInput,
   SetVisibleToAllUsersInput,
   ShrinkPolicy,
@@ -951,6 +956,19 @@ export const se_RunJobFlowCommand = async (
   return buildHttpRpcRequest(context, headers, "/", undefined, body);
 };
 
+/**
+ * serializeAws_json1_1SetKeepJobFlowAliveWhenNoStepsCommand
+ */
+export const se_SetKeepJobFlowAliveWhenNoStepsCommand = async (
+  input: SetKeepJobFlowAliveWhenNoStepsCommandInput,
+  context: __SerdeContext
+): Promise<__HttpRequest> => {
+  const headers: __HeaderBag = sharedHeaders("SetKeepJobFlowAliveWhenNoSteps");
+  let body: any;
+  body = JSON.stringify(_json(input));
+  return buildHttpRpcRequest(context, headers, "/", undefined, body);
+};
+
 /**
  * serializeAws_json1_1SetTerminationProtectionCommand
  */
@@ -3243,6 +3261,49 @@ const de_RunJobFlowCommandError = async (
   }
 };
 
+/**
+ * deserializeAws_json1_1SetKeepJobFlowAliveWhenNoStepsCommand
+ */
+export const de_SetKeepJobFlowAliveWhenNoStepsCommand = async (
+  output: __HttpResponse,
+  context: __SerdeContext
+): Promise<SetKeepJobFlowAliveWhenNoStepsCommandOutput> => {
+  if (output.statusCode >= 300) {
+    return de_SetKeepJobFlowAliveWhenNoStepsCommandError(output, context);
+  }
+  await collectBody(output.body, context);
+  const response: SetKeepJobFlowAliveWhenNoStepsCommandOutput = {
+    $metadata: deserializeMetadata(output),
+  };
+  return response;
+};
+
+/**
+ * deserializeAws_json1_1SetKeepJobFlowAliveWhenNoStepsCommandError
+ */
+const de_SetKeepJobFlowAliveWhenNoStepsCommandError = async (
+  output: __HttpResponse,
+  context: __SerdeContext
+): Promise<SetKeepJobFlowAliveWhenNoStepsCommandOutput> => {
+  const parsedOutput: any = {
+    ...output,
+    body: await parseErrorBody(output.body, context),
+  };
+  const errorCode = loadRestJsonErrorCode(output, parsedOutput.body);
+  switch (errorCode) {
+    case "InternalServerError":
+    case "com.amazonaws.emr#InternalServerError":
+      throw await de_InternalServerErrorRes(parsedOutput, context);
+    default:
+      const parsedBody = parsedOutput.body;
+      return throwDefaultError({
+        output,
+        parsedBody,
+        errorCode,
+      });
+  }
+};
+
 /**
  * deserializeAws_json1_1SetTerminationProtectionCommand
  */
@@ -4123,6 +4184,8 @@ const se_ScalingTrigger = (input: ScalingTrigger, context: __SerdeContext): any
 
 // se_SecurityGroupsList omitted.
 
+// se_SetKeepJobFlowAliveWhenNoStepsInput omitted.
+
 // se_SetTerminationProtectionInput omitted.
 
 // se_SetVisibleToAllUsersInput omitted.
diff --git a/codegen/sdk-codegen/aws-models/emr.json b/codegen/sdk-codegen/aws-models/emr.json
@@ -2794,6 +2794,9 @@
         {
           "target": "com.amazonaws.emr#RunJobFlow"
         },
+        {
+          "target": "com.amazonaws.emr#SetKeepJobFlowAliveWhenNoSteps"
+        },
         {
           "target": "com.amazonaws.emr#SetTerminationProtection"
         },
@@ -8935,6 +8938,47 @@
         "target": "com.amazonaws.emr#SessionMappingSummary"
       }
     },
+    "com.amazonaws.emr#SetKeepJobFlowAliveWhenNoSteps": {
+      "type": "operation",
+      "input": {
+        "target": "com.amazonaws.emr#SetKeepJobFlowAliveWhenNoStepsInput"
+      },
+      "output": {
+        "target": "smithy.api#Unit"
+      },
+      "errors": [
+        {
+          "target": "com.amazonaws.emr#InternalServerError"
+        }
+      ],
+      "traits": {
+        "smithy.api#documentation": "<p>You can use the <code>SetKeepJobFlowAliveWhenNoSteps</code> to configure a cluster (job flow) to terminate after the step execution, i.e., all your \n         steps are executed. If you want a transient cluster that shuts down after the last of the current executing steps are completed, \n         you can configure <code>SetKeepJobFlowAliveWhenNoSteps</code> to false. If you want a long running cluster, configure <code>SetKeepJobFlowAliveWhenNoSteps</code> to true.</p>\n         <p>For more information, see <a href=\"https://docs.aws.amazon.com/emr/latest/ManagementGuide/UsingEMR_TerminationProtection.html\">Managing Cluster Termination</a> in the <i>Amazon EMR Management Guide</i>.</p>"
+      }
+    },
+    "com.amazonaws.emr#SetKeepJobFlowAliveWhenNoStepsInput": {
+      "type": "structure",
+      "members": {
+        "JobFlowIds": {
+          "target": "com.amazonaws.emr#XmlStringList",
+          "traits": {
+            "smithy.api#clientOptional": {},
+            "smithy.api#documentation": "<p>A list of strings that uniquely identify the clusters to protect. This identifier is returned by \n         <a href=\"https://docs.aws.amazon.com/emr/latest/APIReference/API_RunJobFlow.html\">RunJobFlow</a> and can also \n         be obtained from <a href=\"https://docs.aws.amazon.com/emr/latest/APIReference/API_DescribeJobFlows.html\">DescribeJobFlows</a>.</p>",
+            "smithy.api#required": {}
+          }
+        },
+        "KeepJobFlowAliveWhenNoSteps": {
+          "target": "com.amazonaws.emr#Boolean",
+          "traits": {
+            "smithy.api#clientOptional": {},
+            "smithy.api#documentation": "<p>A Boolean that indicates whether to terminate the cluster after all steps are executed.</p>",
+            "smithy.api#required": {}
+          }
+        }
+      },
+      "traits": {
+        "smithy.api#input": {}
+      }
+    },
     "com.amazonaws.emr#SetTerminationProtection": {
       "type": "operation",
       "input": {
