Skip to content

Describe Nat Gateways

ec2_describe_nat_gateways R Documentation

Describes your NAT gateways

Description

Describes your NAT gateways. The default is to describe all your NAT gateways. Alternatively, you can specify specific NAT gateway IDs or filter the results to include only the NAT gateways that match specific criteria.

Usage

ec2_describe_nat_gateways(DryRun, Filter, MaxResults, NatGatewayIds,
  NextToken)

Arguments

DryRun

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.

Filter

The 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.

MaxResults

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

NatGatewayIds

The IDs of the NAT gateways.

NextToken

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Value

A list with the following syntax: 

list(
  NatGateways = list(
    list(
      CreateTime = as.POSIXct(
        "2015-01-01"
      ),
      DeleteTime = as.POSIXct(
        "2015-01-01"
      ),
      FailureCode = "string",
      FailureMessage = "string",
      NatGatewayAddresses = list(
        list(
          AllocationId = "string",
          NetworkInterfaceId = "string",
          PrivateIp = "string",
          PublicIp = "string",
          AssociationId = "string",
          IsPrimary = TRUE|FALSE,
          FailureMessage = "string",
          Status = "assigning"|"unassigning"|"associating"|"disassociating"|"succeeded"|"failed"
        )
      ),
      NatGatewayId = "string",
      ProvisionedBandwidth = list(
        ProvisionTime = as.POSIXct(
          "2015-01-01"
        ),
        Provisioned = "string",
        RequestTime = as.POSIXct(
          "2015-01-01"
        ),
        Requested = "string",
        Status = "string"
      ),
      State = "pending"|"failed"|"available"|"deleting"|"deleted",
      SubnetId = "string",
      VpcId = "string",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      ConnectivityType = "private"|"public"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_nat_gateways(
  DryRun = TRUE|FALSE,
  Filter = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NatGatewayIds = list(
    "string"
  ),
  NextToken = "string"
)

Examples

## Not run: 
# This example describes the NAT gateway for the specified VPC.
svc$describe_nat_gateways(
  Filter = list(
    list(
      Name = "vpc-id",
      Values = list(
        "vpc-1a2b3c4d"
      )
    )
  )
)

## End(Not run)