Skip to content

/AWS1/CL_WAR=>GETSAMPLEDREQUESTS()

About GetSampledRequests

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.

Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.

GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample.

Method Signature

IMPORTING

Required arguments:

IV_WEBACLID TYPE /AWS1/WARRESOURCEID /AWS1/WARRESOURCEID

The WebACLId of the WebACL for which you want GetSampledRequests to return a sample of requests.

IV_RULEID TYPE /AWS1/WARRESOURCEID /AWS1/WARRESOURCEID

RuleId is one of three values:

  • The RuleId of the Rule or the RuleGroupId of the RuleGroup for which you want GetSampledRequests to return a sample of requests.

  • Default_Action, which causes GetSampledRequests to return a sample of the requests that didn't match any of the rules in the specified WebACL.

IO_TIMEWINDOW TYPE REF TO /AWS1/CL_WARTIMEWINDOW /AWS1/CL_WARTIMEWINDOW

The start date and time and the end date and time of the range for which you want GetSampledRequests to return a sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special
designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.

IV_MAXITEMS TYPE /AWS1/WARGETSAMPLEDREQSMAXIT00 /AWS1/WARGETSAMPLEDREQSMAXIT00

The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received during the time range. If your resource received fewer requests than the value of MaxItems, GetSampledRequests returns information about all of them.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_WARGETSAMPLEDREQSRSP /AWS1/CL_WARGETSAMPLEDREQSRSP

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC