GetSampledRequestsRequest Class | AWS SDK for .NET V3

Container for the parameters to the GetSampledRequests operation.

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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.WAFRegional.AmazonWAFRegionalRequest
      Amazon.WAFRegional.Model.GetSampledRequestsRequest

Namespace: Amazon.WAFRegional.Model
Assembly: AWSSDK.WAFRegional.dll
Version: 3.x.y.z

Syntax

public class GetSampledRequestsRequest : AmazonWAFRegionalRequest
         IAmazonWebServiceRequest

The GetSampledRequestsRequest type exposes the following members

Constructors

	Name	Description
	GetSampledRequestsRequest()

Properties

Name	Type	Description
MaxItems	System.Int64	Gets and sets the property MaxItems. 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.
RuleId	System.String	Gets and sets the property RuleId. `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`.
TimeWindow	Amazon.WAFRegional.Model.TimeWindow	Gets and sets the property TimeWindow. 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.
WebAclId	System.String	Gets and sets the property WebAclId. The `WebACLId` of the `WebACL` for which you want `GetSampledRequests` to return a sample of requests.

Examples

The following example returns detailed information about 100 requests --a sample-- that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received between the time period 2016-09-27T15:50Z to 2016-09-27T15:50Z.

To get a sampled requests


var client = new AmazonWAFRegionalClient();
var response = client.GetSampledRequests(new GetSampledRequestsRequest 
{
    MaxItems = 100,
    RuleId = "WAFRule-1-Example",
    TimeWindow = new TimeWindow {
        EndTime = new DateTime(2016, 9, 27, 3, 50, 0, DateTimeKind.Utc),
        StartTime = new DateTime(2016, 9, 27, 3, 50, 0, DateTimeKind.Utc)
    },
    WebAclId = "createwebacl-1472061481310"
});

long populationSize = response.PopulationSize;
List<SampledHTTPRequest> sampledRequests = response.SampledRequests;
TimeWindow timeWindow = response.TimeWindow;

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5