AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the GetSampledRequests operation. 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.WAF.AmazonWAFRequest
      Amazon.WAF.Model.GetSampledRequestsRequest

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

Syntax

C#
public class GetSampledRequestsRequest : AmazonWAFRequest
         IAmazonWebServiceRequest

The GetSampledRequestsRequest type exposes the following members

Constructors

NameDescription
Public Method GetSampledRequestsRequest()

Properties

NameTypeDescription
Public Property 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.

Public Property RuleId System.String

Gets and sets the property RuleId.

RuleId is one of two values:

  • The RuleId of the Rule 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.

Public Property TimeWindow Amazon.WAF.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. Specify the date and time in the following format: "2016-09-27T14:50Z". You can specify any time range in the previous three hours.

Public Property 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 response = client.GetSampledRequests(new GetSampledRequestsRequest 
{
    MaxItems = 100,
    RuleId = "WAFRule-1-Example",
    TimeWindow = new TimeWindow {
        EndTime = new DateTime(2016, 9, 27, 8, 50, 0),
        StartTime = new DateTime(2016, 9, 27, 8, 50, 0)
    },
    WebAclId = "createwebacl-1472061481310"
});

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

            

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms