Getting Information About Your Internet Gateways

You can get information about one or more of your Internet gateways, like its attachment state or the Virtual Private Cloud (VPC) it is attached to.

If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

This procedure uses AWS CLI only. Information about these resources is also available from Cockpit. For more information, see VPC User Interface (for Cockpit v1) or the Internet Services dashboard (for Cockpit v2-beta).

To get information about one or more Internet gateways, use the describe-internet-gateways command following this syntax:

Request sample
$ aws ec2 describe-internet-gateways \
    --profile YOUR_PROFILE \
    [--internet-gateway-ids NOT_SPECIFIED] \
    --filters "Name=attachment.state,values=available" \
    --endpoint https://fcu.eu-west-2.outscale.com

This command contains the following attributes that you need to specify:

  • (optional) profile: The named profile you want to use, created when configuring AWS CLI. For more information, see Installing and Configuring AWS CLI.

  • (optional) internet-gateway-ids: One or more IDs of Internet gateways.

  • (optional) filters: One or more filters, in the "Name=X,Values=Y" format.

    You can specify several values for a same filter using the "Name=X,Values=Y, Z" format.

    The following filters are available:

    • attachment.state: The current state of the attachment between the Internet gateway and the VPC (only available, if the Internet gateway is attached to a VPC).

    • attachment.vpc-id: The ID of the VPC the Internet gateway is attached to.

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

    • tag-key: The key of a tag associated with the resource.

    • tag-value: The value of a tag associated with the resource.

    • tag:XXXX: The value of a tag associated with the resource, where XXXX is the key of the tag.

      To filter a tag whose key is XXXX and value is YYYY, you can therefore use either of the following two formats:

      • --filters Name=tag-key,Values=XXXX Name=tag-value,Values=YYYY

      • --filters Name=tag:XXXX,Values=YYYY

  • endpoint: The endpoint corresponding to the Region you want to send the request to.

The describe-internet-gateways command returns the following elements:

  • InternetGateways: Information about one or more Internet gateways. This element contains the following information:

    • Tags: One or more tags associated with the Internet gateway. This element contains the following information:

      • Value: The value of the tag.

      • Key: The key of the tag.

    • InternetGatewayId: The ID of the Internet gateway.

    • Attachments: Information about the attachment to a VPC. This element contains the following information:

      • State: The state of the attachment (only available, if the Internet gateway is attached to a VPC).

      • VpcId: The ID of the VPC the Internet gateway is attached to.

Result sample
{
    "InternetGateways": [
        {
            "Tags":[
                    {
                     "Value": "VPC1",
                     "Key": "Name"
                 }
               ],
            "InternetGatewayId": "igw-12345678",
            "Attachments": [
                {
                    "State": "available",
                    "VpcId": "vpc-12345678"
                }
            ]
        }
    ]
}

Related Pages

Corresponding API Method

AWS™ and Amazon Web Services™ are trademarks of Amazon Technologies, Inc or its affiliates in the United States and/or other countries.