feat(client-dsql): Added GetClusterEndpointService API. The new API allows retrieving endpoint service name specific to a cluster.

awstools · awstools · commit 4c3f4ecdf0c3 · 2025-04-16T18:20:09.000Z
diff --git a/clients/client-dsql/README.md b/clients/client-dsql/README.md
@@ -251,6 +251,14 @@ GetCluster
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/dsql/command/GetClusterCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dsql/Interface/GetClusterCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dsql/Interface/GetClusterCommandOutput/)
 
+</details>
+<details>
+<summary>
+GetVpcEndpointServiceName
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/dsql/command/GetVpcEndpointServiceNameCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dsql/Interface/GetVpcEndpointServiceNameCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dsql/Interface/GetVpcEndpointServiceNameCommandOutput/)
+
 </details>
 <details>
 <summary>
diff --git a/clients/client-dsql/src/DSQL.ts b/clients/client-dsql/src/DSQL.ts
@@ -23,6 +23,11 @@ import {
   DeleteMultiRegionClustersCommandOutput,
 } from "./commands/DeleteMultiRegionClustersCommand";
 import { GetClusterCommand, GetClusterCommandInput, GetClusterCommandOutput } from "./commands/GetClusterCommand";
+import {
+  GetVpcEndpointServiceNameCommand,
+  GetVpcEndpointServiceNameCommandInput,
+  GetVpcEndpointServiceNameCommandOutput,
+} from "./commands/GetVpcEndpointServiceNameCommand";
 import {
   ListClustersCommand,
   ListClustersCommandInput,
@@ -52,6 +57,7 @@ const commands = {
   DeleteClusterCommand,
   DeleteMultiRegionClustersCommand,
   GetClusterCommand,
+  GetVpcEndpointServiceNameCommand,
   ListClustersCommand,
   ListTagsForResourceCommand,
   TagResourceCommand,
@@ -128,6 +134,23 @@ export interface DSQL {
     cb: (err: any, data?: GetClusterCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link GetVpcEndpointServiceNameCommand}
+   */
+  getVpcEndpointServiceName(
+    args: GetVpcEndpointServiceNameCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<GetVpcEndpointServiceNameCommandOutput>;
+  getVpcEndpointServiceName(
+    args: GetVpcEndpointServiceNameCommandInput,
+    cb: (err: any, data?: GetVpcEndpointServiceNameCommandOutput) => void
+  ): void;
+  getVpcEndpointServiceName(
+    args: GetVpcEndpointServiceNameCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: GetVpcEndpointServiceNameCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link ListClustersCommand}
    */
diff --git a/clients/client-dsql/src/DSQLClient.ts b/clients/client-dsql/src/DSQLClient.ts
@@ -64,6 +64,10 @@ import {
   DeleteMultiRegionClustersCommandOutput,
 } from "./commands/DeleteMultiRegionClustersCommand";
 import { GetClusterCommandInput, GetClusterCommandOutput } from "./commands/GetClusterCommand";
+import {
+  GetVpcEndpointServiceNameCommandInput,
+  GetVpcEndpointServiceNameCommandOutput,
+} from "./commands/GetVpcEndpointServiceNameCommand";
 import { ListClustersCommandInput, ListClustersCommandOutput } from "./commands/ListClustersCommand";
 import {
   ListTagsForResourceCommandInput,
@@ -92,6 +96,7 @@ export type ServiceInputTypes =
   | DeleteClusterCommandInput
   | DeleteMultiRegionClustersCommandInput
   | GetClusterCommandInput
+  | GetVpcEndpointServiceNameCommandInput
   | ListClustersCommandInput
   | ListTagsForResourceCommandInput
   | TagResourceCommandInput
@@ -107,6 +112,7 @@ export type ServiceOutputTypes =
   | DeleteClusterCommandOutput
   | DeleteMultiRegionClustersCommandOutput
   | GetClusterCommandOutput
+  | GetVpcEndpointServiceNameCommandOutput
   | ListClustersCommandOutput
   | ListTagsForResourceCommandOutput
   | TagResourceCommandOutput
diff --git a/clients/client-dsql/src/commands/GetVpcEndpointServiceNameCommand.ts b/clients/client-dsql/src/commands/GetVpcEndpointServiceNameCommand.ts
@@ -0,0 +1,122 @@
+// 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 { DSQLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DSQLClient";
+import { commonParams } from "../endpoint/EndpointParameters";
+import { GetVpcEndpointServiceNameInput, GetVpcEndpointServiceNameOutput } from "../models/models_0";
+import { de_GetVpcEndpointServiceNameCommand, se_GetVpcEndpointServiceNameCommand } from "../protocols/Aws_restJson1";
+
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetVpcEndpointServiceNameCommand}.
+ */
+export interface GetVpcEndpointServiceNameCommandInput extends GetVpcEndpointServiceNameInput {}
+/**
+ * @public
+ *
+ * The output of {@link GetVpcEndpointServiceNameCommand}.
+ */
+export interface GetVpcEndpointServiceNameCommandOutput extends GetVpcEndpointServiceNameOutput, __MetadataBearer {}
+
+/**
+ * <p>Retrieves the VPC endpoint service name.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { DSQLClient, GetVpcEndpointServiceNameCommand } from "@aws-sdk/client-dsql"; // ES Modules import
+ * // const { DSQLClient, GetVpcEndpointServiceNameCommand } = require("@aws-sdk/client-dsql"); // CommonJS import
+ * const client = new DSQLClient(config);
+ * const input = { // GetVpcEndpointServiceNameInput
+ *   identifier: "STRING_VALUE", // required
+ * };
+ * const command = new GetVpcEndpointServiceNameCommand(input);
+ * const response = await client.send(command);
+ * // { // GetVpcEndpointServiceNameOutput
+ * //   serviceName: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param GetVpcEndpointServiceNameCommandInput - {@link GetVpcEndpointServiceNameCommandInput}
+ * @returns {@link GetVpcEndpointServiceNameCommandOutput}
+ * @see {@link GetVpcEndpointServiceNameCommandInput} for command's `input` shape.
+ * @see {@link GetVpcEndpointServiceNameCommandOutput} for command's `response` shape.
+ * @see {@link DSQLClientResolvedConfig | config} for DSQLClient's `config` shape.
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request processing has failed because of an unknown error,
+ *       exception or failure.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The resource could not be found.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input failed to satisfy the constraints specified by an Amazon Web Services service.</p>
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link DSQLServiceException}
+ * <p>Base exception class for all service exceptions from DSQL service.</p>
+ *
+ *
+ * @example Get VPC Endpoint Service Name
+ * ```javascript
+ * //
+ * const input = {
+ *   identifier: "kiqenqglxyl2snyvkvnj2c3s2e"
+ * };
+ * const command = new GetVpcEndpointServiceNameCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export class GetVpcEndpointServiceNameCommand extends $Command
+  .classBuilder<
+    GetVpcEndpointServiceNameCommandInput,
+    GetVpcEndpointServiceNameCommandOutput,
+    DSQLClientResolvedConfig,
+    ServiceInputTypes,
+    ServiceOutputTypes
+  >()
+  .ep(commonParams)
+  .m(function (this: any, Command: any, cs: any, config: DSQLClientResolvedConfig, o: any) {
+    return [
+      getSerdePlugin(config, this.serialize, this.deserialize),
+      getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
+    ];
+  })
+  .s("DSQL", "GetVpcEndpointServiceName", {})
+  .n("DSQLClient", "GetVpcEndpointServiceNameCommand")
+  .f(void 0, void 0)
+  .ser(se_GetVpcEndpointServiceNameCommand)
+  .de(de_GetVpcEndpointServiceNameCommand)
+  .build() {
+  /** @internal type navigation helper, not in runtime. */
+  protected declare static __types: {
+    api: {
+      input: GetVpcEndpointServiceNameInput;
+      output: GetVpcEndpointServiceNameOutput;
+    };
+    sdk: {
+      input: GetVpcEndpointServiceNameCommandInput;
+      output: GetVpcEndpointServiceNameCommandOutput;
+    };
+  };
+}
diff --git a/clients/client-dsql/src/commands/index.ts b/clients/client-dsql/src/commands/index.ts
@@ -4,6 +4,7 @@ export * from "./CreateMultiRegionClustersCommand";
 export * from "./DeleteClusterCommand";
 export * from "./DeleteMultiRegionClustersCommand";
 export * from "./GetClusterCommand";
+export * from "./GetVpcEndpointServiceNameCommand";
 export * from "./ListClustersCommand";
 export * from "./ListTagsForResourceCommand";
 export * from "./TagResourceCommand";
diff --git a/clients/client-dsql/src/models/models_0.ts b/clients/client-dsql/src/models/models_0.ts
@@ -577,6 +577,28 @@ export interface GetClusterOutput {
   linkedClusterArns?: string[] | undefined;
 }
 
+/**
+ * @public
+ */
+export interface GetVpcEndpointServiceNameInput {
+  /**
+   * <p>The ID of the cluster to retrieve.</p>
+   * @public
+   */
+  identifier: string | undefined;
+}
+
+/**
+ * @public
+ */
+export interface GetVpcEndpointServiceNameOutput {
+  /**
+   * <p>The VPC endpoint service name.</p>
+   * @public
+   */
+  serviceName: string | undefined;
+}
+
 /**
  * @public
  */
diff --git a/clients/client-dsql/src/protocols/Aws_restJson1.ts b/clients/client-dsql/src/protocols/Aws_restJson1.ts
@@ -37,6 +37,10 @@ import {
   DeleteMultiRegionClustersCommandOutput,
 } from "../commands/DeleteMultiRegionClustersCommand";
 import { GetClusterCommandInput, GetClusterCommandOutput } from "../commands/GetClusterCommand";
+import {
+  GetVpcEndpointServiceNameCommandInput,
+  GetVpcEndpointServiceNameCommandOutput,
+} from "../commands/GetVpcEndpointServiceNameCommand";
 import { ListClustersCommandInput, ListClustersCommandOutput } from "../commands/ListClustersCommand";
 import {
   ListTagsForResourceCommandInput,
@@ -160,6 +164,22 @@ export const se_GetClusterCommand = async (
   return b.build();
 };
 
+/**
+ * serializeAws_restJson1GetVpcEndpointServiceNameCommand
+ */
+export const se_GetVpcEndpointServiceNameCommand = async (
+  input: GetVpcEndpointServiceNameCommandInput,
+  context: __SerdeContext
+): Promise<__HttpRequest> => {
+  const b = rb(input, context);
+  const headers: any = {};
+  b.bp("/clusters/{identifier}/vpc-endpoint-service-name");
+  b.p("identifier", () => input.identifier!, "{identifier}", false);
+  let body: any;
+  b.m("GET").h(headers).b(body);
+  return b.build();
+};
+
 /**
  * serializeAws_restJson1ListClustersCommand
  */
@@ -376,6 +396,27 @@ export const de_GetClusterCommand = async (
   return contents;
 };
 
+/**
+ * deserializeAws_restJson1GetVpcEndpointServiceNameCommand
+ */
+export const de_GetVpcEndpointServiceNameCommand = async (
+  output: __HttpResponse,
+  context: __SerdeContext
+): Promise<GetVpcEndpointServiceNameCommandOutput> => {
+  if (output.statusCode !== 200 && output.statusCode >= 300) {
+    return de_CommandError(output, context);
+  }
+  const contents: any = map({
+    $metadata: deserializeMetadata(output),
+  });
+  const data: Record<string, any> = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
+  const doc = take(data, {
+    serviceName: __expectString,
+  });
+  Object.assign(contents, doc);
+  return contents;
+};
+
 /**
  * deserializeAws_restJson1ListClustersCommand
  */
diff --git a/codegen/sdk-codegen/aws-models/dsql.json b/codegen/sdk-codegen/aws-models/dsql.json
