Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.EC2.DescribeSubnets

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes one or more of your subnets.

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

This operation returns paginated results.

Synopsis

data DescribeSubnets = DescribeSubnets' {
- dryRun :: Maybe Bool
- filters :: Maybe [Filter]
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- subnetIds :: Maybe [Text]
}
newDescribeSubnets :: DescribeSubnets
describeSubnets_dryRun :: Lens' DescribeSubnets (Maybe Bool)
describeSubnets_filters :: Lens' DescribeSubnets (Maybe [Filter])
describeSubnets_maxResults :: Lens' DescribeSubnets (Maybe Natural)
describeSubnets_nextToken :: Lens' DescribeSubnets (Maybe Text)
describeSubnets_subnetIds :: Lens' DescribeSubnets (Maybe [Text])
data DescribeSubnetsResponse = DescribeSubnetsResponse' {
- nextToken :: Maybe Text
- subnets :: Maybe [Subnet]
- httpStatus :: Int
}
newDescribeSubnetsResponse :: Int -> DescribeSubnetsResponse
describeSubnetsResponse_nextToken :: Lens' DescribeSubnetsResponse (Maybe Text)
describeSubnetsResponse_subnets :: Lens' DescribeSubnetsResponse (Maybe [Subnet])
describeSubnetsResponse_httpStatus :: Lens' DescribeSubnetsResponse Int

Creating a Request

data DescribeSubnets Source #

See: newDescribeSubnets smart constructor.

Constructors

DescribeSubnets'

Fields

dryRun :: Maybe Bool
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 :: Maybe [Filter]
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.
- 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:<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.
maxResults :: Maybe Natural
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
nextToken :: Maybe Text
The token for the next page of results.
subnetIds :: Maybe [Text]
One or more subnet IDs.
Default: Describes all your subnets.

Instances

Instances details

ToHeaders DescribeSubnets Source #
Instance details Defined in Amazonka.EC2.DescribeSubnets Methods toHeaders :: DescribeSubnets -> [Header] #
ToPath DescribeSubnets Source #
Instance details Defined in Amazonka.EC2.DescribeSubnets Methods toPath :: DescribeSubnets -> ByteString #
ToQuery DescribeSubnets Source #
Instance details Defined in Amazonka.EC2.DescribeSubnets Methods toQuery :: DescribeSubnets -> QueryString #
AWSPager DescribeSubnets Source #
Instance details Defined in Amazonka.EC2.DescribeSubnets Methods page :: DescribeSubnets -> AWSResponse DescribeSubnets -> Maybe DescribeSubnets #
AWSRequest DescribeSubnets Source #
Instance details Defined in Amazonka.EC2.DescribeSubnets Associated Types type AWSResponse DescribeSubnets # Methods request :: (Service -> Service) -> DescribeSubnets -> Request DescribeSubnets # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeSubnets -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeSubnets))) #
Generic DescribeSubnets Source #
Instance details Defined in Amazonka.EC2.DescribeSubnets Associated Types type Rep DescribeSubnets :: Type -> Type # Methods from :: DescribeSubnets -> Rep DescribeSubnets x # to :: Rep DescribeSubnets x -> DescribeSubnets #
Read DescribeSubnets Source #
Instance details Defined in Amazonka.EC2.DescribeSubnets Methods readsPrec :: Int -> ReadS DescribeSubnets # readList :: ReadS [DescribeSubnets] # readPrec :: ReadPrec DescribeSubnets # readListPrec :: ReadPrec [DescribeSubnets] #
Show DescribeSubnets Source #
Instance details Defined in Amazonka.EC2.DescribeSubnets Methods showsPrec :: Int -> DescribeSubnets -> ShowS # show :: DescribeSubnets -> String # showList :: [DescribeSubnets] -> ShowS #
NFData DescribeSubnets Source #
Instance details Defined in Amazonka.EC2.DescribeSubnets Methods rnf :: DescribeSubnets -> () #
Eq DescribeSubnets Source #
Instance details Defined in Amazonka.EC2.DescribeSubnets Methods (==) :: DescribeSubnets -> DescribeSubnets -> Bool # (/=) :: DescribeSubnets -> DescribeSubnets -> Bool #
Hashable DescribeSubnets Source #
Instance details Defined in Amazonka.EC2.DescribeSubnets Methods hashWithSalt :: Int -> DescribeSubnets -> Int # hash :: DescribeSubnets -> Int #
type AWSResponse DescribeSubnets Source #
Instance details Defined in Amazonka.EC2.DescribeSubnets type AWSResponse DescribeSubnets = DescribeSubnetsResponse
type Rep DescribeSubnets Source #
Instance details Defined in Amazonka.EC2.DescribeSubnets type Rep DescribeSubnets = D1 ('MetaData "DescribeSubnets" "Amazonka.EC2.DescribeSubnets" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeSubnets'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

newDescribeSubnets :: DescribeSubnets Source #

Create a value of DescribeSubnets with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dryRun:DescribeSubnets', describeSubnets_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.

$sel:filters:DescribeSubnets', describeSubnets_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.
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:<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.

$sel:maxResults:DescribeSubnets', describeSubnets_maxResults - The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

DescribeSubnets, describeSubnets_nextToken - The token for the next page of results.

DescribeSubnets, describeSubnets_subnetIds - One or more subnet IDs.

Default: Describes all your subnets.

Request Lenses

describeSubnets_dryRun :: 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.

describeSubnets_filters :: Lens' DescribeSubnets (Maybe [Filter]) Source #

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

describeSubnets_maxResults :: Lens' DescribeSubnets (Maybe Natural) Source #

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

describeSubnets_nextToken :: Lens' DescribeSubnets (Maybe Text) Source #

The token for the next page of results.

describeSubnets_subnetIds :: Lens' DescribeSubnets (Maybe [Text]) Source #

One or more subnet IDs.

Default: Describes all your subnets.

Destructuring the Response

data DescribeSubnetsResponse Source #

See: newDescribeSubnetsResponse smart constructor.

Constructors

DescribeSubnetsResponse'
Fields nextToken :: Maybe Text The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. subnets :: Maybe [Subnet] Information about one or more subnets. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeSubnetsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeSubnets Associated Types type Rep DescribeSubnetsResponse :: Type -> Type # Methods from :: DescribeSubnetsResponse -> Rep DescribeSubnetsResponse x # to :: Rep DescribeSubnetsResponse x -> DescribeSubnetsResponse #
Read DescribeSubnetsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeSubnets Methods readsPrec :: Int -> ReadS DescribeSubnetsResponse # readList :: ReadS [DescribeSubnetsResponse] # readPrec :: ReadPrec DescribeSubnetsResponse # readListPrec :: ReadPrec [DescribeSubnetsResponse] #
Show DescribeSubnetsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeSubnets Methods showsPrec :: Int -> DescribeSubnetsResponse -> ShowS # show :: DescribeSubnetsResponse -> String # showList :: [DescribeSubnetsResponse] -> ShowS #
NFData DescribeSubnetsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeSubnets Methods rnf :: DescribeSubnetsResponse -> () #
Eq DescribeSubnetsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeSubnets Methods (==) :: DescribeSubnetsResponse -> DescribeSubnetsResponse -> Bool # (/=) :: DescribeSubnetsResponse -> DescribeSubnetsResponse -> Bool #
type Rep DescribeSubnetsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeSubnets type Rep DescribeSubnetsResponse = D1 ('MetaData "DescribeSubnetsResponse" "Amazonka.EC2.DescribeSubnets" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeSubnetsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "subnets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Subnet])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeSubnetsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeSubnetsResponse'`
-> DescribeSubnetsResponse

Create a value of DescribeSubnetsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeSubnets, describeSubnetsResponse_nextToken - The token to use to retrieve the next page of results. This value is null when there are no more results to return.

DescribeSubnetsResponse, describeSubnetsResponse_subnets - Information about one or more subnets.

$sel:httpStatus:DescribeSubnetsResponse', describeSubnetsResponse_httpStatus - The response's http status code.

Response Lenses

describeSubnetsResponse_nextToken :: Lens' DescribeSubnetsResponse (Maybe Text) Source #

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

describeSubnetsResponse_subnets :: Lens' DescribeSubnetsResponse (Maybe [Subnet]) Source #

Information about one or more subnets.

describeSubnetsResponse_httpStatus :: Lens' DescribeSubnetsResponse Int Source #

The response's http status code.