:doc:`EC2 <../../ec2>` / Paginator / DescribePublicIpv4Pools

***********************
DescribePublicIpv4Pools
***********************



.. py:class:: EC2.Paginator.DescribePublicIpv4Pools

  ::

    
    paginator = client.get_paginator('describe_public_ipv4_pools')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`EC2.Client.describe_public_ipv4_pools`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DescribePublicIpv4Pools>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PoolIds=[
              'string',
          ],
          Filters=[
              {
                  'Name': 'string',
                  'Values': [
                      'string',
                  ]
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type PoolIds: list
    :param PoolIds: 

      The IDs of the address pools.

      

    
      - *(string) --* 

      
  
    :type Filters: list
    :param Filters: 

      One or more filters.

       

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

      

    
      - *(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 <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Filtering.html#Filtering_Resources_CLI>`__ 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) --* 

          
      
      
  
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'PublicIpv4Pools': [
                {
                    'PoolId': 'string',
                    'Description': 'string',
                    'PoolAddressRanges': [
                        {
                            'FirstAddress': 'string',
                            'LastAddress': 'string',
                            'AddressCount': 123,
                            'AvailableAddressCount': 123
                        },
                    ],
                    'TotalAddressCount': 123,
                    'TotalAvailableAddressCount': 123,
                    'NetworkBorderGroup': 'string',
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ]
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **PublicIpv4Pools** *(list) --* 

          Information about the address pools.

          
          

          - *(dict) --* 

            Describes an IPv4 address pool.

            
            

            - **PoolId** *(string) --* 

              The ID of the address pool.

              
            

            - **Description** *(string) --* 

              A description of the address pool.

              
            

            - **PoolAddressRanges** *(list) --* 

              The address ranges.

              
              

              - *(dict) --* 

                Describes an address range of an IPv4 address pool.

                
                

                - **FirstAddress** *(string) --* 

                  The first IP address in the range.

                  
                

                - **LastAddress** *(string) --* 

                  The last IP address in the range.

                  
                

                - **AddressCount** *(integer) --* 

                  The number of addresses in the range.

                  
                

                - **AvailableAddressCount** *(integer) --* 

                  The number of available addresses in the range.

                  
            
          
            

            - **TotalAddressCount** *(integer) --* 

              The total number of addresses.

              
            

            - **TotalAvailableAddressCount** *(integer) --* 

              The total number of available addresses.

              
            

            - **NetworkBorderGroup** *(string) --* 

              The name of the location from which the address pool is advertised. A network border group is a unique set of Availability Zones or Local Zones from where Amazon Web Services advertises public IP addresses.

              
            

            - **Tags** *(list) --* 

              Any tags for the address pool.

              
              

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

                  
            
          
        
      
    