create_size_constraint_set
¶
create_size_constraint_set(
name: ResourceName,
change_token: ChangeToken,
*,
config_overrides: Optional[WAFRegionalClientConfig] = None,
) -> CreateSizeConstraintSetResponse
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.
Creates a SizeConstraintSet. You then use UpdateSizeConstraintSet to identify the part of a web request that you want AWS WAF to check for length, such as the length of the User-Agent header or the length of the query string. For example, you can create a SizeConstraintSet that matches any requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those requests.
To create and configure a SizeConstraintSet, perform the following steps:
-
Use GetChangeToken to get the change token that you provide in the
ChangeTokenparameter of aCreateSizeConstraintSetrequest. -
Submit a
CreateSizeConstraintSetrequest. -
Use
GetChangeTokento get the change token that you provide in theChangeTokenparameter of anUpdateSizeConstraintSetrequest. -
Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
Parameters:
-
name(ResourceName) –A friendly name or description of the SizeConstraintSet. You can't change
Nameafter you create aSizeConstraintSet. -
change_token(ChangeToken) –The value returned by the most recent call to GetChangeToken.
Raises:
-
WAFDisallowedNameException–The name specified is invalid.
-
WAFInternalErrorException–The operation failed because of a system problem, even though the request was valid. Retry your request.
-
WAFInvalidAccountException–The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
-
WAFInvalidParameterException–The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet,IPSet,Rule, orWebACL) using an action other thanINSERTorDELETE. -
You tried to create a
WebACLwith aDefaultActionTypeother thanALLOW,BLOCK, orCOUNT. -
You tried to create a
RateBasedRulewith aRateKeyvalue other thanIP. -
You tried to update a
WebACLwith aWafActionTypeother thanALLOW,BLOCK, orCOUNT. -
You tried to update a
ByteMatchSetwith aFieldToMatchTypeother than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSetwith aFieldofHEADERbut no value forData. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
-
-
WAFLimitsExceededException–The operation exceeds a resource limit, for example, the maximum number of
WebACLobjects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. -
WAFStaleDataException–The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
-
UnknownServiceError–The service returned an error code this client does not model.
Examples:
To create a size constraint The following example creates size constraint set named MySampleSizeConstraintSet.
>>> client.create_size_constraint_set(name='MySampleSizeConstraintSet', change_token='abcd12f2-46da-4fdb-b8d5-fbd4c466928f')