vpcs¶

EC2.ServiceResource.vpcs¶

A collection of Vpc resources.A Vpc 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 Vpc resources in the collection.

See also: AWS API Documentation

Request Syntax

vpc_iterator = ec2.vpcs.all()

Return type: list(ec2.Vpc)
Returns: A list of Vpc resources

filter(**kwargs)¶

Creates an iterable of all Vpc resources in the collection filtered by kwargs passed to method. A Vpc 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

vpc_iterator = ec2.vpcs.filter(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    VpcIds=[
        'string',
    ],
    DryRun=True|False,
    NextToken='string',
    MaxResults=123
)

Parameters

Filters (list) --
One or more filters.
- cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28 ).
- cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC.
- cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with the VPC.
- cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC.
- dhcp-options-id - The ID of a set of DHCP options.
- ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC.
- ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
- ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated with the VPC.
- ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC.
- is-default - Indicates whether the VPC is the default VPC.
- owner-id - The ID of the Amazon Web Services account that owns the VPC.
- state - The state of the VPC ( pending | available ).
- 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.
- vpc-id - The ID of the VPC.
- (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.
  - 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) --
VpcIds (list) --
One or more VPC IDs.

Default: Describes all your VPCs.
- (string) --
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 .
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.

Return type

list(ec2.Vpc)

Returns

A list of Vpc resources

limit(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

vpc_iterator = ec2.vpcs.limit(
    count=123
)

Parameters: count (integer) -- The limit to the number of resources in the iterable.
Return type: list(ec2.Vpc)
Returns: A list of Vpc resources

page_size(**kwargs)¶

Creates an iterable of all Vpc 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

vpc_iterator = ec2.vpcs.page_size(
    count=123
)

Parameters: count (integer) -- The number of items returned by each service call
Return type: list(ec2.Vpc)
Returns: A list of Vpc resources

Table Of Contents

vpcs¶