You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::WAFRegional::Types::GetSampledRequestsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetSampledRequestsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  web_acl_id: "ResourceId", # required
  rule_id: "ResourceId", # required
  time_window: { # required
    start_time: Time.now, # required
    end_time: Time.now, # required
  },
  max_items: 1, # required
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#max_items ⇒ Integer

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.

Returns:

  • (Integer) —

    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.

#rule_id ⇒ String

RuleId is one of three values:

  • The RuleId of the Rule or the RuleGroupId of the RuleGroup 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.

Returns:

  • (String) —

    RuleId is one of three values:.

#time_window ⇒ Types::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. You must specify the times 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:

  • (Types::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.

#web_acl_id ⇒ String

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

Returns:

  • (String) —

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