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

Describes the specified network interfaces or all your network interfaces.

*

If you have a large number of network interfaces, the operation fails unless you use * pagination or one of the following filters: group-id, * mac-address, private-dns-name, * private-ip-address, subnet-id, or * vpc-id.

* *

We strongly recommend using only paginated requests. Unpaginated requests are * susceptible to throttling and timeouts.

*
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { EC2Client, DescribeNetworkInterfacesCommand } from "@aws-sdk/client-ec2"; // ES Modules import * // const { EC2Client, DescribeNetworkInterfacesCommand } = 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 = { // DescribeNetworkInterfacesRequest * NextToken: "STRING_VALUE", * MaxResults: Number("int"), * IncludeManagedResources: true || false, * DryRun: true || false, * NetworkInterfaceIds: [ // NetworkInterfaceIdList * "STRING_VALUE", * ], * Filters: [ // FilterList * { // Filter * Name: "STRING_VALUE", * Values: [ // ValueStringList * "STRING_VALUE", * ], * }, * ], * }; * const command = new DescribeNetworkInterfacesCommand(input); * const response = await client.send(command); * // { // DescribeNetworkInterfacesResult * // NetworkInterfaces: [ // NetworkInterfaceList * // { // NetworkInterface * // Association: { // NetworkInterfaceAssociation * // AllocationId: "STRING_VALUE", * // AssociationId: "STRING_VALUE", * // IpOwnerId: "STRING_VALUE", * // PublicDnsName: "STRING_VALUE", * // PublicIp: "STRING_VALUE", * // CustomerOwnedIp: "STRING_VALUE", * // CarrierIp: "STRING_VALUE", * // }, * // Attachment: { // NetworkInterfaceAttachment * // AttachTime: new Date("TIMESTAMP"), * // AttachmentId: "STRING_VALUE", * // DeleteOnTermination: true || false, * // DeviceIndex: Number("int"), * // NetworkCardIndex: Number("int"), * // InstanceId: "STRING_VALUE", * // InstanceOwnerId: "STRING_VALUE", * // Status: "attaching" || "attached" || "detaching" || "detached", * // EnaSrdSpecification: { // AttachmentEnaSrdSpecification * // EnaSrdEnabled: true || false, * // EnaSrdUdpSpecification: { // AttachmentEnaSrdUdpSpecification * // EnaSrdUdpEnabled: true || false, * // }, * // }, * // EnaQueueCount: Number("int"), * // }, * // AvailabilityZone: "STRING_VALUE", * // ConnectionTrackingConfiguration: { // ConnectionTrackingConfiguration * // TcpEstablishedTimeout: Number("int"), * // UdpStreamTimeout: Number("int"), * // UdpTimeout: Number("int"), * // }, * // Description: "STRING_VALUE", * // Groups: [ // GroupIdentifierList * // { // GroupIdentifier * // GroupId: "STRING_VALUE", * // GroupName: "STRING_VALUE", * // }, * // ], * // InterfaceType: "interface" || "natGateway" || "efa" || "efa-only" || "trunk" || "load_balancer" || "network_load_balancer" || "vpc_endpoint" || "branch" || "transit_gateway" || "lambda" || "quicksight" || "global_accelerator_managed" || "api_gateway_managed" || "gateway_load_balancer" || "gateway_load_balancer_endpoint" || "iot_rules_managed" || "aws_codestar_connections_managed", * // Ipv6Addresses: [ // NetworkInterfaceIpv6AddressesList * // { // NetworkInterfaceIpv6Address * // Ipv6Address: "STRING_VALUE", * // PublicIpv6DnsName: "STRING_VALUE", * // IsPrimaryIpv6: true || false, * // }, * // ], * // MacAddress: "STRING_VALUE", * // NetworkInterfaceId: "STRING_VALUE", * // OutpostArn: "STRING_VALUE", * // OwnerId: "STRING_VALUE", * // PrivateDnsName: "STRING_VALUE", * // PublicDnsName: "STRING_VALUE", * // PublicIpDnsNameOptions: { // PublicIpDnsNameOptions * // DnsHostnameType: "STRING_VALUE", * // PublicIpv4DnsName: "STRING_VALUE", * // PublicIpv6DnsName: "STRING_VALUE", * // PublicDualStackDnsName: "STRING_VALUE", * // }, * // PrivateIpAddress: "STRING_VALUE", * // PrivateIpAddresses: [ // NetworkInterfacePrivateIpAddressList * // { // NetworkInterfacePrivateIpAddress * // Association: { * // AllocationId: "STRING_VALUE", * // AssociationId: "STRING_VALUE", * // IpOwnerId: "STRING_VALUE", * // PublicDnsName: "STRING_VALUE", * // PublicIp: "STRING_VALUE", * // CustomerOwnedIp: "STRING_VALUE", * // CarrierIp: "STRING_VALUE", * // }, * // Primary: true || false, * // PrivateDnsName: "STRING_VALUE", * // PrivateIpAddress: "STRING_VALUE", * // }, * // ], * // Ipv4Prefixes: [ // Ipv4PrefixesList * // { // Ipv4PrefixSpecification * // Ipv4Prefix: "STRING_VALUE", * // }, * // ], * // Ipv6Prefixes: [ // Ipv6PrefixesList * // { // Ipv6PrefixSpecification * // Ipv6Prefix: "STRING_VALUE", * // }, * // ], * // RequesterId: "STRING_VALUE", * // RequesterManaged: true || false, * // SourceDestCheck: true || false, * // Status: "available" || "associated" || "attaching" || "in-use" || "detaching", * // SubnetId: "STRING_VALUE", * // TagSet: [ // TagList * // { // Tag * // Key: "STRING_VALUE", * // Value: "STRING_VALUE", * // }, * // ], * // VpcId: "STRING_VALUE", * // DenyAllIgwTraffic: true || false, * // Ipv6Native: true || false, * // Ipv6Address: "STRING_VALUE", * // Operator: { // OperatorResponse * // Managed: true || false, * // Principal: "STRING_VALUE", * // HiddenByDefault: true || false, * // }, * // AssociatedSubnets: [ // AssociatedSubnetList * // "STRING_VALUE", * // ], * // AvailabilityZoneId: "STRING_VALUE", * // }, * // ], * // NextToken: "STRING_VALUE", * // }; * * ``` * * @param DescribeNetworkInterfacesCommandInput - {@link DescribeNetworkInterfacesCommandInput} * @returns {@link DescribeNetworkInterfacesCommandOutput} * @see {@link DescribeNetworkInterfacesCommandInput} for command's `input` shape. * @see {@link DescribeNetworkInterfacesCommandOutput} 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 a network interface * ```javascript * // * const input = { * NetworkInterfaceIds: [ * "eni-e5aa89a3" * ] * }; * const command = new DescribeNetworkInterfacesCommand(input); * const response = await client.send(command); * /* response is * { * NetworkInterfaces: [ * { * Association: { * AssociationId: "eipassoc-0fbb766a", * IpOwnerId: "123456789012", * PublicDnsName: "ec2-203-0-113-12.compute-1.amazonaws.com", * PublicIp: "203.0.113.12" * }, * Attachment: { * AttachTime: "2013-11-30T23:36:42.000Z", * AttachmentId: "eni-attach-66c4350a", * DeleteOnTermination: false, * DeviceIndex: 1, * InstanceId: "i-1234567890abcdef0", * InstanceOwnerId: "123456789012", * Status: "attached" * }, * AvailabilityZone: "us-east-1d", * Description: "my network interface", * Groups: [ * { * GroupId: "sg-8637d3e3", * GroupName: "default" * } * ], * MacAddress: "02:2f:8f:b0:cf:75", * NetworkInterfaceId: "eni-e5aa89a3", * OwnerId: "123456789012", * PrivateDnsName: "ip-10-0-1-17.ec2.internal", * PrivateIpAddress: "10.0.1.17", * PrivateIpAddresses: [ * { * Association: { * AssociationId: "eipassoc-0fbb766a", * IpOwnerId: "123456789012", * PublicDnsName: "ec2-203-0-113-12.compute-1.amazonaws.com", * PublicIp: "203.0.113.12" * }, * Primary: true, * PrivateDnsName: "ip-10-0-1-17.ec2.internal", * PrivateIpAddress: "10.0.1.17" * } * ], * RequesterManaged: false, * SourceDestCheck: true, * Status: "in-use", * SubnetId: "subnet-b61f49f0", * TagSet: [], * VpcId: "vpc-a01106c2" * } * ] * } * *\/ * ``` * * @public */ export declare class DescribeNetworkInterfacesCommand extends DescribeNetworkInterfacesCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeNetworkInterfacesRequest; output: DescribeNetworkInterfacesResult; }; sdk: { input: DescribeNetworkInterfacesCommandInput; output: DescribeNetworkInterfacesCommandOutput; }; }; }