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 { DescribeInstanceTopologyRequest, DescribeInstanceTopologyResult } from "../models/models_4"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DescribeInstanceTopologyCommand}. */ export interface DescribeInstanceTopologyCommandInput extends DescribeInstanceTopologyRequest { } /** * @public * * The output of {@link DescribeInstanceTopologyCommand}. */ export interface DescribeInstanceTopologyCommandOutput extends DescribeInstanceTopologyResult, __MetadataBearer { } declare const DescribeInstanceTopologyCommand_base: { new (input: DescribeInstanceTopologyCommandInput): import("@smithy/smithy-client").CommandImpl; new (...[input]: [] | [DescribeInstanceTopologyCommandInput]): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Describes a tree-based hierarchy that represents the physical host placement of your * EC2 instances within an Availability Zone or Local Zone. You can use this information to * determine the relative proximity of your EC2 instances within the Amazon Web Services network to * support your tightly coupled workloads.

*

Instance topology is supported for specific instance types only. For more information, * see Prerequisites * for Amazon EC2 instance topology in the * Amazon EC2 User Guide.

* *

The Amazon EC2 API follows an eventual consistency model due to the * distributed nature of the system supporting it. As a result, when you call the * DescribeInstanceTopology API command immediately after launching instances, the * response might return a null value for capacityBlockId * because the data might not have fully propagated across all subsystems. For more * information, see Eventual consistency in the * Amazon EC2 API in the Amazon EC2 Developer * Guide.

*
*

For more information, see Amazon EC2 topology in * the Amazon EC2 User Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { EC2Client, DescribeInstanceTopologyCommand } from "@aws-sdk/client-ec2"; // ES Modules import * // const { EC2Client, DescribeInstanceTopologyCommand } = 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 = { // DescribeInstanceTopologyRequest * DryRun: true || false, * NextToken: "STRING_VALUE", * MaxResults: Number("int"), * InstanceIds: [ // DescribeInstanceTopologyInstanceIdSet * "STRING_VALUE", * ], * GroupNames: [ // DescribeInstanceTopologyGroupNameSet * "STRING_VALUE", * ], * Filters: [ // FilterList * { // Filter * Name: "STRING_VALUE", * Values: [ // ValueStringList * "STRING_VALUE", * ], * }, * ], * }; * const command = new DescribeInstanceTopologyCommand(input); * const response = await client.send(command); * // { // DescribeInstanceTopologyResult * // Instances: [ // InstanceSet * // { // InstanceTopology * // InstanceId: "STRING_VALUE", * // InstanceType: "STRING_VALUE", * // GroupName: "STRING_VALUE", * // NetworkNodes: [ // NetworkNodesList * // "STRING_VALUE", * // ], * // AvailabilityZone: "STRING_VALUE", * // ZoneId: "STRING_VALUE", * // CapacityBlockId: "STRING_VALUE", * // }, * // ], * // NextToken: "STRING_VALUE", * // }; * * ``` * * @param DescribeInstanceTopologyCommandInput - {@link DescribeInstanceTopologyCommandInput} * @returns {@link DescribeInstanceTopologyCommandOutput} * @see {@link DescribeInstanceTopologyCommandInput} for command's `input` shape. * @see {@link DescribeInstanceTopologyCommandOutput} 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.

* * * @public */ export declare class DescribeInstanceTopologyCommand extends DescribeInstanceTopologyCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeInstanceTopologyRequest; output: DescribeInstanceTopologyResult; }; sdk: { input: DescribeInstanceTopologyCommandInput; output: DescribeInstanceTopologyCommandOutput; }; }; }