@aws-sdk/client-eks
Version:
AWS SDK for JavaScript Eks Client for Node.js, Browser and React Native
106 lines (105 loc) • 4.92 kB
TypeScript
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 { ListIdentityProviderConfigsRequest, ListIdentityProviderConfigsResponse } from "../models/models_0";
/**
* @public
*/
export type { __MetadataBearer };
export { $Command };
/**
* @public
*
* The input for {@link ListIdentityProviderConfigsCommand}.
*/
export interface ListIdentityProviderConfigsCommandInput extends ListIdentityProviderConfigsRequest {
}
/**
* @public
*
* The output of {@link ListIdentityProviderConfigsCommand}.
*/
export interface ListIdentityProviderConfigsCommandOutput extends ListIdentityProviderConfigsResponse, __MetadataBearer {
}
declare const ListIdentityProviderConfigsCommand_base: {
new (input: ListIdentityProviderConfigsCommandInput): import("@smithy/core/client").CommandImpl<ListIdentityProviderConfigsCommandInput, ListIdentityProviderConfigsCommandOutput, EKSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
new (input: ListIdentityProviderConfigsCommandInput): import("@smithy/core/client").CommandImpl<ListIdentityProviderConfigsCommandInput, ListIdentityProviderConfigsCommandOutput, EKSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
getEndpointParameterInstructions(): {
[x: string]: unknown;
};
};
/**
* <p>Lists the identity provider configurations for your cluster.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { EKSClient, ListIdentityProviderConfigsCommand } from "@aws-sdk/client-eks"; // ES Modules import
* // const { EKSClient, ListIdentityProviderConfigsCommand } = 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 = { // ListIdentityProviderConfigsRequest
* clusterName: "STRING_VALUE", // required
* maxResults: Number("int"),
* nextToken: "STRING_VALUE",
* };
* const command = new ListIdentityProviderConfigsCommand(input);
* const response = await client.send(command);
* // { // ListIdentityProviderConfigsResponse
* // identityProviderConfigs: [ // IdentityProviderConfigs
* // { // IdentityProviderConfig
* // type: "STRING_VALUE", // required
* // name: "STRING_VALUE", // required
* // },
* // ],
* // nextToken: "STRING_VALUE",
* // };
*
* ```
*
* @param ListIdentityProviderConfigsCommandInput - {@link ListIdentityProviderConfigsCommandInput}
* @returns {@link ListIdentityProviderConfigsCommandOutput}
* @see {@link ListIdentityProviderConfigsCommandInput} for command's `input` shape.
* @see {@link ListIdentityProviderConfigsCommandOutput} 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 ServiceUnavailableException} (server fault)
* <p>The service is unavailable. Back off and retry the operation.</p>
*
* @throws {@link EKSServiceException}
* <p>Base exception class for all service exceptions from EKS service.</p>
*
*
* @public
*/
export declare class ListIdentityProviderConfigsCommand extends ListIdentityProviderConfigsCommand_base {
/** @internal type navigation helper, not in runtime. */
protected static __types: {
api: {
input: ListIdentityProviderConfigsRequest;
output: ListIdentityProviderConfigsResponse;
};
sdk: {
input: ListIdentityProviderConfigsCommandInput;
output: ListIdentityProviderConfigsCommandOutput;
};
};
}