Sign In to the Console
Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

AWS Documentation » Amazon EC2 » API Reference » Actions » DescribeNatGateways
The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

DescribeNatGateways

Describes one or more of 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> - 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 key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA 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.

Type: Array of Filter objects

Required: No

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.

Type: Integer

Valid Range: Minimum value of 5. Maximum value of 1000.

Required: No

NatGatewayId.N

One or more NAT gateway IDs.

Type: Array of strings

Required: No

NextToken

The token for 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: