UPDATEBYTEMATCHSET()`¶

About UpdateByteMatchSet¶

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.

Method Signature¶

METHODS /AWS1/IF_WAF~UPDATEBYTEMATCHSET
  IMPORTING
    !IV_BYTEMATCHSETID TYPE /AWS1/WAFRESOURCEID OPTIONAL
    !IV_CHANGETOKEN TYPE /AWS1/WAFCHANGETOKEN OPTIONAL
    !IT_UPDATES TYPE /AWS1/CL_WAFBYTEMATCHSETUPDATE=>TT_BYTEMATCHSETUPDATES OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wafupdbytematchsetrsp
  RAISING
    /AWS1/CX_WAFWAFINTERNALERROREX
    /AWS1/CX_WAFWAFINVACCOUNTEX
    /AWS1/CX_WAFWAFINVALIDOPEX
    /AWS1/CX_WAFWAFINVALIDPARAMEX
    /AWS1/CX_WAFWAFLIMITSEXCDEX
    /AWS1/CX_WAFWAFNONEXENTCONTA00
    /AWS1/CX_WAFWAFNONEXENTITEMEX
    /AWS1/CX_WAFWAFSTALEDATAEX
    /AWS1/CX_WAFCLIENTEXC
    /AWS1/CX_WAFSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_bytematchsetid` `TYPE /AWS1/WAFRESOURCEID` `/AWS1/WAFRESOURCEID`¶

The ByteMatchSetId of the ByteMatchSet that you want to update. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

`iv_changetoken` `TYPE /AWS1/WAFCHANGETOKEN` `/AWS1/WAFCHANGETOKEN`¶

The value returned by the most recent call to GetChangeToken.

`it_updates` `TYPE /AWS1/CL_WAFBYTEMATCHSETUPDATE=>TT_BYTEMATCHSETUPDATES` `TT_BYTEMATCHSETUPDATES`¶

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

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_wafupdbytematchsetrsp` `/AWS1/CL_WAFUPDBYTEMATCHSETRSP`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->updatebytematchset(
  it_updates = VALUE /aws1/cl_wafbytematchsetupdate=>tt_bytematchsetupdates(
    (
      new /aws1/cl_wafbytematchsetupdate(
        io_bytematchtuple = new /aws1/cl_wafbytematchtuple(
          io_fieldtomatch = new /aws1/cl_waffieldtomatch(
            iv_data = |string|
            iv_type = |string|
          )
          iv_positionalconstraint = |string|
          iv_targetstring = '5347567362473873563239796247513D'
          iv_texttransformation = |string|
        )
        iv_action = |string|
      )
    )
  )
  iv_bytematchsetid = |string|
  iv_changetoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_changetoken = lo_result->get_changetoken( ).
ENDIF.

To update a byte match set¶

The following example deletes a ByteMatchTuple object (filters) in an byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.

DATA(lo_result) = lo_client->updatebytematchset(
  it_updates = VALUE /aws1/cl_wafbytematchsetupdate=>tt_bytematchsetupdates(
    (
      new /aws1/cl_wafbytematchsetupdate(
        io_bytematchtuple = new /aws1/cl_wafbytematchtuple(
          io_fieldtomatch = new /aws1/cl_waffieldtomatch(
            iv_data = |referer|
            iv_type = |HEADER|
          )
          iv_positionalconstraint = |CONTAINS|
          iv_targetstring = '626164726566657231'
          iv_texttransformation = |NONE|
        )
        iv_action = |DELETE|
      )
    )
  )
  iv_bytematchsetid = |exampleIDs3t-46da-4fdb-b8d5-abc321j569j5|
  iv_changetoken = |abcd12f2-46da-4fdb-b8d5-fbd4c466928f|
).

/AWS1/IF_WAF=>UPDATEBYTEMATCHSET()¶