WAF / Client / list_xss_match_sets

list_xss_match_sets#

WAF.Client.list_xss_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 XssMatchSet objects.

Request Syntax

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

Parameters:

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –

The response to a ListXssMatchSets request.
- NextMarker (string) –
  
  If you have more XssMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more XssMatchSet objects, submit another ListXssMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next 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.

Exceptions

Examples

The following example returns an array of up to 100 XSS match sets.

response = client.list_xss_match_sets(
    Limit=100,
)

print(response)

Expected Output:

{
    'XssMatchSets': [
        {
            'Name': 'MySampleXssMatchSet',
            'XssMatchSetId': 'example1ds3t-46da-4fdb-b8d5-abc321j569j5',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}