EC2 / Client / describe_internet_gateways

describe_internet_gateways

EC2.Client.describe_internet_gateways(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_internet_gateways(
    NextToken='string',
    MaxResults=123,
    DryRun=True|False,
    InternetGatewayIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)

Parameters:

• NextToken (string) – The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

• MaxResults (integer) – 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.

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

• InternetGatewayIds (list) –

  The IDs of the internet gateways.

  Default: Describes all your internet gateways.

  • (string) –

• Filters (list) –

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

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

    For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.

    • Name (string) –

      The name of the filter. Filter names are case-sensitive.

    • Values (list) –

      The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'InternetGateways': [
        {
            'Attachments': [
                {
                    'State': 'attaching'|'attached'|'detaching'|'detached',
                    'VpcId': 'string'
                },
            ],
            'InternetGatewayId': 'string',
            'OwnerId': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • InternetGateways (list) –

    Information about the internet gateways.

    • (dict) –

      Describes an internet gateway.

      • Attachments (list) –

        Any VPCs attached to the internet gateway.

        • (dict) –

          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.

      • OwnerId (string) –

        The ID of the Amazon Web Services account that owns the internet gateway.

      • Tags (list) –

        Any tags assigned to the internet gateway.

        • (dict) –

          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 256 Unicode characters.

  • NextToken (string) –

    The token to include in another request to get the next page of items. This value is null when there are no more items to return.

Examples

This example describes the Internet gateway for the specified VPC.

response = client.describe_internet_gateways(
    Filters=[
        {
            'Name': 'attachment.vpc-id',
            'Values': [
                'vpc-a01106c2',
            ],
        },
    ],
)

print(response)

Expected Output:

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