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.

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.

Note:

For PCL this operation is only available in asynchronous form. Please refer to GetSampledRequestsAsync.

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

Syntax

C#
public virtual GetSampledRequestsResponse GetSampledRequests(
         GetSampledRequestsRequest request
)
Parameters
request
Type: Amazon.WAF.Model.GetSampledRequestsRequest

Container for the necessary parameters to execute the GetSampledRequests service method.

Return Value
The response from the GetSampledRequests service method, as returned by WAF.

Exceptions

ExceptionCondition
WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
WAFNonexistentItemException The operation failed because the referenced object doesn't exist.

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 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

See Also