Class: Aws::WAF::Types::TimeWindow

Inherits:

Struct

Object
Struct
Aws::WAF::Types::TimeWindow

show all

Includes:: Structure

Defined in:: lib/aws-sdk-waf/types.rb

Overview

<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see

AWS WAF Classic][1: 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.

</note>

In a GetSampledRequests request, the ‘StartTime` and `EndTime` objects specify the time range for which you want AWS WAF to return a sample of web requests.

You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, ‘Z`. For example, `“2016-09-27T14:50Z”`.

In a GetSampledRequests response, the ‘StartTime` and `EndTime` objects specify the time range for which AWS WAF actually returned a sample of web requests. AWS WAF gets the specified number of requests from among the first 5,000 requests that your AWS resource receives during the specified time period. If your resource receives more than 5,000 requests during that period, AWS WAF stops sampling after the 5,000th request. In that case, `EndTime` is the time that AWS WAF received the 5,000th request.

[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#end_time ⇒ Time

The end of the time range from which you want ‘GetSampledRequests` to return a sample of the requests that your AWS resource received.
#start_time ⇒ Time

The beginning of the time range from which you want ‘GetSampledRequests` to return a sample of the requests that your AWS resource received.

Instance Attribute Details

#end_time ⇒ `Time`

The end of the time range from which you want ‘GetSampledRequests` to return a sample of the requests that your AWS resource received. You must specify the date and time in Coordinated Universal Time (UTC) format. UTC format includes the special designator, `Z`. For example, `“2016-09-27T14:50Z”`. You can specify any time range in the previous three hours.

Returns:

(Time)

# File 'lib/aws-sdk-waf/types.rb', line 5210

class TimeWindow < Struct.new(
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ `Time`

The beginning of the time range from which you want ‘GetSampledRequests` to return a sample of the requests that your AWS resource received. You must specify the date and time in Coordinated Universal Time (UTC) format. UTC format includes the special designator, `Z`. For example, `“2016-09-27T14:50Z”`. You can specify any time range in the previous three hours.