Describe Internet Gateways

ec2_describe_internet_gateways

R Documentation

Describes your internet gateways

Description

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

Usage

ec2_describe_internet_gateways(Filters, DryRun, InternetGatewayIds,
  NextToken, MaxResults)

Arguments

Filters

The filters.

• attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.

• attachment.vpc-id - The ID of an attached VPC.

• internet-gateway-id - The ID of the Internet gateway.

• owner-id - The ID of the Amazon Web Services account that owns the internet gateway.

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

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.

InternetGatewayIds

The IDs of the internet gateways.

Default: Describes all your internet gateways.

NextToken

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

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.

Value

A list with the following syntax:

list(
  InternetGateways = list(
    list(
      Attachments = list(
        list(
          State = "attaching"|"attached"|"detaching"|"detached",
          VpcId = "string"
        )
      ),
      InternetGatewayId = "string",
      OwnerId = "string",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_internet_gateways(
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  DryRun = TRUE|FALSE,
  InternetGatewayIds = list(
    "string"
  ),
  NextToken = "string",
  MaxResults = 123
)

Examples

## Not run: 
# This example describes the Internet gateway for the specified VPC.
svc$describe_internet_gateways(
  Filters = list(
    list(
      Name = "attachment.vpc-id",
      Values = list(
        "vpc-a01106c2"
      )
    )
  )
)

## End(Not run)