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

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

import { Command as $Command } from "@smithy/core/client";
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
import type { EKSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EKSClient";
import type { DescribeInsightsRefreshRequest, DescribeInsightsRefreshResponse } from "../models/models_0";
/**
 * @public
 */
export type { __MetadataBearer };
export { $Command };
/**
 * @public
 *
 * The input for {@link DescribeInsightsRefreshCommand}.
 */
export interface DescribeInsightsRefreshCommandInput extends DescribeInsightsRefreshRequest {
}
/**
 * @public
 *
 * The output of {@link DescribeInsightsRefreshCommand}.
 */
export interface DescribeInsightsRefreshCommandOutput extends DescribeInsightsRefreshResponse, __MetadataBearer {
}
declare const DescribeInsightsRefreshCommand_base: {
    new (input: DescribeInsightsRefreshCommandInput): import("@smithy/core/client").CommandImpl<DescribeInsightsRefreshCommandInput, DescribeInsightsRefreshCommandOutput, EKSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
    new (input: DescribeInsightsRefreshCommandInput): import("@smithy/core/client").CommandImpl<DescribeInsightsRefreshCommandInput, DescribeInsightsRefreshCommandOutput, EKSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
    getEndpointParameterInstructions(): {
        [x: string]: unknown;
    };
};
/**
 * <p>Returns the status of the latest on-demand cluster insights refresh operation.</p>
 * @example
 * Use a bare-bones client and the command you need to make an API call.
 * ```javascript
 * import { EKSClient, DescribeInsightsRefreshCommand } from "@aws-sdk/client-eks"; // ES Modules import
 * // const { EKSClient, DescribeInsightsRefreshCommand } = require("@aws-sdk/client-eks"); // CommonJS import
 * // import type { EKSClientConfig } from "@aws-sdk/client-eks";
 * const config = {}; // type is EKSClientConfig
 * const client = new EKSClient(config);
 * const input = { // DescribeInsightsRefreshRequest
 *   clusterName: "STRING_VALUE", // required
 * };
 * const command = new DescribeInsightsRefreshCommand(input);
 * const response = await client.send(command);
 * // { // DescribeInsightsRefreshResponse
 * //   message: "STRING_VALUE",
 * //   status: "IN_PROGRESS" || "FAILED" || "COMPLETED",
 * //   startedAt: new Date("TIMESTAMP"),
 * //   endedAt: new Date("TIMESTAMP"),
 * // };
 *
 * ```
 *
 * @param DescribeInsightsRefreshCommandInput - {@link DescribeInsightsRefreshCommandInput}
 * @returns {@link DescribeInsightsRefreshCommandOutput}
 * @see {@link DescribeInsightsRefreshCommandInput} for command's `input` shape.
 * @see {@link DescribeInsightsRefreshCommandOutput} 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 ResourceNotFoundException} (client fault)
 *  <p>The specified resource could not be found. You can view your available clusters with
 *                 <code>ListClusters</code>. You can view your available managed node groups with
 *                 <code>ListNodegroups</code>. Amazon EKS clusters and node groups are Amazon Web Services Region
 *             specific.</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 DescribeInsightsRefreshCommand extends DescribeInsightsRefreshCommand_base {
    /** @internal type navigation helper, not in runtime. */
    protected static __types: {
        api: {
            input: DescribeInsightsRefreshRequest;
            output: DescribeInsightsRefreshResponse;
        };
        sdk: {
            input: DescribeInsightsRefreshCommandInput;
            output: DescribeInsightsRefreshCommandOutput;
        };
    };
}