IAmazonWAFRegional.GetSampledRequests Method (GetSampledRequestsRequest)

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.

Note:

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

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

Syntax

public abstract GetSampledRequestsResponse GetSampledRequests(
         GetSampledRequestsRequest request
)

Parameters

request: Type: Amazon.WAFRegional.Model.GetSampledRequestsRequest

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

Return Value

Type: GetSampledRequestsResponse

The response from the GetSampledRequests service method, as returned by WAFRegional.

Exceptions

Exception	Condition
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 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 Framework:
Supported in: 4.5, 4.0, 3.5

IAmazonWAFRegional.GetSampledRequests (GetSampledRequestsRequest)

Method