import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { LightsailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LightsailClient"; import type { GetInstancesRequest, GetInstancesResult } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link GetInstancesCommand}. */ export interface GetInstancesCommandInput extends GetInstancesRequest { } /** * @public * * The output of {@link GetInstancesCommand}. */ export interface GetInstancesCommandOutput extends GetInstancesResult, __MetadataBearer { } declare const GetInstancesCommand_base: { new (input: GetInstancesCommandInput): import("@smithy/smithy-client").CommandImpl; new (...[input]: [] | [GetInstancesCommandInput]): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Returns information about all Amazon Lightsail virtual private servers, or * instances.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { LightsailClient, GetInstancesCommand } from "@aws-sdk/client-lightsail"; // ES Modules import * // const { LightsailClient, GetInstancesCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import * // import type { LightsailClientConfig } from "@aws-sdk/client-lightsail"; * const config = {}; // type is LightsailClientConfig * const client = new LightsailClient(config); * const input = { // GetInstancesRequest * pageToken: "STRING_VALUE", * }; * const command = new GetInstancesCommand(input); * const response = await client.send(command); * // { // GetInstancesResult * // instances: [ // InstanceList * // { // Instance * // name: "STRING_VALUE", * // arn: "STRING_VALUE", * // supportCode: "STRING_VALUE", * // createdAt: new Date("TIMESTAMP"), * // location: { // ResourceLocation * // availabilityZone: "STRING_VALUE", * // regionName: "us-east-1" || "us-east-2" || "us-west-1" || "us-west-2" || "eu-west-1" || "eu-west-2" || "eu-west-3" || "eu-central-1" || "eu-north-1" || "ca-central-1" || "ap-south-1" || "ap-southeast-1" || "ap-southeast-2" || "ap-northeast-1" || "ap-northeast-2" || "ap-southeast-3" || "ap-southeast-5", * // }, * // resourceType: "ContainerService" || "Instance" || "StaticIp" || "KeyPair" || "InstanceSnapshot" || "Domain" || "PeeredVpc" || "LoadBalancer" || "LoadBalancerTlsCertificate" || "Disk" || "DiskSnapshot" || "RelationalDatabase" || "RelationalDatabaseSnapshot" || "ExportSnapshotRecord" || "CloudFormationStackRecord" || "Alarm" || "ContactMethod" || "Distribution" || "Certificate" || "Bucket", * // tags: [ // TagList * // { // Tag * // key: "STRING_VALUE", * // value: "STRING_VALUE", * // }, * // ], * // blueprintId: "STRING_VALUE", * // blueprintName: "STRING_VALUE", * // bundleId: "STRING_VALUE", * // addOns: [ // AddOnList * // { // AddOn * // name: "STRING_VALUE", * // status: "STRING_VALUE", * // snapshotTimeOfDay: "STRING_VALUE", * // nextSnapshotTimeOfDay: "STRING_VALUE", * // threshold: "STRING_VALUE", * // duration: "STRING_VALUE", * // }, * // ], * // isStaticIp: true || false, * // privateIpAddress: "STRING_VALUE", * // publicIpAddress: "STRING_VALUE", * // ipv6Addresses: [ // Ipv6AddressList * // "STRING_VALUE", * // ], * // ipAddressType: "dualstack" || "ipv4" || "ipv6", * // hardware: { // InstanceHardware * // cpuCount: Number("int"), * // disks: [ // DiskList * // { // Disk * // name: "STRING_VALUE", * // arn: "STRING_VALUE", * // supportCode: "STRING_VALUE", * // createdAt: new Date("TIMESTAMP"), * // location: { * // availabilityZone: "STRING_VALUE", * // regionName: "us-east-1" || "us-east-2" || "us-west-1" || "us-west-2" || "eu-west-1" || "eu-west-2" || "eu-west-3" || "eu-central-1" || "eu-north-1" || "ca-central-1" || "ap-south-1" || "ap-southeast-1" || "ap-southeast-2" || "ap-northeast-1" || "ap-northeast-2" || "ap-southeast-3" || "ap-southeast-5", * // }, * // resourceType: "ContainerService" || "Instance" || "StaticIp" || "KeyPair" || "InstanceSnapshot" || "Domain" || "PeeredVpc" || "LoadBalancer" || "LoadBalancerTlsCertificate" || "Disk" || "DiskSnapshot" || "RelationalDatabase" || "RelationalDatabaseSnapshot" || "ExportSnapshotRecord" || "CloudFormationStackRecord" || "Alarm" || "ContactMethod" || "Distribution" || "Certificate" || "Bucket", * // tags: [ * // { * // key: "STRING_VALUE", * // value: "STRING_VALUE", * // }, * // ], * // addOns: [ * // { * // name: "STRING_VALUE", * // status: "STRING_VALUE", * // snapshotTimeOfDay: "STRING_VALUE", * // nextSnapshotTimeOfDay: "STRING_VALUE", * // threshold: "STRING_VALUE", * // duration: "STRING_VALUE", * // }, * // ], * // sizeInGb: Number("int"), * // isSystemDisk: true || false, * // iops: Number("int"), * // path: "STRING_VALUE", * // state: "pending" || "error" || "available" || "in-use" || "unknown", * // attachedTo: "STRING_VALUE", * // isAttached: true || false, * // attachmentState: "STRING_VALUE", * // gbInUse: Number("int"), * // autoMountStatus: "Failed" || "Pending" || "Mounted" || "NotMounted", * // }, * // ], * // ramSizeInGb: Number("float"), * // }, * // networking: { // InstanceNetworking * // monthlyTransfer: { // MonthlyTransfer * // gbPerMonthAllocated: Number("int"), * // }, * // ports: [ // InstancePortInfoList * // { // InstancePortInfo * // fromPort: Number("int"), * // toPort: Number("int"), * // protocol: "tcp" || "all" || "udp" || "icmp" || "icmpv6", * // accessFrom: "STRING_VALUE", * // accessType: "Public" || "Private", * // commonName: "STRING_VALUE", * // accessDirection: "inbound" || "outbound", * // cidrs: [ // StringList * // "STRING_VALUE", * // ], * // ipv6Cidrs: [ * // "STRING_VALUE", * // ], * // cidrListAliases: [ * // "STRING_VALUE", * // ], * // }, * // ], * // }, * // state: { // InstanceState * // code: Number("int"), * // name: "STRING_VALUE", * // }, * // username: "STRING_VALUE", * // sshKeyName: "STRING_VALUE", * // metadataOptions: { // InstanceMetadataOptions * // state: "pending" || "applied", * // httpTokens: "optional" || "required", * // httpEndpoint: "disabled" || "enabled", * // httpPutResponseHopLimit: Number("int"), * // httpProtocolIpv6: "disabled" || "enabled", * // }, * // }, * // ], * // nextPageToken: "STRING_VALUE", * // }; * * ``` * * @param GetInstancesCommandInput - {@link GetInstancesCommandInput} * @returns {@link GetInstancesCommandOutput} * @see {@link GetInstancesCommandInput} for command's `input` shape. * @see {@link GetInstancesCommandOutput} for command's `response` shape. * @see {@link LightsailClientResolvedConfig | config} for LightsailClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

Lightsail throws this exception when the user cannot be authenticated or uses invalid * credentials to access a resource.

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

Lightsail throws this exception when an account is still in the setup in progress * state.

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

Lightsail throws this exception when user input does not conform to the validation rules * of an input field.

* *

Domain and distribution APIs are only available in the N. Virginia * (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services * Region configuration to us-east-1 to create, view, or edit these * resources.

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

Lightsail throws this exception when it cannot find a resource.

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

Lightsail throws this exception when an operation fails to execute.

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

Lightsail throws this exception when an operation is performed on resources in an opt-in * Region that is currently being set up.

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

A general service exception.

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

Lightsail throws this exception when the user has not been authenticated.

* * @throws {@link LightsailServiceException} *

Base exception class for all service exceptions from Lightsail service.

* * * @public */ export declare class GetInstancesCommand extends GetInstancesCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetInstancesRequest; output: GetInstancesResult; }; sdk: { input: GetInstancesCommandInput; output: GetInstancesCommandOutput; }; }; }