EC2 / Paginator / DescribeVpcs

DescribeVpcs#

class EC2.Paginator.DescribeVpcs#

paginator = client.get_paginator('describe_vpcs')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from EC2.Client.describe_vpcs().

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    VpcIds=[
        'string',
    ],
    DryRun=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

Filters (list) –
The 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) –
The IDs of the 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.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'Vpcs': [
        {
            'CidrBlock': 'string',
            'DhcpOptionsId': 'string',
            'State': 'pending'|'available',
            'VpcId': 'string',
            'OwnerId': 'string',
            'InstanceTenancy': 'default'|'dedicated'|'host',
            'Ipv6CidrBlockAssociationSet': [
                {
                    'AssociationId': 'string',
                    'Ipv6CidrBlock': 'string',
                    'Ipv6CidrBlockState': {
                        'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
                        'StatusMessage': 'string'
                    },
                    'NetworkBorderGroup': 'string',
                    'Ipv6Pool': 'string',
                    'Ipv6AddressAttribute': 'public'|'private',
                    'IpSource': 'amazon'|'byoip'|'none'
                },
            ],
            'CidrBlockAssociationSet': [
                {
                    'AssociationId': 'string',
                    'CidrBlock': 'string',
                    'CidrBlockState': {
                        'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
                        'StatusMessage': 'string'
                    }
                },
            ],
            'IsDefault': True|False,
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],

}

Response Structure

(dict) –
- Vpcs (list) –
  
  Information about the VPCs.
  - (dict) –
    
    Describes a VPC.
    - CidrBlock (string) –
      
      The primary IPv4 CIDR block for the VPC.
    - DhcpOptionsId (string) –
      
      The ID of the set of DHCP options you’ve associated with the VPC.
    - State (string) –
      
      The current state of the VPC.
    - VpcId (string) –
      
      The ID of the VPC.
    - OwnerId (string) –
      
      The ID of the Amazon Web Services account that owns the VPC.
    - InstanceTenancy (string) –
      
      The allowed tenancy of instances launched into the VPC.
    - Ipv6CidrBlockAssociationSet (list) –
      
      Information about the IPv6 CIDR blocks associated with the VPC.
      - (dict) –
        
        Describes an IPv6 CIDR block associated with a VPC.
        
        AssociationId (string) –
        
        The association ID for the IPv6 CIDR block.
        
        Ipv6CidrBlock (string) –
        
        The IPv6 CIDR block.
        
        Ipv6CidrBlockState (dict) –
        
        Information about the state of the CIDR block.
        
        State (string) –
        
        The state of the CIDR block.
        
        StatusMessage (string) –
        
        A message about the status of the CIDR block, if applicable.
        
        NetworkBorderGroup (string) –
        
        The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses, for example, us-east-1-wl1-bos-wlz-1.
        
        Ipv6Pool (string) –
        
        The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
        
        Ipv6AddressAttribute (string) –
        
        Public IPv6 addresses are those advertised on the internet from Amazon Web Services. Private IP addresses are not and cannot be advertised on the internet from Amazon Web Services.
        
        IpSource (string) –
        
        The source that allocated the IP address space. byoip or amazon indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). none indicates private space.
    - CidrBlockAssociationSet (list) –
      
      Information about the IPv4 CIDR blocks associated with the VPC.
      - (dict) –
        
        Describes an IPv4 CIDR block associated with a VPC.
        
        AssociationId (string) –
        
        The association ID for the IPv4 CIDR block.
        
        CidrBlock (string) –
        
        The IPv4 CIDR block.
        
        CidrBlockState (dict) –
        
        Information about the state of the CIDR block.
        
        State (string) –
        
        The state of the CIDR block.
        
        StatusMessage (string) –
        
        A message about the status of the CIDR block, if applicable.
    - IsDefault (boolean) –
      
      Indicates whether the VPC is the default VPC.
    - Tags (list) –
      
      Any tags assigned to the VPC.
      - (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.