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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-wafregional/lib/aws-sdk-wafregional/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
}

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)


1532
1533
1534
1535
1536
1537
1538
# File 'gems/aws-sdk-wafregional/lib/aws-sdk-wafregional/types.rb', line 1532

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

#rule_idString

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.

Returns:

  • (String)


1532
1533
1534
1535
1536
1537
1538
# File 'gems/aws-sdk-wafregional/lib/aws-sdk-wafregional/types.rb', line 1532

class GetSampledRequestsRequest < Struct.new(
  :web_acl_id,
  :rule_id,
  :time_window,
  :max_items)
  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. Specify the date and time in the following format: "2016-09-27T14:50Z". You can specify any time range in the previous three hours.

Returns:



1532
1533
1534
1535
1536
1537
1538
# File 'gems/aws-sdk-wafregional/lib/aws-sdk-wafregional/types.rb', line 1532

class GetSampledRequestsRequest < Struct.new(
  :web_acl_id,
  :rule_id,
  :time_window,
  :max_items)
  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)


1532
1533
1534
1535
1536
1537
1538
# File 'gems/aws-sdk-wafregional/lib/aws-sdk-wafregional/types.rb', line 1532

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