Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . ec2 ]

describe-internet-gateways

Description

Describes one or more of your internet gateways.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-internet-gateways
[--filters <value>]
[--dry-run | --no-dry-run]
[--internet-gateway-ids <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--filters (list)

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

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--dry-run | --no-dry-run (boolean)

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 .

--internet-gateway-ids (list)

One or more internet gateway IDs.

Default: Describes all your internet gateways.

Syntax:

"string" "string" ...

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To describe your Internet gateways

This example describes your Internet gateways.

Command:

aws ec2 describe-internet-gateways

Output:

{
    "InternetGateways": [
        {
            "Tags": [],
            "InternetGatewayId": "igw-c0a643a9",
            "Attachments": [
                {
                    "State": "available",
                    "VpcId": "vpc-a01106c2"
                }
            ]
        },
        {
            "Tags": [],
            "InternetGatewayId": "igw-046d7966",
            "Attachments": []
        }
    ]
}

To describe the Internet gateway for a specific VPC

This example describes the Internet gateway for the specified VPC.

Command:

aws ec2 describe-internet-gateways --filters "Name=attachment.vpc-id,Values=vpc-a01106c2"

Output:

{
    "InternetGateways": [
        {
            "Tags": [],
            "InternetGatewayId": "igw-c0a643a9",
            "Attachments": [
                {
                    "State": "available",
                    "VpcId": "vpc-a01106c2"
                }
            ]
        }
    ]
}

Output

InternetGateways -> (list)

Information about one or more internet gateways.

(structure)

Describes an internet gateway.

Attachments -> (list)

Any VPCs attached to the internet gateway.

(structure)

Describes the attachment of a VPC to an internet gateway or an egress-only internet gateway.

State -> (string)

The current state of the attachment. For an internet gateway, the state is available when attached to a VPC; otherwise, this value is not returned.

VpcId -> (string)

The ID of the VPC.

InternetGatewayId -> (string)

The ID of the internet gateway.

Tags -> (list)

Any tags assigned to the internet gateway.

(structure)

Describes a tag.

Key -> (string)

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:

Value -> (string)

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.