Class: Aws::WAF::Types::GetSampledRequestsRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-waf/types.rb

Overview

Note:

When making an API call, you may pass GetSampledRequestsRequest data as a 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
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#max_itemsInteger

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)

2656
2657
2658
2659
2660
2661
2662
2663
# File 'lib/aws-sdk-waf/types.rb', line 2656

class GetSampledRequestsRequest < Struct.new(
  :web_acl_id,
  :rule_id,
  :time_window,
  :max_items)
  SENSITIVE = []
  include Aws::Structure
end

#rule_idString

`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)

2656
2657
2658
2659
2660
2661
2662
2663
# File 'lib/aws-sdk-waf/types.rb', line 2656

class GetSampledRequestsRequest < Struct.new(
  :web_acl_id,
  :rule_id,
  :time_window,
  :max_items)
  SENSITIVE = []
  include Aws::Structure
end

#time_windowTypes::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:


2656
2657
2658
2659
2660
2661
2662
2663
# File 'lib/aws-sdk-waf/types.rb', line 2656

class GetSampledRequestsRequest < Struct.new(
  :web_acl_id,
  :rule_id,
  :time_window,
  :max_items)
  SENSITIVE = []
  include Aws::Structure
end

#web_acl_idString

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

Returns:

  • (String)

2656
2657
2658
2659
2660
2661
2662
2663
# File 'lib/aws-sdk-waf/types.rb', line 2656

class GetSampledRequestsRequest < Struct.new(
  :web_acl_id,
  :rule_id,
  :time_window,
  :max_items)
  SENSITIVE = []
  include Aws::Structure
end