:doc:`NetworkFirewall <../../network-firewall>` / Paginator / ListProxies

***********
ListProxies
***********



.. py:class:: NetworkFirewall.Paginator.ListProxies

  ::

    
    paginator = client.get_paginator('list_proxies')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`NetworkFirewall.Client.list_proxies`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/ListProxies>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': '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**

      
      ::

        {
            'Proxies': [
                {
                    'Name': 'string',
                    'Arn': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Proxies** *(list) --* 

          The metadata for the proxies. Depending on your setting for max results and the number of proxies that you have, this might not be the full list.

          
          

          - *(dict) --* 

            High-level information about a proxy, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a proxy. You can retrieve all objects for a proxy by calling  DescribeProxy.

            
            

            - **Name** *(string) --* 

              The descriptive name of the proxy. You can't change the name of a proxy after you create it.

              
            

            - **Arn** *(string) --* 

              The Amazon Resource Name (ARN) of a proxy.

              
        
      
    