feat(client-eks): Introduce versionStatus field to take place of stat…

…us field in EKS DescribeClusterVersions API
aws · Feb 7, 2025 · 5b42130 · 5b42130
1 parent 5f0e21d
commit 5b42130
Show file tree

Hide file tree

Showing 8 changed files with 117 additions and 25 deletions.
diff --git a/clients/client-eks/src/commands/DescribeClusterVersionsCommand.ts b/clients/client-eks/src/commands/DescribeClusterVersionsCommand.ts
@@ -45,6 +45,7 @@ export interface DescribeClusterVersionsCommandOutput extends DescribeClusterVer
  *     "STRING_VALUE",
  *   ],
  *   status: "unsupported" || "standard-support" || "extended-support",
+ *   versionStatus: "UNSUPPORTED" || "STANDARD_SUPPORT" || "EXTENDED_SUPPORT",
  * };
  * const command = new DescribeClusterVersionsCommand(input);
  * const response = await client.send(command);
@@ -60,6 +61,7 @@ export interface DescribeClusterVersionsCommandOutput extends DescribeClusterVer
  * //       endOfStandardSupportDate: new Date("TIMESTAMP"),
  * //       endOfExtendedSupportDate: new Date("TIMESTAMP"),
  * //       status: "unsupported" || "standard-support" || "extended-support",
+ * //       versionStatus: "UNSUPPORTED" || "STANDARD_SUPPORT" || "EXTENDED_SUPPORT",
  * //       kubernetesPatchVersion: "STRING_VALUE",
  * //     },
  * //   ],

diff --git a/clients/client-eks/src/commands/DescribeUpdateCommand.ts b/clients/client-eks/src/commands/DescribeUpdateCommand.ts
@@ -29,7 +29,7 @@ export interface DescribeUpdateCommandOutput extends DescribeUpdateResponse, __M
 
 /**
  * <p>Describes an update to an Amazon EKS resource.</p>
- *          <p>When the status of the update is <code>Succeeded</code>, the update is complete. If an
+ *          <p>When the status of the update is <code>Successful</code>, the update is complete. If an
  *             update fails, the status is <code>Failed</code>, and an error detail explains the reason
  *             for the failure.</p>
  * @example

diff --git a/clients/client-eks/src/commands/RegisterClusterCommand.ts b/clients/client-eks/src/commands/RegisterClusterCommand.ts
@@ -31,9 +31,9 @@ export interface RegisterClusterCommandOutput extends RegisterClusterResponse, _
  * <p>Connects a Kubernetes cluster to the Amazon EKS control plane. </p>
  *          <p>Any Kubernetes cluster can be connected to the Amazon EKS control plane to view
  *             current information about the cluster and its nodes. </p>
- *          <p>Cluster connection requires two steps. First, send a <code>
- *                <a>RegisterClusterRequest</a>
- *             </code> to add it to the Amazon EKS
+ *          <p>Cluster connection requires two steps. First, send a <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_RegisterClusterRequest.html">
+ *                <code>RegisterClusterRequest</code>
+ *             </a> to add it to the Amazon EKS
  *             control plane.</p>
  *          <p>Second, a <a href="https://amazon-eks.s3.us-west-2.amazonaws.com/eks-connector/manifests/eks-connector/latest/eks-connector.yaml">Manifest</a> containing the <code>activationID</code> and
  *                 <code>activationCode</code> must be applied to the Kubernetes cluster through it's native

diff --git a/clients/client-eks/src/commands/UpdateClusterVersionCommand.ts b/clients/client-eks/src/commands/UpdateClusterVersionCommand.ts
@@ -30,7 +30,10 @@ export interface UpdateClusterVersionCommandOutput extends UpdateClusterVersionR
 /**
  * <p>Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster
  *             continues to function during the update. The response output includes an update ID that
- *             you can use to track the status of your cluster update with the <a>DescribeUpdate</a> API operation.</p>
+ *             you can use to track the status of your cluster update with the
+ *             <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeUpdate.html">
+ *                <code>DescribeUpdate</code>
+ *             </a> API operation.</p>
  *          <p>Cluster updates are asynchronous, and they should finish within a few minutes. During
  *             an update, the cluster status moves to <code>UPDATING</code> (this status transition is
  *             eventually consistent). When the update is complete (either <code>Failed</code> or

diff --git a/clients/client-eks/src/commands/UpdateNodegroupConfigCommand.ts b/clients/client-eks/src/commands/UpdateNodegroupConfigCommand.ts
@@ -30,7 +30,10 @@ export interface UpdateNodegroupConfigCommandOutput extends UpdateNodegroupConfi
 /**
  * <p>Updates an Amazon EKS managed node group configuration. Your node group
  *             continues to function during the update. The response output includes an update ID that
- *             you can use to track the status of your node group update with the <a>DescribeUpdate</a> API operation. You can update the Kubernetes labels and taints
+ *             you can use to track the status of your node group update with the
+ *             <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeUpdate.html">
+ *                <code>DescribeUpdate</code>
+ *             </a> API operation. You can update the Kubernetes labels and taints
  *             for a node group and the scaling and version update configuration.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-eks/src/models/models_0.ts b/clients/client-eks/src/models/models_0.ts
@@ -1671,7 +1671,9 @@ export interface CreateAddonRequest {
    *                     option. If the self-managed version of the add-on is installed on your cluster
    *                         Amazon EKS doesn't change the add-on resource properties. Creation
    *                     of the add-on might fail if conflicts are detected. This option works
-   *                     differently during the update operation. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateAddon.html">UpdateAddon</a>.</p>
+   *                     differently during the update operation. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateAddon.html">
+   *                      <code>UpdateAddon</code>
+   *                   </a>.</p>
    *             </li>
    *          </ul>
    *          <p>If you don't currently have the self-managed version of the add-on installed on your
@@ -3794,7 +3796,9 @@ export interface NodegroupUpdateConfig {
   /**
    * <p>The configuration for the behavior to follow during a node group version update of this managed
    *             node group. You choose between two possible strategies for replacing nodes during an
-   *                 <a href="https://docs.aws.amazon.com/latest/APIReference/API_UpdateNodegroupVersion.html">UpdateNodegroupVersion</a> action.</p>
+   *                 <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateNodegroupVersion.html">
+   *                <code>UpdateNodegroupVersion</code>
+   *             </a> action.</p>
    *          <p>An Amazon EKS managed node group updates by replacing nodes with new nodes of newer AMI
    *             versions in parallel. The <i>update strategy</i> changes the managed node
    *             update behavior of the managed node group for each quantity. The
@@ -5058,6 +5062,21 @@ export const ClusterVersionStatus = {
  */
 export type ClusterVersionStatus = (typeof ClusterVersionStatus)[keyof typeof ClusterVersionStatus];
 
+/**
+ * @public
+ * @enum
+ */
+export const VersionStatus = {
+  EXTENDED_SUPPORT: "EXTENDED_SUPPORT",
+  STANDARD_SUPPORT: "STANDARD_SUPPORT",
+  UNSUPPORTED: "UNSUPPORTED",
+} as const;
+
+/**
+ * @public
+ */
+export type VersionStatus = (typeof VersionStatus)[keyof typeof VersionStatus];
+
 /**
  * @public
  */
@@ -5099,10 +5118,22 @@ export interface DescribeClusterVersionsRequest {
   clusterVersions?: string[] | undefined;
 
   /**
-   * <p>Filter versions by their current status.</p>
+   * <important>
+   *             <p>This field is deprecated. Use <code>versionStatus</code> instead, as that field
+   *             matches for input and output of this action.</p>
+   *          </important>
+   *          <p>Filter versions by their current status.</p>
+   *
+   * @deprecated
    * @public
    */
   status?: ClusterVersionStatus | undefined;
+
+  /**
+   * <p>Filter versions by their current status.</p>
+   * @public
+   */
+  versionStatus?: VersionStatus | undefined;
 }
 
 /**
@@ -5153,11 +5184,21 @@ export interface ClusterVersionInformation {
   endOfExtendedSupportDate?: Date | undefined;
 
   /**
-   * <p>Current status of this cluster version.</p>
+   * <important>
+   *             <p>This field is deprecated. Use <code>versionStatus</code> instead, as that field
+   *                 matches for input and output of this action.</p>
+   *          </important>
+   *          <p>Current status of this cluster version.</p>
    * @public
    */
   status?: ClusterVersionStatus | undefined;
 
+  /**
+   * <p>Current status of this cluster version.</p>
+   * @public
+   */
+  versionStatus?: VersionStatus | undefined;
+
   /**
    * <p>The patch version of Kubernetes for this cluster version.</p>
    * @public
@@ -6589,9 +6630,9 @@ export interface ListPodIdentityAssociationsRequest {
 
 /**
  * <p>The summarized description of the association.</p>
- *          <p>Each summary is simplified by removing these fields compared to the full <code>
- *                <a>PodIdentityAssociation</a>
- *             </code>:</p>
+ *          <p>Each summary is simplified by removing these fields compared to the full <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_PodIdentityAssociation.html">
+ *                <code>PodIdentityAssociation</code>
+ *             </a>:</p>
  *          <ul>
  *             <li>
  *                <p>The IAM role: <code>roleArn</code>
@@ -6660,9 +6701,9 @@ export interface ListPodIdentityAssociationsResponse {
   /**
    * <p>The list of summarized descriptions of the associations that are in the cluster and match
    *             any filters that you provided.</p>
-   *          <p>Each summary is simplified by removing these fields compared to the full <code>
-   *                <a>PodIdentityAssociation</a>
-   *             </code>:</p>
+   *          <p>Each summary is simplified by removing these fields compared to the full <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_PodIdentityAssociation.html">
+   *                <code>PodIdentityAssociation</code>
+   *             </a>:</p>
    *          <ul>
    *             <li>
    *                <p>The IAM role: <code>roleArn</code>

diff --git a/clients/client-eks/src/protocols/Aws_restJson1.ts b/clients/client-eks/src/protocols/Aws_restJson1.ts
@@ -787,6 +787,7 @@ export const se_DescribeClusterVersionsCommand = async (
     [_iA]: [() => input.includeAll !== void 0, () => input[_iA]!.toString()],
     [_cV]: [() => input.clusterVersions !== void 0, () => input[_cV]! || []],
     [_s]: [, input[_s]!],
+    [_vS]: [, input[_vS]!],
   });
   let body: any;
   b.m("GET").h(headers).q(query).b(body);
@@ -3337,6 +3338,7 @@ const de_ClusterVersionInformation = (output: any, context: __SerdeContext): Clu
     kubernetesPatchVersion: __expectString,
     releaseDate: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
     status: __expectString,
+    versionStatus: __expectString,
   }) as any;
 };
 
@@ -3717,3 +3719,4 @@ const _s = "status";
 const _sA = "serviceAccount";
 const _t = "types";
 const _tK = "tagKeys";
+const _vS = "versionStatus";