AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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 ByteMatchSet
. You then use UpdateByteMatchSet to identify
the part of a web request that you want AWS WAF to inspect, such as the values of
the User-Agent
header or the query string. For example, you can create a ByteMatchSet
that matches any requests with User-Agent
headers that contain the string BadBot
.
You can then configure AWS WAF to reject those requests.
To create and configure a ByteMatchSet
, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a CreateByteMatchSet
request.
Submit a CreateByteMatchSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateByteMatchSet
request.
Submit an UpdateByteMatchSet 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.
For .NET Core this operation is only available in asynchronous form. Please refer to CreateByteMatchSetAsync.
Namespace: Amazon.WAF
Assembly: AWSSDK.WAF.dll
Version: 3.x.y.z
public abstract CreateByteMatchSetResponse CreateByteMatchSet( String name, String changeToken )
A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.
The value returned by the most recent call to GetChangeToken.
Exception | Condition |
---|---|
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, or WebACL) using an action other than INSERT or DELETE. You tried to create a WebACL with a DefaultActionType other than ALLOW, BLOCK, or COUNT. You tried to create a RateBasedRule with a RateKey value other than IP. You tried to update a WebACL with a WafActionType other than ALLOW, BLOCK, or COUNT. You tried to update a ByteMatchSet with a FieldToMatchType other than HEADER, METHOD, QUERY_STRING, URI, or BODY. You tried to update a ByteMatchSet with a Field of HEADER but no value for Data. 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 WebACL objects 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. |
.NET Framework:
Supported in: 4.5 and newer, 3.5