feat(client-athena): This release introduces the DeleteCapacityReservation API and the ability to manage capacity reservations using CloudFormation

awstools · awstools · commit 5aceef8993e2 · 2023-06-02T18:16:20.000Z
diff --git a/clients/client-athena/README.md b/clients/client-athena/README.md
@@ -303,6 +303,14 @@ CreateWorkGroup
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-athena/classes/createworkgroupcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-athena/interfaces/createworkgroupcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-athena/interfaces/createworkgroupcommandoutput.html)
 
+</details>
+<details>
+<summary>
+DeleteCapacityReservation
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-athena/classes/deletecapacityreservationcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-athena/interfaces/deletecapacityreservationcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-athena/interfaces/deletecapacityreservationcommandoutput.html)
+
 </details>
 <details>
 <summary>
diff --git a/clients/client-athena/src/Athena.ts b/clients/client-athena/src/Athena.ts
@@ -58,6 +58,11 @@ import {
   CreateWorkGroupCommandInput,
   CreateWorkGroupCommandOutput,
 } from "./commands/CreateWorkGroupCommand";
+import {
+  DeleteCapacityReservationCommand,
+  DeleteCapacityReservationCommandInput,
+  DeleteCapacityReservationCommandOutput,
+} from "./commands/DeleteCapacityReservationCommand";
 import {
   DeleteDataCatalogCommand,
   DeleteDataCatalogCommandInput,
@@ -339,6 +344,7 @@ const commands = {
   CreatePreparedStatementCommand,
   CreatePresignedNotebookUrlCommand,
   CreateWorkGroupCommand,
+  DeleteCapacityReservationCommand,
   DeleteDataCatalogCommand,
   DeleteNamedQueryCommand,
   DeleteNotebookCommand,
@@ -579,6 +585,23 @@ export interface Athena {
     cb: (err: any, data?: CreateWorkGroupCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link DeleteCapacityReservationCommand}
+   */
+  deleteCapacityReservation(
+    args: DeleteCapacityReservationCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<DeleteCapacityReservationCommandOutput>;
+  deleteCapacityReservation(
+    args: DeleteCapacityReservationCommandInput,
+    cb: (err: any, data?: DeleteCapacityReservationCommandOutput) => void
+  ): void;
+  deleteCapacityReservation(
+    args: DeleteCapacityReservationCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: DeleteCapacityReservationCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link DeleteDataCatalogCommand}
    */
diff --git a/clients/client-athena/src/AthenaClient.ts b/clients/client-athena/src/AthenaClient.ts
@@ -80,6 +80,10 @@ import {
   CreatePresignedNotebookUrlCommandOutput,
 } from "./commands/CreatePresignedNotebookUrlCommand";
 import { CreateWorkGroupCommandInput, CreateWorkGroupCommandOutput } from "./commands/CreateWorkGroupCommand";
+import {
+  DeleteCapacityReservationCommandInput,
+  DeleteCapacityReservationCommandOutput,
+} from "./commands/DeleteCapacityReservationCommand";
 import { DeleteDataCatalogCommandInput, DeleteDataCatalogCommandOutput } from "./commands/DeleteDataCatalogCommand";
 import { DeleteNamedQueryCommandInput, DeleteNamedQueryCommandOutput } from "./commands/DeleteNamedQueryCommand";
 import { DeleteNotebookCommandInput, DeleteNotebookCommandOutput } from "./commands/DeleteNotebookCommand";
@@ -233,6 +237,7 @@ export type ServiceInputTypes =
   | CreatePreparedStatementCommandInput
   | CreatePresignedNotebookUrlCommandInput
   | CreateWorkGroupCommandInput
+  | DeleteCapacityReservationCommandInput
   | DeleteDataCatalogCommandInput
   | DeleteNamedQueryCommandInput
   | DeleteNotebookCommandInput
@@ -305,6 +310,7 @@ export type ServiceOutputTypes =
   | CreatePreparedStatementCommandOutput
   | CreatePresignedNotebookUrlCommandOutput
   | CreateWorkGroupCommandOutput
+  | DeleteCapacityReservationCommandOutput
   | DeleteDataCatalogCommandOutput
   | DeleteNamedQueryCommandOutput
   | DeleteNotebookCommandOutput
diff --git a/clients/client-athena/src/commands/CancelCapacityReservationCommand.ts b/clients/client-athena/src/commands/CancelCapacityReservationCommand.ts
@@ -36,7 +36,7 @@ export interface CancelCapacityReservationCommandOutput extends CancelCapacityRe
 
 /**
  * @public
- * <p>Cancels the capacity reservation with the specified name.</p>
+ * <p>Cancels the capacity reservation with the specified name. Cancelled reservations remain in your account and will be deleted 45 days after cancellation. During the 45 days, you cannot re-purpose or reuse a reservation that has been cancelled, but you can refer to its tags and view it for historical reference. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-athena/src/commands/DeleteCapacityReservationCommand.ts b/clients/client-athena/src/commands/DeleteCapacityReservationCommand.ts
@@ -0,0 +1,151 @@
+// smithy-typescript generated code
+import { EndpointParameterInstructions, getEndpointPlugin } from "@aws-sdk/middleware-endpoint";
+import { getSerdePlugin } from "@aws-sdk/middleware-serde";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import {
+  FinalizeHandlerArguments,
+  Handler,
+  HandlerExecutionContext,
+  HttpHandlerOptions as __HttpHandlerOptions,
+  MetadataBearer as __MetadataBearer,
+  MiddlewareStack,
+} from "@aws-sdk/types";
+import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
+import { SerdeContext as __SerdeContext } from "@smithy/types";
+
+import { AthenaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AthenaClient";
+import { DeleteCapacityReservationInput, DeleteCapacityReservationOutput } from "../models/models_0";
+import { de_DeleteCapacityReservationCommand, se_DeleteCapacityReservationCommand } from "../protocols/Aws_json1_1";
+
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link DeleteCapacityReservationCommand}.
+ */
+export interface DeleteCapacityReservationCommandInput extends DeleteCapacityReservationInput {}
+/**
+ * @public
+ *
+ * The output of {@link DeleteCapacityReservationCommand}.
+ */
+export interface DeleteCapacityReservationCommandOutput extends DeleteCapacityReservationOutput, __MetadataBearer {}
+
+/**
+ * @public
+ * <p>Deletes a cancelled capacity reservation. A reservation must be cancelled before it can be deleted. A deleted reservation is immediately removed from your account and can no longer be referenced, including by its ARN. A deleted reservation cannot be called by <code>GetCapacityReservation</code>, and  deleted reservations do not appear in the output of <code>ListCapacityReservations</code>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { AthenaClient, DeleteCapacityReservationCommand } from "@aws-sdk/client-athena"; // ES Modules import
+ * // const { AthenaClient, DeleteCapacityReservationCommand } = require("@aws-sdk/client-athena"); // CommonJS import
+ * const client = new AthenaClient(config);
+ * const input = { // DeleteCapacityReservationInput
+ *   Name: "STRING_VALUE", // required
+ * };
+ * const command = new DeleteCapacityReservationCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param DeleteCapacityReservationCommandInput - {@link DeleteCapacityReservationCommandInput}
+ * @returns {@link DeleteCapacityReservationCommandOutput}
+ * @see {@link DeleteCapacityReservationCommandInput} for command's `input` shape.
+ * @see {@link DeleteCapacityReservationCommandOutput} for command's `response` shape.
+ * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>Indicates a platform issue, which may be due to a transient condition or
+ *             outage.</p>
+ *
+ * @throws {@link InvalidRequestException} (client fault)
+ *  <p>Indicates that something is wrong with the input to the request. For example, a
+ *             required parameter may be missing or out of range.</p>
+ *
+ * @throws {@link AthenaServiceException}
+ * <p>Base exception class for all service exceptions from Athena service.</p>
+ *
+ */
+export class DeleteCapacityReservationCommand extends $Command<
+  DeleteCapacityReservationCommandInput,
+  DeleteCapacityReservationCommandOutput,
+  AthenaClientResolvedConfig
+> {
+  // Start section: command_properties
+  // End section: command_properties
+
+  public static getEndpointParameterInstructions(): EndpointParameterInstructions {
+    return {
+      UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" },
+      Endpoint: { type: "builtInParams", name: "endpoint" },
+      Region: { type: "builtInParams", name: "region" },
+      UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" },
+    };
+  }
+
+  /**
+   * @public
+   */
+  constructor(readonly input: DeleteCapacityReservationCommandInput) {
+    // Start section: command_constructor
+    super();
+    // End section: command_constructor
+  }
+
+  /**
+   * @internal
+   */
+  resolveMiddleware(
+    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
+    configuration: AthenaClientResolvedConfig,
+    options?: __HttpHandlerOptions
+  ): Handler<DeleteCapacityReservationCommandInput, DeleteCapacityReservationCommandOutput> {
+    this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
+    this.middlewareStack.use(
+      getEndpointPlugin(configuration, DeleteCapacityReservationCommand.getEndpointParameterInstructions())
+    );
+
+    const stack = clientStack.concat(this.middlewareStack);
+
+    const { logger } = configuration;
+    const clientName = "AthenaClient";
+    const commandName = "DeleteCapacityReservationCommand";
+    const handlerExecutionContext: HandlerExecutionContext = {
+      logger,
+      clientName,
+      commandName,
+      inputFilterSensitiveLog: (_: any) => _,
+      outputFilterSensitiveLog: (_: any) => _,
+    };
+    const { requestHandler } = configuration;
+    return stack.resolve(
+      (request: FinalizeHandlerArguments<any>) =>
+        requestHandler.handle(request.request as __HttpRequest, options || {}),
+      handlerExecutionContext
+    );
+  }
+
+  /**
+   * @internal
+   */
+  private serialize(input: DeleteCapacityReservationCommandInput, context: __SerdeContext): Promise<__HttpRequest> {
+    return se_DeleteCapacityReservationCommand(input, context);
+  }
+
+  /**
+   * @internal
+   */
+  private deserialize(
+    output: __HttpResponse,
+    context: __SerdeContext
+  ): Promise<DeleteCapacityReservationCommandOutput> {
+    return de_DeleteCapacityReservationCommand(output, context);
+  }
+
+  // Start section: command_body_extra
+  // End section: command_body_extra
+}
diff --git a/clients/client-athena/src/commands/index.ts b/clients/client-athena/src/commands/index.ts
@@ -10,6 +10,7 @@ export * from "./CreateNotebookCommand";
 export * from "./CreatePreparedStatementCommand";
 export * from "./CreatePresignedNotebookUrlCommand";
 export * from "./CreateWorkGroupCommand";
+export * from "./DeleteCapacityReservationCommand";
 export * from "./DeleteDataCatalogCommand";
 export * from "./DeleteNamedQueryCommand";
 export * from "./DeleteNotebookCommand";
diff --git a/clients/client-athena/src/models/models_0.ts b/clients/client-athena/src/models/models_0.ts
@@ -705,7 +705,7 @@ export interface QueryExecution {
 
   /**
    * <p>A list of values for the parameters in a query. The values are applied sequentially to
-   *             the parameters in the query in the order in which the parameters occur.</p>
+   *             the parameters in the query in the order in which the parameters occur. The list of parameters is not returned in the response.</p>
    */
   ExecutionParameters?: string[];
 
@@ -1293,6 +1293,21 @@ export interface CreateWorkGroupInput {
  */
 export interface CreateWorkGroupOutput {}
 
+/**
+ * @public
+ */
+export interface DeleteCapacityReservationInput {
+  /**
+   * <p>The name of the capacity reservation to delete.</p>
+   */
+  Name: string | undefined;
+}
+
+/**
+ * @public
+ */
+export interface DeleteCapacityReservationOutput {}
+
 /**
  * @public
  */
diff --git a/clients/client-athena/src/protocols/Aws_json1_1.ts b/clients/client-athena/src/protocols/Aws_json1_1.ts
@@ -45,6 +45,10 @@ import {
   CreatePresignedNotebookUrlCommandOutput,
 } from "../commands/CreatePresignedNotebookUrlCommand";
 import { CreateWorkGroupCommandInput, CreateWorkGroupCommandOutput } from "../commands/CreateWorkGroupCommand";
+import {
+  DeleteCapacityReservationCommandInput,
+  DeleteCapacityReservationCommandOutput,
+} from "../commands/DeleteCapacityReservationCommand";
 import { DeleteDataCatalogCommandInput, DeleteDataCatalogCommandOutput } from "../commands/DeleteDataCatalogCommand";
 import { DeleteNamedQueryCommandInput, DeleteNamedQueryCommandOutput } from "../commands/DeleteNamedQueryCommand";
 import { DeleteNotebookCommandInput, DeleteNotebookCommandOutput } from "../commands/DeleteNotebookCommand";
@@ -196,6 +200,7 @@ import {
   CreatePresignedNotebookUrlRequest,
   CreateWorkGroupInput,
   CustomerContentEncryptionConfiguration,
+  DeleteCapacityReservationInput,
   DeleteDataCatalogInput,
   DeleteNamedQueryInput,
   DeleteNotebookInput,
@@ -449,6 +454,19 @@ export const se_CreateWorkGroupCommand = async (
   return buildHttpRpcRequest(context, headers, "/", undefined, body);
 };
 
+/**
+ * serializeAws_json1_1DeleteCapacityReservationCommand
+ */
+export const se_DeleteCapacityReservationCommand = async (
+  input: DeleteCapacityReservationCommandInput,
+  context: __SerdeContext
+): Promise<__HttpRequest> => {
+  const headers: __HeaderBag = sharedHeaders("DeleteCapacityReservation");
+  let body: any;
+  body = JSON.stringify(_json(input));
+  return buildHttpRpcRequest(context, headers, "/", undefined, body);
+};
+
 /**
  * serializeAws_json1_1DeleteDataCatalogCommand
  */
@@ -1722,6 +1740,55 @@ const de_CreateWorkGroupCommandError = async (
   }
 };
 
+/**
+ * deserializeAws_json1_1DeleteCapacityReservationCommand
+ */
+export const de_DeleteCapacityReservationCommand = async (
+  output: __HttpResponse,
+  context: __SerdeContext
+): Promise<DeleteCapacityReservationCommandOutput> => {
+  if (output.statusCode >= 300) {
+    return de_DeleteCapacityReservationCommandError(output, context);
+  }
+  const data: any = await parseBody(output.body, context);
+  let contents: any = {};
+  contents = _json(data);
+  const response: DeleteCapacityReservationCommandOutput = {
+    $metadata: deserializeMetadata(output),
+    ...contents,
+  };
+  return response;
+};
+
+/**
+ * deserializeAws_json1_1DeleteCapacityReservationCommandError
+ */
+const de_DeleteCapacityReservationCommandError = async (
+  output: __HttpResponse,
+  context: __SerdeContext
+): Promise<DeleteCapacityReservationCommandOutput> => {
+  const parsedOutput: any = {
+    ...output,
+    body: await parseErrorBody(output.body, context),
+  };
+  const errorCode = loadRestJsonErrorCode(output, parsedOutput.body);
+  switch (errorCode) {
+    case "InternalServerException":
+    case "com.amazonaws.athena#InternalServerException":
+      throw await de_InternalServerExceptionRes(parsedOutput, context);
+    case "InvalidRequestException":
+    case "com.amazonaws.athena#InvalidRequestException":
+      throw await de_InvalidRequestExceptionRes(parsedOutput, context);
+    default:
+      const parsedBody = parsedOutput.body;
+      return throwDefaultError({
+        output,
+        parsedBody,
+        errorCode,
+      });
+  }
+};
+
 /**
  * deserializeAws_json1_1DeleteDataCatalogCommand
  */
@@ -4708,6 +4775,8 @@ const se_CreateNamedQueryInput = (input: CreateNamedQueryInput, context: __Serde
 
 // se_CustomerContentEncryptionConfiguration omitted.
 
+// se_DeleteCapacityReservationInput omitted.
+
 // se_DeleteDataCatalogInput omitted.
 
 /**
@@ -5041,6 +5110,8 @@ const de_CapacityReservationsList = (output: any, context: __SerdeContext): Capa
 
 // de_datumList omitted.
 
+// de_DeleteCapacityReservationOutput omitted.
+
 // de_DeleteDataCatalogOutput omitted.
 
 // de_DeleteNamedQueryOutput omitted.
diff --git a/codegen/sdk-codegen/aws-models/athena.json b/codegen/sdk-codegen/aws-models/athena.json
