paws.compute (version 0.1.12)

ec2_describe_internet_gateways: Describes one or more of your internet gateways

Description

Describes one or more of your internet gateways.

Usage

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

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"
)

Arguments

Filters

One or more 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 AWS 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

One or more internet gateway IDs.

Default: Describes all your internet gateways.

NextToken

The token for the next page of results.

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.

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

if (FALSE) {
# 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"
      )
    )
  )
)
}