WAF / Client / list_regex_pattern_sets

list_regex_pattern_sets#

WAF.Client.list_regex_pattern_sets(**kwargs)#

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.

Returns an array of RegexPatternSetSummary objects.

See also: AWS API Documentation

Request Syntax

response = client.list_regex_pattern_sets(
    NextMarker='string',
    Limit=123
)
Parameters:
  • NextMarker (string) – If you specify a value for Limit and you have more RegexPatternSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of RegexPatternSet objects. For the second and subsequent ListRegexPatternSets requests, specify the value of NextMarker from the previous response to get information about another batch of RegexPatternSet objects.

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • NextMarker (string) –

      If you have more RegexPatternSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RegexPatternSet objects, submit another ListRegexPatternSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    • 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.

Exceptions

  • WAF.Client.exceptions.WAFInternalErrorException

  • WAF.Client.exceptions.WAFInvalidAccountException