list_byte_match_sets

list_byte_match_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 ByteMatchSetSummary objects.

See also: AWS API Documentation

Request Syntax

response = client.list_byte_match_sets(
    NextMarker='string',
    Limit=123
)

Parameters

• NextMarker (string) -- If you specify a value for Limit and you have more ByteMatchSets than the value of Limit , AWS WAF returns a NextMarker value in the response that allows you to list another group of ByteMatchSets . For the second and subsequent ListByteMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of ByteMatchSets .
• Limit (integer) -- Specifies the number of ByteMatchSet objects that you want AWS WAF to return for this request. If you have more ByteMatchSets objects than the number you specify for Limit , the response includes a NextMarker value that you can use to get another batch of ByteMatchSet objects.

Return type

dict

Returns

Response Syntax

{
    'NextMarker': 'string',
    'ByteMatchSets': [
        {
            'ByteMatchSetId': 'string',
            'Name': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • NextMarker (string) --

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

  • ByteMatchSets (list) --

    An array of ByteMatchSetSummary 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 ListByteMatchSets. Each ByteMatchSetSummary object includes the Name and ByteMatchSetId for one ByteMatchSet.

      • ByteMatchSetId (string) --

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

        ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

      • Name (string) --

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

Exceptions

• WAFRegional.Client.exceptions.WAFInternalErrorException
• WAFRegional.Client.exceptions.WAFInvalidAccountException