paws.compute (version 0.1.12)

ec2_describe_nat_gateways: Describes one or more of your NAT gateways

Description

Describes one or more of your NAT gateways.

Usage

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

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"
        )
      ),
      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"
        )
      )
    )
  ),
  NextToken = "string"
)

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

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.

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.

NatGatewayIds

One or more NAT gateway IDs.

NextToken

The token for the next page of results.

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

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