Struct aws_sdk_wafv2::client::fluent_builders::GetSampledRequests

pub struct GetSampledRequests { /* private fields */ }

Fluent builder constructing a request to GetSampledRequests.

Gets detailed information about a specified number of requests--a sample--that WAF randomly selects from among the first 5,000 requests that your Amazon Web Services resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.

GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which WAF selected the requests in the sample.

Implementations

impl GetSampledRequests

pub async fn send(
    self
) -> Result<GetSampledRequestsOutput, SdkError<GetSampledRequestsError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn web_acl_arn(self, input: impl Into<String>) -> Self

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

pub fn set_web_acl_arn(self, input: Option<String>) -> Self

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

pub fn rule_metric_name(self, input: impl Into<String>) -> Self

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

pub fn set_rule_metric_name(self, input: Option<String>) -> Self

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

pub fn scope(self, input: Scope) -> Self

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.

pub fn set_scope(self, input: Option<Scope>) -> Self

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.

pub fn time_window(self, input: TimeWindow) -> Self

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.

pub fn set_time_window(self, input: Option<TimeWindow>) -> Self

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.

pub fn max_items(self, input: i64) -> Self

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.

pub fn set_max_items(self, input: Option<i64>) -> Self

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.

Trait Implementations

impl Clone for GetSampledRequests

fn clone(&self) -> GetSampledRequests

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetSampledRequests

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.