:doc:`WAF <../../waf>` / Client / list_ip_sets

************
list_ip_sets
************



.. py:method:: WAF.Client.list_ip_sets(**kwargs)

  

  .. note::

    

    This is **AWS WAF Classic** documentation. For more information, see `AWS WAF Classic <https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html>`__ in the developer guide.

     

    **For the latest version of AWS WAF**, use the AWS WAFV2 API and see the `AWS WAF Developer Guide <https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html>`__. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

    

   

  Returns an array of  IPSetSummary objects in the response.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/waf-2015-08-24/ListIPSets>`_  


  **Request Syntax**
  ::

    response = client.list_ip_sets(
        NextMarker='string',
        Limit=123
    )
    
  :type NextMarker: string
  :param NextMarker: 

    AWS WAF returns a ``NextMarker`` value in the response that allows you to list another group of ``IPSets``. For the second and subsequent ``ListIPSets`` requests, specify the value of ``NextMarker`` from the previous response to get information about another batch of ``IPSets``.

    

  
  :type Limit: integer
  :param Limit: 

    Specifies the number of ``IPSet`` objects that you want AWS WAF to return for this request. If you have more ``IPSet`` objects than the number you specify for ``Limit``, the response includes a ``NextMarker`` value that you can use to get another batch of ``IPSet`` objects.

    

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

    
    ::

      {
          'NextMarker': 'string',
          'IPSets': [
              {
                  'IPSetId': 'string',
                  'Name': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **NextMarker** *(string) --* 

        To list more ``IPSet`` objects, submit another ``ListIPSets`` request, and in the next request use the ``NextMarker`` response value as the ``NextMarker`` value.

        
      

      - **IPSets** *(list) --* 

        An array of  IPSetSummary objects.

        
        

        - *(dict) --* 

          .. note::

            

            This is **AWS WAF Classic** documentation. For more information, see `AWS WAF Classic <https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html>`__ in the developer guide.

             

            **For the latest version of AWS WAF**, use the AWS WAFV2 API and see the `AWS WAF Developer Guide <https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html>`__. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

            

           

          Contains the identifier and the name of the ``IPSet``.

          
          

          - **IPSetId** *(string) --* 

            The ``IPSetId`` for an  IPSet. You can use ``IPSetId`` in a  GetIPSet request to get detailed information about an  IPSet.

            
          

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

            A friendly name or description of the  IPSet. You can't change the name of an ``IPSet`` after you create it.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`WAF.Client.exceptions.WAFInternalErrorException`

  
  *   :py:class:`WAF.Client.exceptions.WAFInvalidAccountException`

  

  **Examples**

  The following example returns an array of up to 100 IP match sets.
  ::

    response = client.list_ip_sets(
        Limit=100,
    )
    
    print(response)

  
  Expected Output:
  ::

    {
        'IPSets': [
            {
                'IPSetId': 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
                'Name': 'MyIPSetFriendlyName',
            },
        ],
        'ResponseMetadata': {
            '...': '...',
        },
    }

  