amazonka-ec2-1.0.0: Amazon Elastic Compute Cloud SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.EC2.DescribeSubnets

Contents

Description

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.

See: AWS API Reference for DescribeSubnets.

Synopsis

Creating a Request

describeSubnets :: DescribeSubnets Source

Creates a value of DescribeSubnets with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

Request Lenses

dsSubnetIds :: Lens' DescribeSubnets [Text] Source

One or more subnet IDs.

Default: Describes all your subnets.

dsFilters :: Lens' DescribeSubnets [Filter] Source

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 IP addresses in the subnet that are available.
  • cidrBlock - The 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.
  • 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.
  • '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.

dsDryRun :: Lens' DescribeSubnets (Maybe Bool) Source

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.

Destructuring the Response

describeSubnetsResponse Source

Creates a value of DescribeSubnetsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

Response Lenses

dsrsSubnets :: Lens' DescribeSubnetsResponse [Subnet] Source

Information about one or more subnets.

dsrsStatus :: Lens' DescribeSubnetsResponse Int Source

The response status code.