feat(client-redshift): LisRecommendations API to fetch Amazon Redshift Advisor recommendations.

Author: awstools

clients/client-redshift/README.md

@@ -44,16 +44,16 @@ using your favorite package manager:
 
 The AWS SDK is modulized by clients and commands.
 To send a request, you only need to import the `RedshiftClient` and
-the commands you need, for example `DescribeClustersCommand`:
+the commands you need, for example `ListRecommendationsCommand`:
 
 ```js
 // ES5 example
-const { RedshiftClient, DescribeClustersCommand } = require("@aws-sdk/client-redshift");
+const { RedshiftClient, ListRecommendationsCommand } = require("@aws-sdk/client-redshift");
 ```
 
 ```ts
 // ES6+ example
-import { RedshiftClient, DescribeClustersCommand } from "@aws-sdk/client-redshift";
+import { RedshiftClient, ListRecommendationsCommand } from "@aws-sdk/client-redshift";
 ```
 
 ### Usage
@@ -72,7 +72,7 @@ const client = new RedshiftClient({ region: "REGION" });
 const params = {
   /** input parameters */
 };
-const command = new DescribeClustersCommand(params);
+const command = new ListRecommendationsCommand(params);
 ```
 
 #### Async/await
@@ -151,15 +151,15 @@ const client = new AWS.Redshift({ region: "REGION" });
 
 // async/await.
 try {
-  const data = await client.describeClusters(params);
+  const data = await client.listRecommendations(params);
   // process data.
 } catch (error) {
   // error handling.
 }
 
 // Promises.
 client
-  .describeClusters(params)
+  .listRecommendations(params)
   .then((data) => {
     // process data.
   })
@@ -168,7 +168,7 @@ client
   });
 
 // callbacks.
-client.describeClusters(params, (err, data) => {
+client.listRecommendations(params, (err, data) => {
   // process err and data.
 });
 ```
@@ -1015,6 +1015,14 @@ GetResourcePolicy
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/redshift/command/GetResourcePolicyCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-redshift/Interface/GetResourcePolicyCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-redshift/Interface/GetResourcePolicyCommandOutput/)
 
+</details>
+<details>
+<summary>
+ListRecommendations
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/redshift/command/ListRecommendationsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-redshift/Interface/ListRecommendationsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-redshift/Interface/ListRecommendationsCommandOutput/)
+
 </details>
 <details>
 <summary>

clients/client-redshift/src/Redshift.ts

@@ -485,6 +485,11 @@ import {
   GetResourcePolicyCommandInput,
   GetResourcePolicyCommandOutput,
 } from "./commands/GetResourcePolicyCommand";
+import {
+  ListRecommendationsCommand,
+  ListRecommendationsCommandInput,
+  ListRecommendationsCommandOutput,
+} from "./commands/ListRecommendationsCommand";
 import {
   ModifyAquaConfigurationCommand,
   ModifyAquaConfigurationCommandInput,
@@ -752,6 +757,7 @@ const commands = {
   GetReservedNodeExchangeConfigurationOptionsCommand,
   GetReservedNodeExchangeOfferingsCommand,
   GetResourcePolicyCommand,
+  ListRecommendationsCommand,
   ModifyAquaConfigurationCommand,
   ModifyAuthenticationProfileCommand,
   ModifyClusterCommand,
@@ -2405,6 +2411,23 @@ export interface Redshift {
     cb: (err: any, data?: GetResourcePolicyCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link ListRecommendationsCommand}
+   */
+  listRecommendations(
+    args: ListRecommendationsCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<ListRecommendationsCommandOutput>;
+  listRecommendations(
+    args: ListRecommendationsCommandInput,
+    cb: (err: any, data?: ListRecommendationsCommandOutput) => void
+  ): void;
+  listRecommendations(
+    args: ListRecommendationsCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: ListRecommendationsCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link ModifyAquaConfigurationCommand}
    */

clients/client-redshift/src/RedshiftClient.ts

@@ -381,6 +381,10 @@ import {
   GetReservedNodeExchangeOfferingsCommandOutput,
 } from "./commands/GetReservedNodeExchangeOfferingsCommand";
 import { GetResourcePolicyCommandInput, GetResourcePolicyCommandOutput } from "./commands/GetResourcePolicyCommand";
+import {
+  ListRecommendationsCommandInput,
+  ListRecommendationsCommandOutput,
+} from "./commands/ListRecommendationsCommand";
 import {
   ModifyAquaConfigurationCommandInput,
   ModifyAquaConfigurationCommandOutput,
@@ -603,6 +607,7 @@ export type ServiceInputTypes =
   | GetReservedNodeExchangeConfigurationOptionsCommandInput
   | GetReservedNodeExchangeOfferingsCommandInput
   | GetResourcePolicyCommandInput
+  | ListRecommendationsCommandInput
   | ModifyAquaConfigurationCommandInput
   | ModifyAuthenticationProfileCommandInput
   | ModifyClusterCommandInput
@@ -740,6 +745,7 @@ export type ServiceOutputTypes =
   | GetReservedNodeExchangeConfigurationOptionsCommandOutput
   | GetReservedNodeExchangeOfferingsCommandOutput
   | GetResourcePolicyCommandOutput
+  | ListRecommendationsCommandOutput
   | ModifyAquaConfigurationCommandOutput
   | ModifyAuthenticationProfileCommandOutput
   | ModifyClusterCommandOutput

clients/client-redshift/src/commands/ListRecommendationsCommand.ts

@@ -0,0 +1,119 @@
+// 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 { commonParams } from "../endpoint/EndpointParameters";
+import { ListRecommendationsMessage, ListRecommendationsResult } from "../models/models_1";
+import { de_ListRecommendationsCommand, se_ListRecommendationsCommand } from "../protocols/Aws_query";
+import { RedshiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RedshiftClient";
+
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListRecommendationsCommand}.
+ */
+export interface ListRecommendationsCommandInput extends ListRecommendationsMessage {}
+/**
+ * @public
+ *
+ * The output of {@link ListRecommendationsCommand}.
+ */
+export interface ListRecommendationsCommandOutput extends ListRecommendationsResult, __MetadataBearer {}
+
+/**
+ * @public
+ * <p>List the Amazon Redshift Advisor recommendations for one or multiple Amazon Redshift clusters in an Amazon Web Services account.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { RedshiftClient, ListRecommendationsCommand } from "@aws-sdk/client-redshift"; // ES Modules import
+ * // const { RedshiftClient, ListRecommendationsCommand } = require("@aws-sdk/client-redshift"); // CommonJS import
+ * const client = new RedshiftClient(config);
+ * const input = { // ListRecommendationsMessage
+ *   ClusterIdentifier: "STRING_VALUE",
+ *   NamespaceArn: "STRING_VALUE",
+ *   MaxRecords: Number("int"),
+ *   Marker: "STRING_VALUE",
+ * };
+ * const command = new ListRecommendationsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListRecommendationsResult
+ * //   Recommendations: [ // RecommendationList
+ * //     { // Recommendation
+ * //       Id: "STRING_VALUE",
+ * //       ClusterIdentifier: "STRING_VALUE",
+ * //       NamespaceArn: "STRING_VALUE",
+ * //       CreatedAt: new Date("TIMESTAMP"),
+ * //       RecommendationType: "STRING_VALUE",
+ * //       Title: "STRING_VALUE",
+ * //       Description: "STRING_VALUE",
+ * //       Observation: "STRING_VALUE",
+ * //       ImpactRanking: "HIGH" || "MEDIUM" || "LOW",
+ * //       RecommendationText: "STRING_VALUE",
+ * //       RecommendedActions: [ // RecommendedActionList
+ * //         { // RecommendedAction
+ * //           Text: "STRING_VALUE",
+ * //           Database: "STRING_VALUE",
+ * //           Command: "STRING_VALUE",
+ * //           Type: "SQL" || "CLI",
+ * //         },
+ * //       ],
+ * //       ReferenceLinks: [ // ReferenceLinkList
+ * //         { // ReferenceLink
+ * //           Text: "STRING_VALUE",
+ * //           Link: "STRING_VALUE",
+ * //         },
+ * //       ],
+ * //     },
+ * //   ],
+ * //   Marker: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListRecommendationsCommandInput - {@link ListRecommendationsCommandInput}
+ * @returns {@link ListRecommendationsCommandOutput}
+ * @see {@link ListRecommendationsCommandInput} for command's `input` shape.
+ * @see {@link ListRecommendationsCommandOutput} for command's `response` shape.
+ * @see {@link RedshiftClientResolvedConfig | config} for RedshiftClient's `config` shape.
+ *
+ * @throws {@link ClusterNotFoundFault} (client fault)
+ *  <p>The <code>ClusterIdentifier</code> parameter does not refer to an existing cluster.
+ *         </p>
+ *
+ * @throws {@link UnsupportedOperationFault} (client fault)
+ *  <p>The requested operation isn't supported.</p>
+ *
+ * @throws {@link RedshiftServiceException}
+ * <p>Base exception class for all service exceptions from Redshift service.</p>
+ *
+ */
+export class ListRecommendationsCommand extends $Command
+  .classBuilder<
+    ListRecommendationsCommandInput,
+    ListRecommendationsCommandOutput,
+    RedshiftClientResolvedConfig,
+    ServiceInputTypes,
+    ServiceOutputTypes
+  >()
+  .ep({
+    ...commonParams,
+  })
+  .m(function (this: any, Command: any, cs: any, config: RedshiftClientResolvedConfig, o: any) {
+    return [
+      getSerdePlugin(config, this.serialize, this.deserialize),
+      getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
+    ];
+  })
+  .s("RedshiftServiceVersion20121201", "ListRecommendations", {})
+  .n("RedshiftClient", "ListRecommendationsCommand")
+  .f(void 0, void 0)
+  .ser(se_ListRecommendationsCommand)
+  .de(de_ListRecommendationsCommand)
+  .build() {}

clients/client-redshift/src/commands/index.ts

@@ -98,6 +98,7 @@ export * from "./GetClusterCredentialsWithIAMCommand";
 export * from "./GetReservedNodeExchangeConfigurationOptionsCommand";
 export * from "./GetReservedNodeExchangeOfferingsCommand";
 export * from "./GetResourcePolicyCommand";
+export * from "./ListRecommendationsCommand";
 export * from "./ModifyAquaConfigurationCommand";
 export * from "./ModifyAuthenticationProfileCommand";
 export * from "./ModifyClusterCommand";