WAF / Paginator / ListRegexPatternSets

ListRegexPatternSets

class WAF.Paginator.ListRegexPatternSets

paginator = client.get_paginator('list_regex_pattern_sets')

paginate(**kwargs)

Creates an iterator that will paginate through responses from WAF.Client.list_regex_pattern_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

{
    'RegexPatternSets': [
        {
            'RegexPatternSetId': 'string',
            'Name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • RegexPatternSets (list) –

    An array of RegexPatternSetSummary 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.

      Returned by ListRegexPatternSets. Each RegexPatternSetSummary object includes the Name and RegexPatternSetId for one RegexPatternSet.

      • RegexPatternSetId (string) –

        The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet, update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF.

        RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

      • Name (string) –

        A friendly name or description of the RegexPatternSet. You can’t change Name after you create a RegexPatternSet.

  • NextToken (string) –

    A token to resume pagination.