EC2 Describe Subnets - BlinkOps Documentation

Describes one or more of your subnets. For more information, see Your VPC and subnets in the Amazon Virtual Private Cloud User Guide.

External DocumentationTo learn more, visit the AWS documentation.

Basic Parameters

Parameter	Description
AWS Region(s)	Enter the desired AWS Region(s). To execute the action in multiple regions, provide a comma-separated list. For example: `us-east-1,eu-west-2`. If you wish to run the action in all available regions, use the asterisk symbol (`*`) instead.
Subnet IDs	One or more subnet IDs. Default: Describes all your subnets.

Advanced Parameters

Parameter	Description
Disable XML To JSON Auto Convert	When checked, XML responses are not automatically converted into JSON format.
Dry Run	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	One or more 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. - `default-for-az` - Indicates whether this is the default subnet for the Availability Zone. You can also use `defaultForAz` 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. - `outpost-arn` - The Amazon Resource Name (ARN) of the Outpost. - `owner-id` - The ID of the Amazon Web Services account that owns the subnet. - `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`:<key> - 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.
Max Results	The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value.
Next Token	The token for the next page of results.

Example Output

{
	"Subnets": [
		{
			"AvailabilityZone": "us-east-1c",
			"AvailableIpAddressCount": 251,
			"CidrBlock": "10.0.1.0/24",
			"DefaultForAz": false,
			"MapPublicIpOnLaunch": false,
			"State": "available",
			"SubnetId": "subnet-9d4a7b6c",
			"VpcId": "vpc-a01106c2"
		}
	]
}