import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; import type { ListInstancesRequest, ListInstancesResponse } from "../models/models_2"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link ListInstancesCommand}. */ export interface ListInstancesCommandInput extends ListInstancesRequest { } /** * @public * * The output of {@link ListInstancesCommand}. */ export interface ListInstancesCommandOutput extends ListInstancesResponse, __MetadataBearer { } declare const ListInstancesCommand_base: { new (input: ListInstancesCommandInput): import("@smithy/smithy-client").CommandImpl; new (...[input]: [] | [ListInstancesCommandInput]): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

This API is in preview release for Amazon Connect and is subject to change.

*

Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances * that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance * API was invoked.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { ConnectClient, ListInstancesCommand } from "@aws-sdk/client-connect"; // ES Modules import * // const { ConnectClient, ListInstancesCommand } = require("@aws-sdk/client-connect"); // CommonJS import * // import type { ConnectClientConfig } from "@aws-sdk/client-connect"; * const config = {}; // type is ConnectClientConfig * const client = new ConnectClient(config); * const input = { // ListInstancesRequest * NextToken: "STRING_VALUE", * MaxResults: Number("int"), * }; * const command = new ListInstancesCommand(input); * const response = await client.send(command); * // { // ListInstancesResponse * // InstanceSummaryList: [ // InstanceSummaryList * // { // InstanceSummary * // Id: "STRING_VALUE", * // Arn: "STRING_VALUE", * // IdentityManagementType: "SAML" || "CONNECT_MANAGED" || "EXISTING_DIRECTORY", * // InstanceAlias: "STRING_VALUE", * // CreatedTime: new Date("TIMESTAMP"), * // ServiceRole: "STRING_VALUE", * // InstanceStatus: "CREATION_IN_PROGRESS" || "ACTIVE" || "CREATION_FAILED", * // InboundCallsEnabled: true || false, * // OutboundCallsEnabled: true || false, * // InstanceAccessUrl: "STRING_VALUE", * // }, * // ], * // NextToken: "STRING_VALUE", * // }; * * ``` * * @param ListInstancesCommandInput - {@link ListInstancesCommandInput} * @returns {@link ListInstancesCommandOutput} * @see {@link ListInstancesCommandInput} for command's `input` shape. * @see {@link ListInstancesCommandOutput} for command's `response` shape. * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape. * * @throws {@link InternalServiceException} (server fault) *

Request processing failed because of an error or failure with the service.

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

The request is not valid.

* * @throws {@link ConnectServiceException} *

Base exception class for all service exceptions from Connect service.

* * * @public */ export declare class ListInstancesCommand extends ListInstancesCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: ListInstancesRequest; output: ListInstancesResponse; }; sdk: { input: ListInstancesCommandInput; output: ListInstancesCommandOutput; }; }; }