import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { ListKxEnvironmentsRequest, ListKxEnvironmentsResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link ListKxEnvironmentsCommand}. */ export interface ListKxEnvironmentsCommandInput extends ListKxEnvironmentsRequest { } /** * @public * * The output of {@link ListKxEnvironmentsCommand}. */ export interface ListKxEnvironmentsCommandOutput extends ListKxEnvironmentsResponse, __MetadataBearer { } declare const ListKxEnvironmentsCommand_base: { new (input: ListKxEnvironmentsCommandInput): import("@smithy/core/client").CommandImpl; new (...[input]: [] | [ListKxEnvironmentsCommandInput]): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Returns a list of kdb environments created in an account.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { FinspaceClient, ListKxEnvironmentsCommand } from "@aws-sdk/client-finspace"; // ES Modules import * // const { FinspaceClient, ListKxEnvironmentsCommand } = require("@aws-sdk/client-finspace"); // CommonJS import * // import type { FinspaceClientConfig } from "@aws-sdk/client-finspace"; * const config = {}; // type is FinspaceClientConfig * const client = new FinspaceClient(config); * const input = { // ListKxEnvironmentsRequest * nextToken: "STRING_VALUE", * maxResults: Number("int"), * }; * const command = new ListKxEnvironmentsCommand(input); * const response = await client.send(command); * // { // ListKxEnvironmentsResponse * // environments: [ // KxEnvironmentList * // { // KxEnvironment * // name: "STRING_VALUE", * // environmentId: "STRING_VALUE", * // awsAccountId: "STRING_VALUE", * // status: "CREATE_REQUESTED" || "CREATING" || "CREATED" || "DELETE_REQUESTED" || "DELETING" || "DELETED" || "FAILED_CREATION" || "RETRY_DELETION" || "FAILED_DELETION" || "UPDATE_NETWORK_REQUESTED" || "UPDATING_NETWORK" || "FAILED_UPDATING_NETWORK" || "SUSPENDED", * // tgwStatus: "NONE" || "UPDATE_REQUESTED" || "UPDATING" || "FAILED_UPDATE" || "SUCCESSFULLY_UPDATED", * // dnsStatus: "NONE" || "UPDATE_REQUESTED" || "UPDATING" || "FAILED_UPDATE" || "SUCCESSFULLY_UPDATED", * // errorMessage: "STRING_VALUE", * // description: "STRING_VALUE", * // environmentArn: "STRING_VALUE", * // kmsKeyId: "STRING_VALUE", * // dedicatedServiceAccountId: "STRING_VALUE", * // transitGatewayConfiguration: { // TransitGatewayConfiguration * // transitGatewayID: "STRING_VALUE", // required * // routableCIDRSpace: "STRING_VALUE", // required * // attachmentNetworkAclConfiguration: [ // NetworkACLConfiguration * // { // NetworkACLEntry * // ruleNumber: Number("int"), // required * // protocol: "STRING_VALUE", // required * // ruleAction: "allow" || "deny", // required * // portRange: { // PortRange * // from: Number("int"), // required * // to: Number("int"), // required * // }, * // icmpTypeCode: { // IcmpTypeCode * // type: Number("int"), // required * // code: Number("int"), // required * // }, * // cidrBlock: "STRING_VALUE", // required * // }, * // ], * // }, * // customDNSConfiguration: [ // CustomDNSConfiguration * // { // CustomDNSServer * // customDNSServerName: "STRING_VALUE", // required * // customDNSServerIP: "STRING_VALUE", // required * // }, * // ], * // creationTimestamp: new Date("TIMESTAMP"), * // updateTimestamp: new Date("TIMESTAMP"), * // availabilityZoneIds: [ // AvailabilityZoneIds * // "STRING_VALUE", * // ], * // certificateAuthorityArn: "STRING_VALUE", * // }, * // ], * // nextToken: "STRING_VALUE", * // }; * * ``` * * @param ListKxEnvironmentsCommandInput - {@link ListKxEnvironmentsCommandInput} * @returns {@link ListKxEnvironmentsCommandOutput} * @see {@link ListKxEnvironmentsCommandInput} for command's `input` shape. * @see {@link ListKxEnvironmentsCommandOutput} for command's `response` shape. * @see {@link FinspaceClientResolvedConfig | config} for FinspaceClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

You do not have sufficient access to perform this action.

* * @throws {@link InternalServerException} (server fault) *

The request processing has failed because of an unknown error, exception or * failure.

* * @throws {@link ValidationException} (client fault) *

The input fails to satisfy the constraints specified by an AWS service.

* * @throws {@link FinspaceServiceException} *

Base exception class for all service exceptions from Finspace service.

* * * @public */ export declare class ListKxEnvironmentsCommand extends ListKxEnvironmentsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: ListKxEnvironmentsRequest; output: ListKxEnvironmentsResponse; }; sdk: { input: ListKxEnvironmentsCommandInput; output: ListKxEnvironmentsCommandOutput; }; }; }