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 NAT gateways.
This operation returns paginated results.
Synopsis
- data DescribeNatGateways = DescribeNatGateways' {}
- newDescribeNatGateways :: DescribeNatGateways
- describeNatGateways_dryRun :: Lens' DescribeNatGateways (Maybe Bool)
- describeNatGateways_filter :: Lens' DescribeNatGateways (Maybe [Filter])
- describeNatGateways_maxResults :: Lens' DescribeNatGateways (Maybe Natural)
- describeNatGateways_natGatewayIds :: Lens' DescribeNatGateways (Maybe [Text])
- describeNatGateways_nextToken :: Lens' DescribeNatGateways (Maybe Text)
- data DescribeNatGatewaysResponse = DescribeNatGatewaysResponse' {
- natGateways :: Maybe [NatGateway]
- nextToken :: Maybe Text
- httpStatus :: Int
- newDescribeNatGatewaysResponse :: Int -> DescribeNatGatewaysResponse
- describeNatGatewaysResponse_natGateways :: Lens' DescribeNatGatewaysResponse (Maybe [NatGateway])
- describeNatGatewaysResponse_nextToken :: Lens' DescribeNatGatewaysResponse (Maybe Text)
- describeNatGatewaysResponse_httpStatus :: Lens' DescribeNatGatewaysResponse Int
Creating a Request
data DescribeNatGateways Source #
See: newDescribeNatGateways
smart constructor.
DescribeNatGateways' | |
|
Instances
newDescribeNatGateways :: DescribeNatGateways Source #
Create a value of DescribeNatGateways
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:DescribeNatGateways'
, describeNatGateways_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:filter':DescribeNatGateways'
, describeNatGateways_filter
- One or more filters.
nat-gateway-id
- The ID of the NAT gateway.state
- The state of the NAT gateway (pending
|failed
|available
|deleting
|deleted
).subnet-id
- The ID of the subnet in which the NAT gateway resides.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 in which the NAT gateway resides.
$sel:maxResults:DescribeNatGateways'
, describeNatGateways_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.
$sel:natGatewayIds:DescribeNatGateways'
, describeNatGateways_natGatewayIds
- One or more NAT gateway IDs.
DescribeNatGateways
, describeNatGateways_nextToken
- The token for the next page of results.
Request Lenses
describeNatGateways_dryRun :: Lens' DescribeNatGateways (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
.
describeNatGateways_filter :: Lens' DescribeNatGateways (Maybe [Filter]) Source #
One or more filters.
nat-gateway-id
- The ID of the NAT gateway.state
- The state of the NAT gateway (pending
|failed
|available
|deleting
|deleted
).subnet-id
- The ID of the subnet in which the NAT gateway resides.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 in which the NAT gateway resides.
describeNatGateways_maxResults :: Lens' DescribeNatGateways (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.
describeNatGateways_natGatewayIds :: Lens' DescribeNatGateways (Maybe [Text]) Source #
One or more NAT gateway IDs.
describeNatGateways_nextToken :: Lens' DescribeNatGateways (Maybe Text) Source #
The token for the next page of results.
Destructuring the Response
data DescribeNatGatewaysResponse Source #
See: newDescribeNatGatewaysResponse
smart constructor.
DescribeNatGatewaysResponse' | |
|
Instances
newDescribeNatGatewaysResponse Source #
Create a value of DescribeNatGatewaysResponse
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:natGateways:DescribeNatGatewaysResponse'
, describeNatGatewaysResponse_natGateways
- Information about the NAT gateways.
DescribeNatGateways
, describeNatGatewaysResponse_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:httpStatus:DescribeNatGatewaysResponse'
, describeNatGatewaysResponse_httpStatus
- The response's http status code.
Response Lenses
describeNatGatewaysResponse_natGateways :: Lens' DescribeNatGatewaysResponse (Maybe [NatGateway]) Source #
Information about the NAT gateways.
describeNatGatewaysResponse_nextToken :: Lens' DescribeNatGatewaysResponse (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.
describeNatGatewaysResponse_httpStatus :: Lens' DescribeNatGatewaysResponse Int Source #
The response's http status code.