WAF / Paginator / ListIPSets

ListIPSets

class WAF.Paginator.ListIPSets

paginator = client.get_paginator('list_ip_sets')

paginate(**kwargs)

Creates an iterator that will paginate through responses from WAF.Client.list_ip_sets().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

{
    'IPSets': [
        {
            'IPSetId': 'string',
            'Name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • IPSets (list) –

    An array of IPSetSummary objects.

    • (dict) –

      Note

      This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

      For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. 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.

  • NextToken (string) –

    A token to resume pagination.