Class: Aws::WAFV2::Types::GetSampledRequestsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb

Overview

Note:

When making an API call, you may pass GetSampledRequestsRequest data as a hash:

{
  web_acl_arn: "ResourceArn", # required
  rule_metric_name: "MetricName", # required
  scope: "CLOUDFRONT", # required, accepts CLOUDFRONT, REGIONAL
  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 WAF to return from among the first 5,000 requests that your Amazon Web Services 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)


4137
4138
4139
4140
4141
4142
4143
4144
4145
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 4137

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

#rule_metric_nameString

The metric name assigned to the Rule or RuleGroup for which you want a sample of requests.

Returns:

  • (String)


4137
4138
4139
4140
4141
4142
4143
4144
4145
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 4137

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

#scopeString

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

  • API and SDKs - For all calls, use the Region endpoint us-east-1.

Returns:

  • (String)


4137
4138
4139
4140
4141
4142
4143
4144
4145
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 4137

class GetSampledRequestsRequest < Struct.new(
  :web_acl_arn,
  :rule_metric_name,
  :scope,
  :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. If you specify a start time that's earlier than three hours ago, WAF sets it to three hours ago.

Returns:



4137
4138
4139
4140
4141
4142
4143
4144
4145
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 4137

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

#web_acl_arnString

The Amazon resource name (ARN) of the WebACL for which you want a sample of requests.

Returns:

  • (String)


4137
4138
4139
4140
4141
4142
4143
4144
4145
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 4137

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