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 moreSizeConstraintSets
than the value ofLimit
, AWS WAF returns aNextMarker
value in the response that allows you to list another group ofSizeConstraintSets
. For the second and subsequentListSizeConstraintSets
requests, specify the value ofNextMarker
from the previous response to get information about another batch ofSizeConstraintSets
.Limit (integer) – Specifies the number of
SizeConstraintSet
objects that you want AWS WAF to return for this request. If you have moreSizeConstraintSets
objects than the number you specify forLimit
, the response includes aNextMarker
value that you can use to get another batch ofSizeConstraintSet
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 forLimit
in the request, the response includes aNextMarker
value. To list moreSizeConstraintSet
objects, submit anotherListSizeConstraintSets
request, and specify theNextMarker
value from the response in theNextMarker
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
andName
of aSizeConstraintSet
.SizeConstraintSetId (string) –
A unique identifier for a
SizeConstraintSet
. You useSizeConstraintSetId
to get information about aSizeConstraintSet
(see GetSizeConstraintSet), update aSizeConstraintSet
(see UpdateSizeConstraintSet), insert aSizeConstraintSet
into aRule
or delete one from aRule
(see UpdateRule), and delete aSizeConstraintSet
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': { '...': '...', }, }