WAF / Client / list_size_constraint_sets

list_size_constraint_sets#

WAF.Client.list_size_constraint_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 SizeConstraintSetSummary objects.

See also: AWS API Documentation

Request Syntax

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

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

Return type:

dict

Returns:

Response Syntax

{
    'NextMarker': 'string',
    'SizeConstraintSets': [
        {
            'SizeConstraintSetId': 'string',
            'Name': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • NextMarker (string) –

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

    • SizeConstraintSets (list) –

      An array of SizeConstraintSetSummary 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 a SizeConstraintSet.

        • SizeConstraintSetId (string) –

          A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get information about a SizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet).

          SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

        • Name (string) –

          The name of the SizeConstraintSet, if any.

Exceptions

  • WAF.Client.exceptions.WAFInternalErrorException

  • WAF.Client.exceptions.WAFInvalidAccountException

Examples

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

response = client.list_size_constraint_sets(
    Limit=100,
)

print(response)

Expected Output:

{
    'SizeConstraintSets': [
        {
            'Name': 'MySampleSizeConstraintSet',
            'SizeConstraintSetId': 'example1ds3t-46da-4fdb-b8d5-abc321j569j5',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}