feat(client-kafka): Added a new API response field which determines i…

…f there is an action required from the customer regarding their cluster.
aws · Nov 16, 2023 · de549d0 · de549d0
1 parent 20b417d
commit de549d0
Show file tree

Hide file tree

Showing 7 changed files with 73 additions and 0 deletions.
diff --git a/clients/client-kafka/src/commands/DescribeClusterCommand.ts b/clients/client-kafka/src/commands/DescribeClusterCommand.ts
@@ -171,6 +171,7 @@ export interface DescribeClusterCommandOutput extends DescribeClusterResponse, _
  * //     ZookeeperConnectString: "STRING_VALUE",
  * //     ZookeeperConnectStringTls: "STRING_VALUE",
  * //     StorageMode: "LOCAL" || "TIERED",
+ * //     CustomerActionStatus: "CRITICAL_ACTION_REQUIRED" || "ACTION_RECOMMENDED" || "NONE",
  * //   },
  * // };
  *

diff --git a/clients/client-kafka/src/commands/DescribeClusterV2Command.ts b/clients/client-kafka/src/commands/DescribeClusterV2Command.ts
@@ -173,6 +173,7 @@ export interface DescribeClusterV2CommandOutput extends DescribeClusterV2Respons
  * //       ZookeeperConnectString: "STRING_VALUE",
  * //       ZookeeperConnectStringTls: "STRING_VALUE",
  * //       StorageMode: "LOCAL" || "TIERED",
+ * //       CustomerActionStatus: "CRITICAL_ACTION_REQUIRED" || "ACTION_RECOMMENDED" || "NONE",
  * //     },
  * //     Serverless: { // Serverless
  * //       VpcConfigs: [ // __listOfVpcConfig // required

diff --git a/clients/client-kafka/src/commands/ListClustersCommand.ts b/clients/client-kafka/src/commands/ListClustersCommand.ts
@@ -174,6 +174,7 @@ export interface ListClustersCommandOutput extends ListClustersResponse, __Metad
  * //       ZookeeperConnectString: "STRING_VALUE",
  * //       ZookeeperConnectStringTls: "STRING_VALUE",
  * //       StorageMode: "LOCAL" || "TIERED",
+ * //       CustomerActionStatus: "CRITICAL_ACTION_REQUIRED" || "ACTION_RECOMMENDED" || "NONE",
  * //     },
  * //   ],
  * //   NextToken: "STRING_VALUE",

diff --git a/clients/client-kafka/src/commands/ListClustersV2Command.ts b/clients/client-kafka/src/commands/ListClustersV2Command.ts
@@ -177,6 +177,7 @@ export interface ListClustersV2CommandOutput extends ListClustersV2Response, __M
  * //         ZookeeperConnectString: "STRING_VALUE",
  * //         ZookeeperConnectStringTls: "STRING_VALUE",
  * //         StorageMode: "LOCAL" || "TIERED",
+ * //         CustomerActionStatus: "CRITICAL_ACTION_REQUIRED" || "ACTION_RECOMMENDED" || "NONE",
  * //       },
  * //       Serverless: { // Serverless
  * //         VpcConfigs: [ // __listOfVpcConfig // required

diff --git a/clients/client-kafka/src/models/models_0.ts b/clients/client-kafka/src/models/models_0.ts
@@ -441,6 +441,21 @@ export interface BrokerSoftwareInfo {
   KafkaVersion?: string;
 }
 
+/**
+ * @public
+ * @enum
+ */
+export const CustomerActionStatus = {
+  ACTION_RECOMMENDED: "ACTION_RECOMMENDED",
+  CRITICAL_ACTION_REQUIRED: "CRITICAL_ACTION_REQUIRED",
+  NONE: "NONE",
+} as const;
+
+/**
+ * @public
+ */
+export type CustomerActionStatus = (typeof CustomerActionStatus)[keyof typeof CustomerActionStatus];
+
 /**
  * @public
  * <p>The data-volume encryption details.</p>
@@ -707,6 +722,12 @@ export interface Provisioned {
    * <p>This controls storage mode for supported storage tiers.</p>
    */
   StorageMode?: StorageMode;
+
+  /**
+   * @public
+   * <p>Determines if there is an action required from the customer.</p>
+   */
+  CustomerActionStatus?: CustomerActionStatus;
 }
 
 /**
@@ -1031,6 +1052,12 @@ export interface ClusterInfo {
    * <p>This controls storage mode for supported storage tiers.</p>
    */
   StorageMode?: StorageMode;
+
+  /**
+   * @public
+   * <p>Determines if there is an action required from the customer.</p>
+   */
+  CustomerActionStatus?: CustomerActionStatus;
 }
 
 /**

diff --git a/clients/client-kafka/src/protocols/Aws_restJson1.ts b/clients/client-kafka/src/protocols/Aws_restJson1.ts
@@ -6080,6 +6080,7 @@ const de_ClusterInfo = (output: any, context: __SerdeContext): ClusterInfo => {
     CreationTime: [, (_: any) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)), `creationTime`],
     CurrentBrokerSoftwareInfo: [, (_: any) => de_BrokerSoftwareInfo(_, context), `currentBrokerSoftwareInfo`],
     CurrentVersion: [, __expectString, `currentVersion`],
+    CustomerActionStatus: [, __expectString, `customerActionStatus`],
     EncryptionInfo: [, (_: any) => de_EncryptionInfo(_, context), `encryptionInfo`],
     EnhancedMonitoring: [, __expectString, `enhancedMonitoring`],
     LoggingInfo: [, (_: any) => de_LoggingInfo(_, context), `loggingInfo`],
@@ -6489,6 +6490,7 @@ const de_Provisioned = (output: any, context: __SerdeContext): Provisioned => {
     BrokerNodeGroupInfo: [, (_: any) => de_BrokerNodeGroupInfo(_, context), `brokerNodeGroupInfo`],
     ClientAuthentication: [, (_: any) => de_ClientAuthentication(_, context), `clientAuthentication`],
     CurrentBrokerSoftwareInfo: [, (_: any) => de_BrokerSoftwareInfo(_, context), `currentBrokerSoftwareInfo`],
+    CustomerActionStatus: [, __expectString, `customerActionStatus`],
     EncryptionInfo: [, (_: any) => de_EncryptionInfo(_, context), `encryptionInfo`],
     EnhancedMonitoring: [, __expectString, `enhancedMonitoring`],
     LoggingInfo: [, (_: any) => de_LoggingInfo(_, context), `loggingInfo`],

diff --git a/codegen/sdk-codegen/aws-models/kafka.json b/codegen/sdk-codegen/aws-models/kafka.json
@@ -791,6 +791,13 @@
             "smithy.api#documentation": "<p>This controls storage mode for supported storage tiers.</p>",
             "smithy.api#jsonName": "storageMode"
           }
+        },
+        "CustomerActionStatus": {
+          "target": "com.amazonaws.kafka#CustomerActionStatus",
+          "traits": {
+            "smithy.api#documentation": "<p>Determines if there is an action required from the customer.</p>",
+            "smithy.api#jsonName": "customerActionStatus"
+          }
         }
       },
       "traits": {
@@ -2191,6 +2198,32 @@
         "smithy.api#output": {}
       }
     },
+    "com.amazonaws.kafka#CustomerActionStatus": {
+      "type": "enum",
+      "members": {
+        "CRITICAL_ACTION_REQUIRED": {
+          "target": "smithy.api#Unit",
+          "traits": {
+            "smithy.api#enumValue": "CRITICAL_ACTION_REQUIRED"
+          }
+        },
+        "ACTION_RECOMMENDED": {
+          "target": "smithy.api#Unit",
+          "traits": {
+            "smithy.api#enumValue": "ACTION_RECOMMENDED"
+          }
+        },
+        "NONE": {
+          "target": "smithy.api#Unit",
+          "traits": {
+            "smithy.api#enumValue": "NONE"
+          }
+        }
+      },
+      "traits": {
+        "smithy.api#documentation": "<p>A type of an action required from the customer.</p>"
+      }
+    },
     "com.amazonaws.kafka#DeleteCluster": {
       "type": "operation",
       "input": {
@@ -6631,6 +6664,13 @@
             "smithy.api#documentation": "<p>This controls storage mode for supported storage tiers.</p>",
             "smithy.api#jsonName": "storageMode"
           }
+        },
+        "CustomerActionStatus": {
+          "target": "com.amazonaws.kafka#CustomerActionStatus",
+          "traits": {
+            "smithy.api#documentation": "<p>Determines if there is an action required from the customer.</p>",
+            "smithy.api#jsonName": "customerActionStatus"
+          }
         }
       },
       "traits": {