DescribeSubnetsCommand

Suggest an Edit

Describes your subnets. The default is to describe all your subnets. Alternatively, you can specify specific subnet IDs or filter the results to include only the subnets that match specific criteria.

For more information, see Subnets  in the Amazon VPC User Guide.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { EC2Client, DescribeSubnetsCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, DescribeSubnetsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // DescribeSubnetsRequest
  Filters: [ // FilterList
    { // Filter
      Name: "STRING_VALUE",
      Values: [ // ValueStringList
        "STRING_VALUE",
      ],
    },
  ],
  SubnetIds: [ // SubnetIdStringList
    "STRING_VALUE",
  ],
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
  DryRun: true || false,
};
const command = new DescribeSubnetsCommand(input);
const response = await client.send(command);
// { // DescribeSubnetsResult
//   NextToken: "STRING_VALUE",
//   Subnets: [ // SubnetList
//     { // Subnet
//       AvailabilityZoneId: "STRING_VALUE",
//       EnableLniAtDeviceIndex: Number("int"),
//       MapCustomerOwnedIpOnLaunch: true || false,
//       CustomerOwnedIpv4Pool: "STRING_VALUE",
//       OwnerId: "STRING_VALUE",
//       AssignIpv6AddressOnCreation: true || false,
//       Ipv6CidrBlockAssociationSet: [ // SubnetIpv6CidrBlockAssociationSet
//         { // SubnetIpv6CidrBlockAssociation
//           AssociationId: "STRING_VALUE",
//           Ipv6CidrBlock: "STRING_VALUE",
//           Ipv6CidrBlockState: { // SubnetCidrBlockState
//             State: "associating" || "associated" || "disassociating" || "disassociated" || "failing" || "failed",
//             StatusMessage: "STRING_VALUE",
//           },
//           Ipv6AddressAttribute: "public" || "private",
//           IpSource: "amazon" || "byoip" || "none",
//         },
//       ],
//       Tags: [ // TagList
//         { // Tag
//           Key: "STRING_VALUE",
//           Value: "STRING_VALUE",
//         },
//       ],
//       SubnetArn: "STRING_VALUE",
//       OutpostArn: "STRING_VALUE",
//       EnableDns64: true || false,
//       Ipv6Native: true || false,
//       PrivateDnsNameOptionsOnLaunch: { // PrivateDnsNameOptionsOnLaunch
//         HostnameType: "ip-name" || "resource-name",
//         EnableResourceNameDnsARecord: true || false,
//         EnableResourceNameDnsAAAARecord: true || false,
//       },
//       BlockPublicAccessStates: { // BlockPublicAccessStates
//         InternetGatewayBlockMode: "off" || "block-bidirectional" || "block-ingress",
//       },
//       SubnetId: "STRING_VALUE",
//       State: "pending" || "available" || "unavailable",
//       VpcId: "STRING_VALUE",
//       CidrBlock: "STRING_VALUE",
//       AvailableIpAddressCount: Number("int"),
//       AvailabilityZone: "STRING_VALUE",
//       DefaultForAz: true || false,
//       MapPublicIpOnLaunch: true || false,
//     },
//   ],
// };

Example Usage

 Loading code editor

DescribeSubnetsCommand Input

See DescribeSubnetsCommandInput for more details

Parameter
Type
Description
DryRun
boolean | undefined

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Filters
Filter[] | undefined

The filters.

  • availability-zone - The Availability Zone for the subnet. You can also use availabilityZone as the filter name.

  • availability-zone-id - The ID of the Availability Zone for the subnet. You can also use availabilityZoneId as the filter name.

  • available-ip-address-count - The number of IPv4 addresses in the subnet that are available.

  • cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use cidr or cidrBlock as the filter names.

  • customer-owned-ipv4-pool - The customer-owned IPv4 address pool associated with the subnet.

  • default-for-az - Indicates whether this is the default subnet for the Availability Zone (true | false). You can also use defaultForAz as the filter name.

  • enable-dns64 - Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.

  • enable-lni-at-device-index - Indicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1).

  • ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.

  • ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet.

  • ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.

  • ipv6-native - Indicates whether this is an IPv6 only subnet (true | false).

  • map-customer-owned-ip-on-launch - Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.

  • map-public-ip-on-launch - Indicates whether instances launched in this subnet receive a public IPv4 address.

  • outpost-arn - The Amazon Resource Name (ARN) of the Outpost.

  • owner-id - The ID of the Amazon Web Services account that owns the subnet.

  • private-dns-name-options-on-launch.hostname-type - The type of hostname to assign to instances in the subnet at launch. For IPv4-only and dual-stack (IPv4 and IPv6) subnets, an instance DNS name can be based on the instance IPv4 address (ip-name) or the instance ID (resource-name). For IPv6 only subnets, an instance DNS name must be based on the instance ID (resource-name).

  • private-dns-name-options-on-launch.enable-resource-name-dns-a-record - Indicates whether to respond to DNS queries for instance hostnames with DNS A records.

  • private-dns-name-options-on-launch.enable-resource-name-dns-aaaa-record - Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.

  • state - The state of the subnet (pending | available).

  • subnet-arn - The Amazon Resource Name (ARN) of the subnet.

  • subnet-id - The ID of the subnet.

  • tag - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • vpc-id - The ID of the VPC for the subnet.

MaxResults
number | undefined

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination .

NextToken
string | undefined

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

SubnetIds
string[] | undefined

The IDs of the subnets.

Default: Describes all your subnets.

DescribeSubnetsCommand Output

See DescribeSubnetsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
NextToken
string | undefined

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

Subnets
Subnet[] | undefined

Information about the subnets.

Throws

Name
Fault
Details
EC2ServiceException
Base exception class for all service exceptions from EC2 service.