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

Inherits:

Struct

• Object
• Struct
• Aws::WAFV2::Types::GetSampledRequestsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-wafv2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #max_items ⇒ Integer

  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.

• #rule_metric_name ⇒ String

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

• #scope ⇒ String

  Specifies whether this is for an Amazon CloudFront distribution or for a regional application.

• #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.

• #web_acl_arn ⇒ String

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

Instance Attribute Details

#max_items ⇒ Integer

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)

# File 'lib/aws-sdk-wafv2/types.rb', line 3371

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

#rule_metric_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-wafv2/types.rb', line 3371

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

#scope ⇒ String

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, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

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)

# File 'lib/aws-sdk-wafv2/types.rb', line 3371

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

#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. If you specify a start time that’s earlier than three hours ago, WAF sets it to three hours ago.

Returns:

• (Types::TimeWindow)

# File 'lib/aws-sdk-wafv2/types.rb', line 3371

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

#web_acl_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-wafv2/types.rb', line 3371

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