@aws-sdk/client-eks/dist-types/commands/ListInsightsCommand.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 { ListInsightsRequest, ListInsightsResponse } from "../models/models_0";
/**
 * @public
 */
export type { __MetadataBearer };
export { $Command };
/**
 * @public
 *
 * The input for {@link ListInsightsCommand}.
 */
export interface ListInsightsCommandInput extends ListInsightsRequest {
}
/**
 * @public
 *
 * The output of {@link ListInsightsCommand}.
 */
export interface ListInsightsCommandOutput extends ListInsightsResponse, __MetadataBearer {
}
declare const ListInsightsCommand_base: {
    new (input: ListInsightsCommandInput): import("@smithy/core/client").CommandImpl<ListInsightsCommandInput, ListInsightsCommandOutput, EKSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
    new (input: ListInsightsCommandInput): import("@smithy/core/client").CommandImpl<ListInsightsCommandInput, ListInsightsCommandOutput, EKSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
    getEndpointParameterInstructions(): {
        [x: string]: unknown;
    };
};
/**
 * <p>Returns a list of all insights checked for against the specified cluster. You can
 *             filter which insights are returned by category, associated Kubernetes version, and
 *             status. The default filter lists all categories and every status.</p>
 *          <p>The following lists the available categories:</p>
 *          <ul>
 *             <li>
 *                <p>
 *                   <code>UPGRADE_READINESS</code>: Amazon EKS identifies issues that could impact your
 *                     ability to upgrade to new versions of Kubernetes. These are called upgrade insights.</p>
 *             </li>
 *             <li>
 *                <p>
 *                   <code>MISCONFIGURATION</code>: Amazon EKS identifies misconfiguration in your EKS
 *                     Hybrid Nodes setup that could impair functionality of your cluster or
 *                     workloads. These are called configuration insights.</p>
 *             </li>
 *          </ul>
 * @example
 * Use a bare-bones client and the command you need to make an API call.
 * ```javascript
 * import { EKSClient, ListInsightsCommand } from "@aws-sdk/client-eks"; // ES Modules import
 * // const { EKSClient, ListInsightsCommand } = 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 = { // ListInsightsRequest
 *   clusterName: "STRING_VALUE", // required
 *   filter: { // InsightsFilter
 *     categories: [ // CategoryList
 *       "UPGRADE_READINESS" || "MISCONFIGURATION",
 *     ],
 *     kubernetesVersions: [ // StringList
 *       "STRING_VALUE",
 *     ],
 *     statuses: [ // InsightStatusValueList
 *       "PASSING" || "WARNING" || "ERROR" || "UNKNOWN",
 *     ],
 *   },
 *   maxResults: Number("int"),
 *   nextToken: "STRING_VALUE",
 * };
 * const command = new ListInsightsCommand(input);
 * const response = await client.send(command);
 * // { // ListInsightsResponse
 * //   insights: [ // InsightSummaries
 * //     { // InsightSummary
 * //       id: "STRING_VALUE",
 * //       name: "STRING_VALUE",
 * //       category: "UPGRADE_READINESS" || "MISCONFIGURATION",
 * //       kubernetesVersion: "STRING_VALUE",
 * //       lastRefreshTime: new Date("TIMESTAMP"),
 * //       lastTransitionTime: new Date("TIMESTAMP"),
 * //       description: "STRING_VALUE",
 * //       insightStatus: { // InsightStatus
 * //         status: "PASSING" || "WARNING" || "ERROR" || "UNKNOWN",
 * //         reason: "STRING_VALUE",
 * //       },
 * //     },
 * //   ],
 * //   nextToken: "STRING_VALUE",
 * // };
 *
 * ```
 *
 * @param ListInsightsCommandInput - {@link ListInsightsCommandInput}
 * @returns {@link ListInsightsCommandOutput}
 * @see {@link ListInsightsCommandInput} for command's `input` shape.
 * @see {@link ListInsightsCommandOutput} 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 ListInsightsCommand extends ListInsightsCommand_base {
    /** @internal type navigation helper, not in runtime. */
    protected static __types: {
        api: {
            input: ListInsightsRequest;
            output: ListInsightsResponse;
        };
        sdk: {
            input: ListInsightsCommandInput;
            output: ListInsightsCommandOutput;
        };
    };
}