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.
Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet.
For each ByteMatchTuple object, you specify the following values:
Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate
object, you delete the existing object and add a new one.
The part of a web request that you want AWS WAF to inspect, such as a query string
or the value of the User-Agent header.
The bytes (typically a string that corresponds with ASCII characters) that you want
AWS WAF to look for. For more information, including how you specify the values for
the AWS WAF API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple
data type.
Where to look, such as at the beginning or the end of a query string.
Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.
For example, you can add a ByteMatchSetUpdate object that matches web requests
in which User-Agent headers contain the string BadBot. You can then
configure AWS WAF to block those requests.
To create and configure a ByteMatchSet, perform the following steps:
Create a ByteMatchSet. For more information, see CreateByteMatchSet.
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 UpdateByteMatchSetAsync.
Namespace: Amazon.WAF
Assembly: AWSSDK.WAF.dll
Version: 3.x.y.z
public abstract UpdateByteMatchSetResponse UpdateByteMatchSet( UpdateByteMatchSetRequest request )
Container for the necessary parameters to execute the UpdateByteMatchSet service method.
| Exception | Condition |
|---|---|
| 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. |
| WAFInvalidOperationException | The operation failed because there was nothing to do. For example: You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL. You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet. You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL. You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL. You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL. |
| 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. |
| WAFNonexistentContainerException | The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example: You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist. You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist. You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist. You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist. |
| WAFNonexistentItemException | The operation failed because the referenced object doesn't exist. |
| WAFStaleDataException | The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. |
The following example deletes a ByteMatchTuple object (filters) in an byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.
var client = new AmazonWAFClient();
var response = client.UpdateByteMatchSet(new UpdateByteMatchSetRequest
{
ByteMatchSetId = "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5",
ChangeToken = "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
Updates = new List<ByteMatchSetUpdate> {
new ByteMatchSetUpdate {
Action = "DELETE",
ByteMatchTuple = new ByteMatchTuple {
FieldToMatch = new FieldToMatch {
Data = "referer",
Type = "HEADER"
},
PositionalConstraint = "CONTAINS",
TextTransformation = "NONE"
}
}
}
});
string changeToken = response.ChangeToken;
.NET Framework:
Supported in: 4.5 and newer, 3.5