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 the your NAT gateways.
This operation returns paginated results.
- describeNatGateways :: DescribeNatGateways
- data DescribeNatGateways
- dngNatGatewayIds :: Lens' DescribeNatGateways [Text]
- dngNextToken :: Lens' DescribeNatGateways (Maybe Text)
- dngFilter :: Lens' DescribeNatGateways [Filter]
- dngMaxResults :: Lens' DescribeNatGateways (Maybe Int)
- describeNatGatewaysResponse :: Int -> DescribeNatGatewaysResponse
- data DescribeNatGatewaysResponse
- dngrsNatGateways :: Lens' DescribeNatGatewaysResponse [NatGateway]
- dngrsNextToken :: Lens' DescribeNatGatewaysResponse (Maybe Text)
- dngrsResponseStatus :: Lens' DescribeNatGatewaysResponse Int
Creating a Request
describeNatGateways :: DescribeNatGateways Source #
Creates a value of DescribeNatGateways
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dngNatGatewayIds
- One or more NAT gateway IDs.dngNextToken
- The token to retrieve the next page of results.dngFilter
- 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 =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 in which the NAT gateway resides.dngMaxResults
- The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. Constraint: If the value specified is greater than 1000, we return only 1000 items.
data DescribeNatGateways Source #
Contains the parameters for DescribeNatGateways.
See: describeNatGateways
smart constructor.
Request Lenses
dngNatGatewayIds :: Lens' DescribeNatGateways [Text] Source #
One or more NAT gateway IDs.
dngNextToken :: Lens' DescribeNatGateways (Maybe Text) Source #
The token to retrieve the next page of results.
dngFilter :: Lens' DescribeNatGateways [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 =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 in which the NAT gateway resides.
dngMaxResults :: Lens' DescribeNatGateways (Maybe Int) Source #
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. Constraint: If the value specified is greater than 1000, we return only 1000 items.
Destructuring the Response
describeNatGatewaysResponse Source #
Creates a value of DescribeNatGatewaysResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dngrsNatGateways
- Information about the NAT gateways.dngrsNextToken
- The token to use to retrieve the next page of results. This value isnull
when there are no more results to return.dngrsResponseStatus
- -- | The response status code.
data DescribeNatGatewaysResponse Source #
Contains the output of DescribeNatGateways.
See: describeNatGatewaysResponse
smart constructor.
Response Lenses
dngrsNatGateways :: Lens' DescribeNatGatewaysResponse [NatGateway] Source #
Information about the NAT gateways.
dngrsNextToken :: 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.
dngrsResponseStatus :: Lens' DescribeNatGatewaysResponse Int Source #
- - | The response status code.