Network.AWS.WAF.GetSampledRequests

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

See: AWS API Reference for GetSampledRequests.

Creating a Request

getSampledRequests

Arguments

:: Text

gsrWebACLId

-> Text

gsrRuleId

-> TimeWindow

gsrTimeWindow

-> Natural

gsrMaxItems

-> GetSampledRequests

Creates a value of GetSampledRequests with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gsrWebACLId
• gsrRuleId
• gsrTimeWindow
• gsrMaxItems

data GetSampledRequests

See: getSampledRequests smart constructor.

Instances

Eq GetSampledRequests

Data GetSampledRequests

Read GetSampledRequests

Show GetSampledRequests

Generic GetSampledRequests

ToJSON GetSampledRequests

AWSRequest GetSampledRequests

ToPath GetSampledRequests

ToHeaders GetSampledRequests

ToQuery GetSampledRequests

type Rep GetSampledRequests

type Rs GetSampledRequests = GetSampledRequestsResponse

Request Lenses

gsrWebACLId :: Lens' GetSampledRequests Text

The WebACLId of the WebACL for which you want GetSampledRequests to return a sample of requests.

gsrRuleId :: Lens' GetSampledRequests Text

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.

gsrTimeWindow :: Lens' GetSampledRequests 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 Unix time format (in seconds). You can specify any time range in the previous three hours.

gsrMaxItems :: Lens' GetSampledRequests Natural

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.

Destructuring the Response

getSampledRequestsResponse

Arguments

:: Int

gsrrsResponseStatus

-> GetSampledRequestsResponse

Creates a value of GetSampledRequestsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gsrrsSampledRequests
• gsrrsPopulationSize
• gsrrsTimeWindow
• gsrrsResponseStatus

data GetSampledRequestsResponse

See: getSampledRequestsResponse smart constructor.

Instances

Eq GetSampledRequestsResponse

Data GetSampledRequestsResponse

Read GetSampledRequestsResponse

Show GetSampledRequestsResponse

Generic GetSampledRequestsResponse

type Rep GetSampledRequestsResponse

Response Lenses

gsrrsSampledRequests :: Lens' GetSampledRequestsResponse [SampledHTTPRequest]

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

gsrrsPopulationSize :: Lens' GetSampledRequestsResponse (Maybe Integer)

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.

gsrrsTimeWindow :: Lens' GetSampledRequestsResponse (Maybe 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.

gsrrsResponseStatus :: Lens' GetSampledRequestsResponse Int

The response status code.