Menu
Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

DescribeSubnets

Describes one or more of your subnets.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

DryRun

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.

Type: Boolean

Required: No

Filter.N

One or more filters.

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

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

  • cidrBlock - 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 cidr-block as the filter names.

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

  • 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.

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

  • subnet-id - The ID of the subnet.

  • tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

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

Type: Array of Filter objects

Required: No

SubnetId.N

One or more subnet IDs.

Default: Describes all your subnets.

Type: Array of strings

Required: No

Response Elements

The following elements are returned by the service.

requestId

The ID of the request.

Type: String

subnetSet

Information about one or more subnets.

Type: Array of Subnet objects

Errors

For information about the errors that are common to all actions, see Common Client Errors.

Examples

Example 1

This example describes the subnets with the IDs subnet-9d4a7b6c and subnet-6e7f829e.

Sample Request

https://ec2.amazonaws.com/?Action=DescribeSubnets &SubnetId.1=subnet-9d4a7b6c &SubnetId.2=subnet-6e7f829e &AUTHPARAMS

Sample Response

<DescribeSubnetsResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId> <subnetSet> <item> <subnetId>subnet-9d4a7b6c</subnetId> <state>available</state> <vpcId>vpc-1a2b3c4d</vpcId> <cidrBlock>10.0.1.0/24</cidrBlock> <ipv6CidrBlockAssociationSet> <item> <ipv6CidrBlock>2001:db8:1234:1a00::/64</ipv6CidrBlock> <associationId>subnet-cidr-assoc-abababab</associationId> <ipv6CidrBlockState> <state>ASSOCIATED</state> </ipv6CidrBlockState> </item> </ipv6CidrBlockAssociationSet> <availableIpAddressCount>251</availableIpAddressCount> <availabilityZone>us-east-1a</availabilityZone> <defaultForAz>false</defaultForAz> <mapPublicIpOnLaunch>false</mapPublicIpOnLaunch> <tagSet/> <assignIpv6AddressOnCreation>false</assignIpv6AddressOnCreation> </item> <item> <subnetId>subnet-6e7f829e</subnetId> <state>available</state> <vpcId>vpc-1a2b3c4d></vpcId> <cidrBlock>10.0.0.0/24</cidrBlock> <ipv6CidrBlockAssociationSet/> <availableIpAddressCount>251</availableIpAddressCount> <availabilityZone>us-east-1a</availabilityZone> <defaultForAz>false</defaultForAz> <mapPublicIpOnLaunch>false</mapPublicIpOnLaunch> <assignIpv6AddressOnCreation>false</assignIpv6AddressOnCreation> </item> </subnetSet> </DescribeSubnetsResponse>

Example 2

This example uses filters to describe any subnet you own that is in the VPC with the ID vpc-1a2b3c4d or vpc-6e7f8a92, and whose state is available.

Sample Request

https://ec2.amazonaws.com/?Action=DescribeSubnets &Filter.1.Name=vpc-id &Filter.1.Value.1=vpc-1a2b3c4d &Filter.1.Value.2=vpc-6e7f8a92 &Filter.2.Name=state &Filter.2.Value.1=available &AUTHPARAMS

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: