DELETERATEBASEDRULE()`¶

About DeleteRateBasedRule¶

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.

Permanently deletes a RateBasedRule. You can't delete a rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects.

If you just want to remove a rule from a WebACL, use UpdateWebACL.

To permanently delete a RateBasedRule from AWS WAF, perform the following steps:

Update the RateBasedRule to remove predicates, if any. For more information, see UpdateRateBasedRule.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRateBasedRule request.
Submit a DeleteRateBasedRule request.

Method Signature¶

METHODS /AWS1/IF_WAF~DELETERATEBASEDRULE
  IMPORTING
    !IV_RULEID TYPE /AWS1/WAFRESOURCEID OPTIONAL
    !IV_CHANGETOKEN TYPE /AWS1/WAFCHANGETOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wafdelratebasedrlrsp
  RAISING
    /AWS1/CX_WAFWAFINTERNALERROREX
    /AWS1/CX_WAFWAFINVACCOUNTEX
    /AWS1/CX_WAFWAFNONEMPTYENTEX
    /AWS1/CX_WAFWAFNONEXENTITEMEX
    /AWS1/CX_WAFWAFREFERENCEDITE00
    /AWS1/CX_WAFWAFSTALEDATAEX
    /AWS1/CX_WAFWAFTAGOPERATIONEX
    /AWS1/CX_WAFWAFTAGOPINTERNAL00
    /AWS1/CX_WAFCLIENTEXC
    /AWS1/CX_WAFSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_ruleid` `TYPE /AWS1/WAFRESOURCEID` `/AWS1/WAFRESOURCEID`¶

The RuleId of the RateBasedRule that you want to delete. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.

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

The value returned by the most recent call to GetChangeToken.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_wafdelratebasedrlrsp` `/AWS1/CL_WAFDELRATEBASEDRLRSP`¶

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->deleteratebasedrule(
  iv_changetoken = |string|
  iv_ruleid = |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.

/AWS1/IF_WAF=>DELETERATEBASEDRULE()¶