import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; import type { DescribeInstanceStatusRequest, DescribeInstanceStatusResult } from "../models/models_4"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DescribeInstanceStatusCommand}. */ export interface DescribeInstanceStatusCommandInput extends DescribeInstanceStatusRequest { } /** * @public * * The output of {@link DescribeInstanceStatusCommand}. */ export interface DescribeInstanceStatusCommandOutput extends DescribeInstanceStatusResult, __MetadataBearer { } declare const DescribeInstanceStatusCommand_base: { new (input: DescribeInstanceStatusCommandInput): import("@smithy/smithy-client").CommandImpl; new (...[input]: [] | [DescribeInstanceStatusCommandInput]): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Describes the status of the specified instances or all of your instances. By default, * only running instances are described, unless you specifically indicate to return the * status of all instances.

*

Instance status includes the following components:

* *

The Amazon EC2 API follows an eventual consistency model. This means that the result of an * API command you run that creates or modifies resources might not be immediately * available to all subsequent commands you run. For guidance on how to manage eventual * consistency, see Eventual consistency in the * Amazon EC2 API in the Amazon EC2 Developer * Guide.

* *

The order of the elements in the response, including those within nested * structures, might vary. Applications should not assume the elements appear in a * particular order.

* * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { EC2Client, DescribeInstanceStatusCommand } from "@aws-sdk/client-ec2"; // ES Modules import * // const { EC2Client, DescribeInstanceStatusCommand } = require("@aws-sdk/client-ec2"); // CommonJS import * // import type { EC2ClientConfig } from "@aws-sdk/client-ec2"; * const config = {}; // type is EC2ClientConfig * const client = new EC2Client(config); * const input = { // DescribeInstanceStatusRequest * InstanceIds: [ // InstanceIdStringList * "STRING_VALUE", * ], * MaxResults: Number("int"), * NextToken: "STRING_VALUE", * IncludeManagedResources: true || false, * DryRun: true || false, * Filters: [ // FilterList * { // Filter * Name: "STRING_VALUE", * Values: [ // ValueStringList * "STRING_VALUE", * ], * }, * ], * IncludeAllInstances: true || false, * }; * const command = new DescribeInstanceStatusCommand(input); * const response = await client.send(command); * // { // DescribeInstanceStatusResult * // InstanceStatuses: [ // InstanceStatusList * // { // InstanceStatus * // AvailabilityZone: "STRING_VALUE", * // AvailabilityZoneId: "STRING_VALUE", * // OutpostArn: "STRING_VALUE", * // Operator: { // OperatorResponse * // Managed: true || false, * // Principal: "STRING_VALUE", * // HiddenByDefault: true || false, * // }, * // Events: [ // InstanceStatusEventList * // { // InstanceStatusEvent * // InstanceEventId: "STRING_VALUE", * // Code: "instance-reboot" || "system-reboot" || "system-maintenance" || "instance-retirement" || "instance-stop", * // Description: "STRING_VALUE", * // NotAfter: new Date("TIMESTAMP"), * // NotBefore: new Date("TIMESTAMP"), * // NotBeforeDeadline: new Date("TIMESTAMP"), * // }, * // ], * // InstanceId: "STRING_VALUE", * // InstanceState: { // InstanceState * // Code: Number("int"), * // Name: "pending" || "running" || "shutting-down" || "terminated" || "stopping" || "stopped", * // }, * // InstanceStatus: { // InstanceStatusSummary * // Details: [ // InstanceStatusDetailsList * // { // InstanceStatusDetails * // ImpairedSince: new Date("TIMESTAMP"), * // Name: "reachability", * // Status: "passed" || "failed" || "insufficient-data" || "initializing", * // }, * // ], * // Status: "ok" || "impaired" || "insufficient-data" || "not-applicable" || "initializing", * // }, * // SystemStatus: { * // Details: [ * // { * // ImpairedSince: new Date("TIMESTAMP"), * // Name: "reachability", * // Status: "passed" || "failed" || "insufficient-data" || "initializing", * // }, * // ], * // Status: "ok" || "impaired" || "insufficient-data" || "not-applicable" || "initializing", * // }, * // AttachedEbsStatus: { // EbsStatusSummary * // Details: [ // EbsStatusDetailsList * // { // EbsStatusDetails * // ImpairedSince: new Date("TIMESTAMP"), * // Name: "reachability", * // Status: "passed" || "failed" || "insufficient-data" || "initializing", * // }, * // ], * // Status: "ok" || "impaired" || "insufficient-data" || "not-applicable" || "initializing", * // }, * // }, * // ], * // NextToken: "STRING_VALUE", * // }; * * ``` * * @param DescribeInstanceStatusCommandInput - {@link DescribeInstanceStatusCommandInput} * @returns {@link DescribeInstanceStatusCommandOutput} * @see {@link DescribeInstanceStatusCommandInput} for command's `input` shape. * @see {@link DescribeInstanceStatusCommandOutput} for command's `response` shape. * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape. * * @throws {@link EC2ServiceException} *

Base exception class for all service exceptions from EC2 service.

* * * @example To describe the status of an instance * ```javascript * // This example describes the current status of the specified instance. * const input = { * InstanceIds: [ * "i-1234567890abcdef0" * ] * }; * const command = new DescribeInstanceStatusCommand(input); * const response = await client.send(command); * /* response is * { * InstanceStatuses: [ * { * AvailabilityZone: "us-east-1d", * InstanceId: "i-1234567890abcdef0", * InstanceState: { * Code: 16, * Name: "running" * }, * InstanceStatus: { * Details: [ * { * Name: "reachability", * Status: "passed" * } * ], * Status: "ok" * }, * SystemStatus: { * Details: [ * { * Name: "reachability", * Status: "passed" * } * ], * Status: "ok" * } * } * ] * } * *\/ * ``` * * @public */ export declare class DescribeInstanceStatusCommand extends DescribeInstanceStatusCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeInstanceStatusRequest; output: DescribeInstanceStatusResult; }; sdk: { input: DescribeInstanceStatusCommandInput; output: DescribeInstanceStatusCommandOutput; }; }; }