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

Class: Aws::WAFV2::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_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
}

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_metric_name ⇒ String

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

Returns:

  • (String) —

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

#scope ⇒ String

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an 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.

    Possible values:

    • CLOUDFRONT
    • REGIONAL

Returns:

  • (String) —

    Specifies whether this is for an AWS 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. 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_arn ⇒ String

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

Returns:

  • (String) —

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