Struct SampledHttpRequest

#[non_exhaustive]
pub struct SampledHttpRequest {
    pub request: Option<HttpRequest>,
    pub weight: i64,
    pub timestamp: Option<DateTime>,
    pub action: Option<String>,
    pub rule_name_within_rule_group: Option<String>,
    pub request_headers_inserted: Option<Vec<HttpHeader>>,
    pub response_code_sent: Option<i32>,
    pub labels: Option<Vec<Label>>,
    pub captcha_response: Option<CaptchaResponse>,
    pub challenge_response: Option<ChallengeResponse>,
    pub overridden_action: Option<String>,
}

Represents a single sampled web request. The response from GetSampledRequests includes a SampledHTTPRequests complex type that appears as SampledRequests in the response syntax. SampledHTTPRequests contains an array of SampledHTTPRequest objects.

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.

request: Option<HttpRequest>

A complex type that contains detailed information about the request.

weight: i64

A value that indicates how one result in the response relates proportionally to other results in the response. For example, a result that has a weight of 2 represents roughly twice as many web requests as a result that has a weight of 1.

timestamp: Option<DateTime>

The time at which WAF received the request from your Amazon Web Services resource, in Unix time format (in seconds).

action: Option<String>

The action that WAF applied to the request.

rule_name_within_rule_group: Option<String>

The name of the Rule that the request matched. For managed rule groups, the format for this name is # # . For your own rule groups, the format for this name is # . If the rule is not in a rule group, this field is absent.

request_headers_inserted: Option<Vec<HttpHeader>>

Custom request headers inserted by WAF into the request, according to the custom request configuration for the matching rule action.

response_code_sent: Option<i32>

The response code that was sent for the request.

labels: Option<Vec<Label>>

Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.

For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or awswaf:managed:aws:managed-rule-set:header:encoding:utf8.

captcha_response: Option<CaptchaResponse>

The CAPTCHA response for the request.

challenge_response: Option<ChallengeResponse>

The Challenge response for the request.

overridden_action: Option<String>

Used only for rule group rules that have a rule action override in place in the web ACL. This is the action that the rule group rule is configured for, and not the action that was applied to the request. The action that WAF applied is the Action value.

Implementations

impl SampledHttpRequest

pub fn request(&self) -> Option<&HttpRequest>

A complex type that contains detailed information about the request.

pub fn weight(&self) -> i64

A value that indicates how one result in the response relates proportionally to other results in the response. For example, a result that has a weight of 2 represents roughly twice as many web requests as a result that has a weight of 1.

pub fn timestamp(&self) -> Option<&DateTime>

The time at which WAF received the request from your Amazon Web Services resource, in Unix time format (in seconds).

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

The action that WAF applied to the request.

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

The name of the Rule that the request matched. For managed rule groups, the format for this name is # # . For your own rule groups, the format for this name is # . If the rule is not in a rule group, this field is absent.

pub fn request_headers_inserted(&self) -> &[HttpHeader]

Custom request headers inserted by WAF into the request, according to the custom request configuration for the matching rule action.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .request_headers_inserted.is_none().

pub fn response_code_sent(&self) -> Option<i32>

The response code that was sent for the request.

pub fn labels(&self) -> &[Label]

Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.

For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or awswaf:managed:aws:managed-rule-set:header:encoding:utf8.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .labels.is_none().

pub fn captcha_response(&self) -> Option<&CaptchaResponse>

The CAPTCHA response for the request.

pub fn challenge_response(&self) -> Option<&ChallengeResponse>

The Challenge response for the request.

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

Used only for rule group rules that have a rule action override in place in the web ACL. This is the action that the rule group rule is configured for, and not the action that was applied to the request. The action that WAF applied is the Action value.

impl SampledHttpRequest

pub fn builder() -> SampledHttpRequestBuilder

Creates a new builder-style object to manufacture SampledHttpRequest.

Trait Implementations

impl Clone for SampledHttpRequest

fn clone(&self) -> SampledHttpRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SampledHttpRequest

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

Formats the value using the given formatter.

impl PartialEq for SampledHttpRequest

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for SampledHttpRequest