WAF / Paginator / ListXssMatchSets

ListXssMatchSets

class WAF.Paginator.ListXssMatchSets

paginator = client.get_paginator('list_xss_match_sets')

paginate(**kwargs)

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

{
    'XssMatchSets': [
        {
            'XssMatchSetId': 'string',
            'Name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  The response to a ListXssMatchSets request.

  • XssMatchSets (list) –

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

      The Id and Name of an XssMatchSet.

      • XssMatchSetId (string) –

        A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about a XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see DeleteXssMatchSet).

        XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

      • Name (string) –

        The name of the XssMatchSet, if any, specified by Id.

  • NextToken (string) –

    A token to resume pagination.