Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DescribeNatGatewaysRequest

Hierarchy

Index

Properties

Optional DryRun

DryRun: undefined | false | true

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.

Optional Filter

Filter: 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: - 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.

Optional MaxResults

MaxResults: undefined | number

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Optional NatGatewayIds

NatGatewayIds: string[]

One or more NAT gateway IDs.

Optional NextToken

NextToken: undefined | string

The token for the next page of results.