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.
/// The operation failed because of a system problem, even though the request was valid.
/// Retry your request.
///
/// The operation failed because you tried to create, update, or delete an object by using
/// an invalid account identifier.
///
/// 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 an IP address to an
IPSet
, but the IP address already
/// exists in the specified IPSet
.
///
/// -
///
/// You tried to add a
ByteMatchTuple
to a ByteMatchSet
, but
/// the ByteMatchTuple
already exists in the specified WebACL
.
///
///
///
/// 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 DefaultAction
Type
/// other than ALLOW
, BLOCK
, or COUNT
.
///
/// -
///
/// You tried to update a
WebACL
with a WafAction
Type
/// other than ALLOW
, BLOCK
, or COUNT
.
///
/// -
///
/// You tried to update a
ByteMatchSet
with a FieldToMatch
Type
/// other than HEADER, QUERY_STRING, or URI.
///
/// -
///
/// 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.
///
///
///
/// 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.
///
/// 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.
///
///
///
/// The operation failed because the referenced object doesn't exist.
///
/// The operation failed because you tried to create, update, or delete an object by using
/// a change token that has already been used.
///