Struct aws_sdk_wafv2::operation::get_sampled_requests::GetSampledRequestsInput

#[non_exhaustive]
pub struct GetSampledRequestsInput {
    pub web_acl_arn: Option<String>,
    pub rule_metric_name: Option<String>,
    pub scope: Option<Scope>,
    pub time_window: Option<TimeWindow>,
    pub max_items: Option<i64>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

web_acl_arn: Option<String>

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

rule_metric_name: Option<String>

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

scope: Option<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, 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.

time_window: Option<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.

max_items: Option<i64>

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.

Implementations

impl GetSampledRequestsInput

pub fn web_acl_arn(&self) -> Option<&str>

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

pub fn rule_metric_name(&self) -> Option<&str>

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

pub fn scope(&self) -> Option<&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, 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.

pub fn time_window(&self) -> Option<&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.

pub fn max_items(&self) -> Option<i64>

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.

impl GetSampledRequestsInput

pub fn builder() -> GetSampledRequestsInputBuilder

Creates a new builder-style object to manufacture GetSampledRequestsInput.

Trait Implementations

impl Clone for GetSampledRequestsInput

fn clone(&self) -> GetSampledRequestsInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetSampledRequestsInput

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

Formats the value using the given formatter.

impl PartialEq for GetSampledRequestsInput

fn eq(&self, other: &GetSampledRequestsInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GetSampledRequestsInput