Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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 .
Synopsis
- describeSubnets :: DescribeSubnets
- data DescribeSubnets
- dsSubnetIds :: Lens' DescribeSubnets [Text]
- dsFilters :: Lens' DescribeSubnets [Filter]
- dsDryRun :: Lens' DescribeSubnets (Maybe Bool)
- describeSubnetsResponse :: Int -> DescribeSubnetsResponse
- data DescribeSubnetsResponse
- dsrsSubnets :: Lens' DescribeSubnetsResponse [Subnet]
- dsrsResponseStatus :: Lens' DescribeSubnetsResponse Int
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:
dsSubnetIds
- One or more subnet IDs. Default: Describes all your subnets.dsFilters
- One or more filters. *availabilityZone
- The Availability Zone for the subnet. You can also useavailability-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 usecidr
orcidr-block
as the filter names. *defaultForAz
- Indicates whether this is the default subnet for the Availability Zone. You can also usedefault-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 keyvalue 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, specifytag:Purpose
for the filter name andX
for the filter value. *tag-key
- The key of a tag assigned to the resource. This filter is independent of thetag-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 thetag
:key =value/ filter. *tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-key
filter. *vpc-id
- The ID of the VPC for the subnet.dsDryRun
- 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 isDryRunOperation
. Otherwise, it isUnauthorizedOperation
.
data DescribeSubnets Source #
Contains the parameters for DescribeSubnets.
See: describeSubnets
smart constructor.
Instances
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 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 keyvalue 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.
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:
dsrsSubnets
- Information about one or more subnets.dsrsResponseStatus
- -- | The response status code.
data DescribeSubnetsResponse Source #
Contains the output of DescribeSubnets.
See: describeSubnetsResponse
smart constructor.
Instances
Response Lenses
dsrsSubnets :: Lens' DescribeSubnetsResponse [Subnet] Source #
Information about one or more subnets.
dsrsResponseStatus :: Lens' DescribeSubnetsResponse Int Source #
- - | The response status code.