ServiceResource / Collection / internet_gateways

internet_gateways#

EC2.ServiceResource.internet_gateways#

A collection of InternetGateway resources.A InternetGateway Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.

all()#

Creates an iterable of all InternetGateway resources in the collection.

See also: AWS API Documentation

Request Syntax

internet_gateway_iterator = ec2.internet_gateways.all()
Return type:

list(ec2.InternetGateway)

Returns:

A list of InternetGateway resources

filter(**kwargs)#

Creates an iterable of all InternetGateway resources in the collection filtered by kwargs passed to method. A InternetGateway collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.

See also: AWS API Documentation

Request Syntax

internet_gateway_iterator = ec2.internet_gateways.filter(
    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:

list(ec2.InternetGateway)

Returns:

A list of InternetGateway resources

limit(**kwargs)#

Creates an iterable up to a specified amount of InternetGateway resources in the collection.

See also: AWS API Documentation

Request Syntax

internet_gateway_iterator = ec2.internet_gateways.limit(
    count=123
)
Parameters:

count (integer) – The limit to the number of resources in the iterable.

Return type:

list(ec2.InternetGateway)

Returns:

A list of InternetGateway resources

page_size(**kwargs)#

Creates an iterable of all InternetGateway resources in the collection, but limits the number of items returned by each service call by the specified amount.

See also: AWS API Documentation

Request Syntax

internet_gateway_iterator = ec2.internet_gateways.page_size(
    count=123
)
Parameters:

count (integer) – The number of items returned by each service call

Return type:

list(ec2.InternetGateway)

Returns:

A list of InternetGateway resources