WAF / Client / get_regex_match_set

get_regex_match_set

WAF.Client.get_regex_match_set(**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 the RegexMatchSet specified by RegexMatchSetId.

See also: AWS API Documentation

Request Syntax

response = client.get_regex_match_set(
    RegexMatchSetId='string'
)

Parameters:

RegexMatchSetId (string) –

[REQUIRED]

The RegexMatchSetId of the RegexMatchSet that you want to get. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.

Return type:

dict

Returns:

Response Syntax

{
    'RegexMatchSet': {
        'RegexMatchSetId': 'string',
        'Name': 'string',
        'RegexMatchTuples': [
            {
                'FieldToMatch': {
                    'Type': 'URI'|'QUERY_STRING'|'HEADER'|'METHOD'|'BODY'|'SINGLE_QUERY_ARG'|'ALL_QUERY_ARGS',
                    'Data': 'string'
                },
                'TextTransformation': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE',
                'RegexPatternSetId': 'string'
            },
        ]
    }
}

Response Structure

• (dict) –

  • RegexMatchSet (dict) –

    Information about the RegexMatchSet that you specified in the GetRegexMatchSet request. For more information, see RegexMatchTuple.

    • RegexMatchSetId (string) –

      The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get information about a RegexMatchSet (see GetRegexMatchSet), update a RegexMatchSet (see UpdateRegexMatchSet), insert a RegexMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a RegexMatchSet from AWS WAF (see DeleteRegexMatchSet).

      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.

    • RegexMatchTuples (list) –

      Contains an array of RegexMatchTuple objects. Each RegexMatchTuple object contains:

      • The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.

      • The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.

      • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

      • (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 regular expression pattern that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. Each RegexMatchTuple object contains:

        • The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.

        • The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.

        • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

        • FieldToMatch (dict) –

          Specifies where in a web request to look for the RegexPatternSet.

          • Type (string) –

            The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

            • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.

            • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

            • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.

            • URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

            • SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.

            • ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString.

          • Data (string) –

            When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive.

            When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive.

            If the value of Type is any other value, omit Data.

        • TextTransformation (string) –

          Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on RegexPatternSet before inspecting a request for a match.

          You can only specify a single type of TextTransformation.

          CMD_LINE

          When you’re concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

          • Delete the following characters: “ ‘ ^

          • Delete spaces before the following characters: / (

          • Replace the following characters with a space: , ;

          • Replace multiple spaces with one space

          • Convert uppercase letters (A-Z) to lowercase (a-z)

          COMPRESS_WHITE_SPACE

          Use this option to replace the following characters with a space character (decimal 32):

          • f, formfeed, decimal 12

          • t, tab, decimal 9

          • n, newline, decimal 10

          • r, carriage return, decimal 13

          • v, vertical tab, decimal 11

          • non-breaking space, decimal 160

          COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

          HTML_ENTITY_DECODE

          Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

          • Replaces (ampersand)quot; with "

          • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

          • Replaces (ampersand)lt; with a “less than” symbol

          • Replaces (ampersand)gt; with >

          • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

          • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

          LOWERCASE

          Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

          URL_DECODE

          Use this option to decode a URL-encoded value.

          NONE

          Specify NONE if you don’t want to perform any text transformations.

        • RegexPatternSetId (string) –

          The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet (see GetRegexPatternSet), update a RegexPatternSet (see UpdateRegexPatternSet), insert a RegexPatternSet into a RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet).

          RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

Exceptions

• WAF.Client.exceptions.WAFInternalErrorException

• WAF.Client.exceptions.WAFInvalidAccountException

• WAF.Client.exceptions.WAFNonexistentItemException