@aws-sdk/client-eks/dist-types/commands/DescribeClusterVersionsCommand.d.ts

AWS SDK for JavaScript Eks Client for Node.js, Browser and React Native

import { Command as $Command } from "@smithy/smithy-client";
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
import { EKSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EKSClient";
import { DescribeClusterVersionsRequest, DescribeClusterVersionsResponse } from "../models/models_0";
/**
 * @public
 */
export type { __MetadataBearer };
export { $Command };
/**
 * @public
 *
 * The input for {@link DescribeClusterVersionsCommand}.
 */
export interface DescribeClusterVersionsCommandInput extends DescribeClusterVersionsRequest {
}
/**
 * @public
 *
 * The output of {@link DescribeClusterVersionsCommand}.
 */
export interface DescribeClusterVersionsCommandOutput extends DescribeClusterVersionsResponse, __MetadataBearer {
}
declare const DescribeClusterVersionsCommand_base: {
    new (input: DescribeClusterVersionsCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeClusterVersionsCommandInput, DescribeClusterVersionsCommandOutput, EKSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
    new (...[input]: [] | [DescribeClusterVersionsCommandInput]): import("@smithy/smithy-client").CommandImpl<DescribeClusterVersionsCommandInput, DescribeClusterVersionsCommandOutput, EKSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
};
/**
 * <p>Lists available Kubernetes versions for Amazon EKS clusters.</p>
 * @example
 * Use a bare-bones client and the command you need to make an API call.
 * ```javascript
 * import { EKSClient, DescribeClusterVersionsCommand } from "@aws-sdk/client-eks"; // ES Modules import
 * // const { EKSClient, DescribeClusterVersionsCommand } = require("@aws-sdk/client-eks"); // CommonJS import
 * const client = new EKSClient(config);
 * const input = { // DescribeClusterVersionsRequest
 *   clusterType: "STRING_VALUE",
 *   maxResults: Number("int"),
 *   nextToken: "STRING_VALUE",
 *   defaultOnly: true || false,
 *   includeAll: true || false,
 *   clusterVersions: [ // StringList
 *     "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);
 * // { // DescribeClusterVersionsResponse
 * //   nextToken: "STRING_VALUE",
 * //   clusterVersions: [ // ClusterVersionList
 * //     { // ClusterVersionInformation
 * //       clusterVersion: "STRING_VALUE",
 * //       clusterType: "STRING_VALUE",
 * //       defaultPlatformVersion: "STRING_VALUE",
 * //       defaultVersion: true || false,
 * //       releaseDate: new Date("TIMESTAMP"),
 * //       endOfStandardSupportDate: new Date("TIMESTAMP"),
 * //       endOfExtendedSupportDate: new Date("TIMESTAMP"),
 * //       status: "unsupported" || "standard-support" || "extended-support",
 * //       versionStatus: "UNSUPPORTED" || "STANDARD_SUPPORT" || "EXTENDED_SUPPORT",
 * //       kubernetesPatchVersion: "STRING_VALUE",
 * //     },
 * //   ],
 * // };
 *
 * ```
 *
 * @param DescribeClusterVersionsCommandInput - {@link DescribeClusterVersionsCommandInput}
 * @returns {@link DescribeClusterVersionsCommandOutput}
 * @see {@link DescribeClusterVersionsCommandInput} for command's `input` shape.
 * @see {@link DescribeClusterVersionsCommandOutput} for command's `response` shape.
 * @see {@link EKSClientResolvedConfig | config} for EKSClient's `config` shape.
 *
 * @throws {@link InvalidParameterException} (client fault)
 *  <p>The specified parameter is invalid. Review the available parameters for the API
 *             request.</p>
 *
 * @throws {@link InvalidRequestException} (client fault)
 *  <p>The request is invalid given the state of the cluster. Check the state of the cluster
 *             and the associated operations.</p>
 *
 * @throws {@link ServerException} (server fault)
 *  <p>These errors are usually caused by a server-side issue.</p>
 *
 * @throws {@link EKSServiceException}
 * <p>Base exception class for all service exceptions from EKS service.</p>
 *
 * @public
 */
export declare class DescribeClusterVersionsCommand extends DescribeClusterVersionsCommand_base {
    /** @internal type navigation helper, not in runtime. */
    protected static __types: {
        api: {
            input: DescribeClusterVersionsRequest;
            output: DescribeClusterVersionsResponse;
        };
        sdk: {
            input: DescribeClusterVersionsCommandInput;
            output: DescribeClusterVersionsCommandOutput;
        };
    };
}