DescribeNatGateways
GET /?Action=DescribeNatGateways
Description
Describes one or more network address translation (NAT) gateways.
You can use the Filter.N parameter to filter the NAT gateways on the following properties:
-
nat-gateway-id
: The ID of the NAT gateway. -
state
: The state of the NAT gateway (pending
|available
|deleting
|deleted
). -
subnet-id
: The ID of the subnet in which the NAT gateway is. -
vpc-id
: The ID of the VPC in which the NAT gateway is. -
tag-key
: The key of a tag associated with the resource. -
tag-value
: The value of a tag associated with the resource. -
tag:XXXX
: The value of a tag associated with the resource, whereXXXX
is the key of the tag.
Note
|
If you exceed the number of identical requests allowed for a configured time period, the |
Body parameter
Required: false
Name: DescribeNatGatewaysRequest
Name | Description | Required | Schema | Default | Example |
---|---|---|---|---|---|
Filter.N |
One or more filters. Example: |
false |
|||
MaxResults |
The maximum number of results that can be returned in a single page. You can use NextToken to request the next results pages. This value is between 5 and 1000. If you provide a value larger than 1000, only 1000 results are returned. |
false |
integer |
||
NatGatewayId.N |
One or more IDs of NAT gateways. |
false |
string |
||
NextToken |
The token to request the next results page. |
false |
string |
Responses
HTTP Code 200
HTTP Code | Description | Schema |
---|---|---|
200 |
DescribeNatGatewaysResult |
Response 200
Name | Description | Required | Schema | Default | Example |
---|---|---|---|---|---|
natGatewaySet.N |
Information about one or more NAT gateways. |
false |
|||
nextToken |
The token to request the next results page. If the value is |
false |
string |
||
requestId |
The ID of the request. |
false |
string |