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 |
Describes one or more of your VPCs.
This operation returns paginated results.
Synopsis
- data DescribeVpcs = DescribeVpcs' {}
- newDescribeVpcs :: DescribeVpcs
- describeVpcs_dryRun :: Lens' DescribeVpcs (Maybe Bool)
- describeVpcs_filters :: Lens' DescribeVpcs (Maybe [Filter])
- describeVpcs_maxResults :: Lens' DescribeVpcs (Maybe Natural)
- describeVpcs_nextToken :: Lens' DescribeVpcs (Maybe Text)
- describeVpcs_vpcIds :: Lens' DescribeVpcs (Maybe [Text])
- data DescribeVpcsResponse = DescribeVpcsResponse' {}
- newDescribeVpcsResponse :: Int -> DescribeVpcsResponse
- describeVpcsResponse_nextToken :: Lens' DescribeVpcsResponse (Maybe Text)
- describeVpcsResponse_vpcs :: Lens' DescribeVpcsResponse (Maybe [Vpc])
- describeVpcsResponse_httpStatus :: Lens' DescribeVpcsResponse Int
Creating a Request
data DescribeVpcs Source #
See: newDescribeVpcs
smart constructor.
DescribeVpcs' | |
|
Instances
newDescribeVpcs :: DescribeVpcs Source #
Create a value of DescribeVpcs
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:DescribeVpcs'
, describeVpcs_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:DescribeVpcs'
, describeVpcs_filters
- One or more filters.
cidr
- The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example,/28
).cidr-block-association.cidr-block
- An IPv4 CIDR block associated with the VPC.cidr-block-association.association-id
- The association ID for an IPv4 CIDR block associated with the VPC.cidr-block-association.state
- The state of an IPv4 CIDR block associated with the VPC.dhcp-options-id
- The ID of a set of DHCP options.ipv6-cidr-block-association.ipv6-cidr-block
- An IPv6 CIDR block associated with the VPC.ipv6-cidr-block-association.ipv6-pool
- The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.ipv6-cidr-block-association.association-id
- The association ID for an IPv6 CIDR block associated with the VPC.ipv6-cidr-block-association.state
- The state of an IPv6 CIDR block associated with the VPC.is-default
- Indicates whether the VPC is the default VPC.owner-id
- The ID of the Amazon Web Services account that owns the VPC.state
- The state of the VPC (pending
|available
).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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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.
$sel:maxResults:DescribeVpcs'
, describeVpcs_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.
DescribeVpcs
, describeVpcs_nextToken
- The token for the next page of results.
$sel:vpcIds:DescribeVpcs'
, describeVpcs_vpcIds
- One or more VPC IDs.
Default: Describes all your VPCs.
Request Lenses
describeVpcs_dryRun :: Lens' DescribeVpcs (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
.
describeVpcs_filters :: Lens' DescribeVpcs (Maybe [Filter]) Source #
One or more filters.
cidr
- The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example,/28
).cidr-block-association.cidr-block
- An IPv4 CIDR block associated with the VPC.cidr-block-association.association-id
- The association ID for an IPv4 CIDR block associated with the VPC.cidr-block-association.state
- The state of an IPv4 CIDR block associated with the VPC.dhcp-options-id
- The ID of a set of DHCP options.ipv6-cidr-block-association.ipv6-cidr-block
- An IPv6 CIDR block associated with the VPC.ipv6-cidr-block-association.ipv6-pool
- The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.ipv6-cidr-block-association.association-id
- The association ID for an IPv6 CIDR block associated with the VPC.ipv6-cidr-block-association.state
- The state of an IPv6 CIDR block associated with the VPC.is-default
- Indicates whether the VPC is the default VPC.owner-id
- The ID of the Amazon Web Services account that owns the VPC.state
- The state of the VPC (pending
|available
).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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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.
describeVpcs_maxResults :: Lens' DescribeVpcs (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.
describeVpcs_nextToken :: Lens' DescribeVpcs (Maybe Text) Source #
The token for the next page of results.
describeVpcs_vpcIds :: Lens' DescribeVpcs (Maybe [Text]) Source #
One or more VPC IDs.
Default: Describes all your VPCs.
Destructuring the Response
data DescribeVpcsResponse Source #
See: newDescribeVpcsResponse
smart constructor.
Instances
newDescribeVpcsResponse Source #
Create a value of DescribeVpcsResponse
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:
DescribeVpcs
, describeVpcsResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
$sel:vpcs:DescribeVpcsResponse'
, describeVpcsResponse_vpcs
- Information about one or more VPCs.
$sel:httpStatus:DescribeVpcsResponse'
, describeVpcsResponse_httpStatus
- The response's http status code.
Response Lenses
describeVpcsResponse_nextToken :: Lens' DescribeVpcsResponse (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.
describeVpcsResponse_vpcs :: Lens' DescribeVpcsResponse (Maybe [Vpc]) Source #
Information about one or more VPCs.
describeVpcsResponse_httpStatus :: Lens' DescribeVpcsResponse Int Source #
The response's http status code.