WAF / Paginator / ListRegexMatchSets

ListRegexMatchSets

class WAF.Paginator.ListRegexMatchSets

paginator = client.get_paginator('list_regex_match_sets')

paginate(**kwargs)

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

{
    'RegexMatchSets': [
        {
            'RegexMatchSetId': 'string',
            'Name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • RegexMatchSets (list) –

    An array of RegexMatchSetSummary 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 ListRegexMatchSets. Each RegexMatchSetSummary object includes the Name and RegexMatchSetId for one RegexMatchSet.

      • RegexMatchSetId (string) –

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

        RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.

      • Name (string) –

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

  • NextToken (string) –

    A token to resume pagination.