Struct aws_sdk_waf::client::fluent_builders::GetSampledRequests

pub struct GetSampledRequests { /* private fields */ }

Fluent builder constructing a request to GetSampledRequests.

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS 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 AWS 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_id(self, input: impl Into<String>) -> Self

The WebACLId of the WebACL for which you want GetSampledRequests to return a sample of requests.

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

The WebACLId of the WebACL for which you want GetSampledRequests to return a sample of requests.

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

RuleId is one of three values:

• The RuleId of the Rule or the RuleGroupId of the RuleGroup for which you want GetSampledRequests to return a sample of requests.

• Default_Action, which causes GetSampledRequests to return a sample of the requests that didn't match any of the rules in the specified WebACL.

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

RuleId is one of three values:

• The RuleId of the Rule or the RuleGroupId of the RuleGroup for which you want GetSampledRequests to return a sample of requests.

• Default_Action, which causes GetSampledRequests to return a sample of the requests that didn't match any of the rules in the specified WebACL.

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.

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.

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

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.

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

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.

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.