class Aws::WAFV2::Types::GetSampledRequestsRequest
@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 }
@!attribute [rw] web_acl_arn
The Amazon resource name (ARN) of the `WebACL` for which you want a sample of requests. @return [String]
@!attribute [rw] rule_metric_name
The metric name assigned to the `Rule` or `RuleGroup` for which you want a sample of requests. @return [String]
@!attribute [rw] scope
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. @return [String]
@!attribute [rw] time_window
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. @return [Types::TimeWindow]
@!attribute [rw] max_items
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. @return [Integer]
@see docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/GetSampledRequestsRequest AWS API Documentation
Constants
- SENSITIVE