DescribeNatGateways
Describes one or more of the your NAT gateways.
Request Parameters
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
- Filter.N
-
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 key/value 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.
Type: Array of Filter objects
Required: No
-
- MaxResults
-
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.
Type: Integer
Required: No
- NatGatewayId.N
-
One or more NAT gateway IDs.
Type: Array of strings
Required: No
- NextToken
-
The token to retrieve the next page of results.
Type: String
Required: No
Response Elements
The following elements are returned by the service.
- natGatewaySet
-
Information about the NAT gateways.
Type: Array of NatGateway objects
- nextToken
-
The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.Type: String
- requestId
-
The ID of the request.
Type: String
Errors
For information about the errors that are common to all actions, see Common Client Errors.
Example
Example
This example describes all of your NAT gateways.
Sample Request
https://ec2.amazonaws.com/?Action=DescribeNatGateways &AUTHPARAMS
Sample Response
<DescribeNatGatewaysResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>fcb1ea98-1c04-4f9f-a96d-61442example</requestId> <natGatewaySet> <item> <createTime>2017-02-22T09:30:33.000Z</createTime> <natGatewayAddressSet> <item> <allocationId>eipalloc-8f409cb1</allocationId> <networkInterfaceId>eni-1c8fa2fc</networkInterfaceId> <privateIp>10.0.0.174</privateIp> <publicIp>203.0.113.5</publicIp> </item> </natGatewayAddressSet> <natGatewayId>nat-05a4fd8a2a3e2574d</natGatewayId> <state>available</state> <subnetId>subnet-7b16de0c</subnetId> <tagSet> <item> <key>Name</key> <value>MyNatGateway</value> </item> </tagSet> <vpcId>vpc-1a2b3c4d</vpcId> </item> </natGatewaySet> </DescribeNatGatewaysResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: