UNPKG

@aws-sdk/client-eks

Version:

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

98 lines (97 loc) 4.2 kB
import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { EKSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EKSClient"; import { ListUpdatesRequest, ListUpdatesResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link ListUpdatesCommand}. */ export interface ListUpdatesCommandInput extends ListUpdatesRequest { } /** * @public * * The output of {@link ListUpdatesCommand}. */ export interface ListUpdatesCommandOutput extends ListUpdatesResponse, __MetadataBearer { } declare const ListUpdatesCommand_base: { new (input: ListUpdatesCommandInput): import("@smithy/smithy-client").CommandImpl<ListUpdatesCommandInput, ListUpdatesCommandOutput, EKSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; new (__0_0: ListUpdatesCommandInput): import("@smithy/smithy-client").CommandImpl<ListUpdatesCommandInput, ListUpdatesCommandOutput, EKSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** * <p>Lists the updates associated with an Amazon EKS resource in your Amazon Web Services account, in the * specified Amazon Web Services Region.</p> * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { EKSClient, ListUpdatesCommand } from "@aws-sdk/client-eks"; // ES Modules import * // const { EKSClient, ListUpdatesCommand } = require("@aws-sdk/client-eks"); // CommonJS import * const client = new EKSClient(config); * const input = { // ListUpdatesRequest * name: "STRING_VALUE", // required * nodegroupName: "STRING_VALUE", * addonName: "STRING_VALUE", * nextToken: "STRING_VALUE", * maxResults: Number("int"), * }; * const command = new ListUpdatesCommand(input); * const response = await client.send(command); * // { // ListUpdatesResponse * // updateIds: [ // StringList * // "STRING_VALUE", * // ], * // nextToken: "STRING_VALUE", * // }; * * ``` * * @param ListUpdatesCommandInput - {@link ListUpdatesCommandInput} * @returns {@link ListUpdatesCommandOutput} * @see {@link ListUpdatesCommandInput} for command's `input` shape. * @see {@link ListUpdatesCommandOutput} for command's `response` shape. * @see {@link EKSClientResolvedConfig | config} for EKSClient's `config` shape. * * @throws {@link ClientException} (client fault) * <p>These errors are usually caused by a client action. Actions can include using an * action or resource on behalf of an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html">IAM principal</a> that doesn't have permissions to use * the action or resource or specifying an identifier that is not valid.</p> * * @throws {@link InvalidParameterException} (client fault) * <p>The specified parameter is invalid. Review the available parameters for the API * request.</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 ListUpdatesCommand extends ListUpdatesCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: ListUpdatesRequest; output: ListUpdatesResponse; }; sdk: { input: ListUpdatesCommandInput; output: ListUpdatesCommandOutput; }; }; }