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
create_byte_match_set
.
Use get_change_token
to get the
change token that you provide in the ChangeToken
parameter of an
update_byte_match_set
request.
Submit an
update_byte_match_set
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.
wafregional_update_byte_match_set(ByteMatchSetId, ChangeToken, Updates)
[required] The ByteMatchSetId
of the ByteMatchSet that you want to update.
ByteMatchSetId
is returned by
create_byte_match_set
and by
list_byte_match_sets
.
[required] The value returned by the most recent call to
get_change_token
.
[required] An array of ByteMatchSetUpdate
objects that you want to insert into or
delete from a ByteMatchSet. For more information, see the applicable
data types:
ByteMatchSetUpdate: Contains Action
and ByteMatchTuple
ByteMatchTuple: Contains FieldToMatch
, PositionalConstraint
,
TargetString
, and TextTransformation
FieldToMatch: Contains Data
and Type
A list with the following syntax:
list( ChangeToken = "string" )
svc$update_byte_match_set( ByteMatchSetId = "string", ChangeToken = "string", Updates = list( list( Action = "INSERT"|"DELETE", ByteMatchTuple = list( FieldToMatch = list( Type = "URI"|"QUERY_STRING"|"HEADER"|"METHOD"|"BODY"|"SINGLE_QUERY_ARG"|"ALL_QUERY_ARGS", Data = "string" ), TargetString = raw, TextTransformation = "NONE"|"COMPRESS_WHITE_SPACE"|"HTML_ENTITY_DECODE"|"LOWERCASE"|"CMD_LINE"|"URL_DECODE", PositionalConstraint = "EXACTLY"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CONTAINS_WORD" ) ) ) )
# NOT RUN {
# The following example deletes a ByteMatchTuple object (filters) in an
# byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.
svc$update_byte_match_set(
ByteMatchSetId = "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5",
ChangeToken = "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
Updates = list(
list(
Action = "DELETE",
ByteMatchTuple = list(
FieldToMatch = list(
Data = "referer",
Type = "HEADER"
),
PositionalConstraint = "CONTAINS",
TargetString = "badrefer1",
TextTransformation = "NONE"
)
)
)
)
# }
# NOT RUN {
# }
Run the code above in your browser using DataLab