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.

This is the response object from the GetSampledRequests operation.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.WAF.Model.GetSampledRequestsResponse

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

Syntax

C# 
public class GetSampledRequestsResponse : AmazonWebServiceResponse

The GetSampledRequestsResponse type exposes the following members

Constructors

NameDescription
Public Method GetSampledRequestsResponse()

Properties

NameTypeDescription
Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property PopulationSize System.Int64

Gets and sets the property PopulationSize.

The total number of requests from which GetSampledRequests got a sample of MaxItems requests. If PopulationSize is less than MaxItems, the sample includes every request that your AWS resource received during the specified time range.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property SampledRequests System.Collections.Generic.List<Amazon.WAF.Model.SampledHTTPRequest>

Gets and sets the property SampledRequests.

A complex type that contains detailed information about each of the requests in the sample.

Public Property TimeWindow Amazon.WAF.Model.TimeWindow

Gets and sets the property TimeWindow.

Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. However, if your AWS resource received more than 5,000 requests during the time range that you specified in the request, GetSampledRequests returns the time range for the first 5,000 requests. Times are in Coordinated Universal Time (UTC) format.

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 AmazonWAFClient();
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