Documentation

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.

See: newSampledHTTPRequest smart constructor.

Create a value of SampledHTTPRequest with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:action:SampledHTTPRequest', sampledHTTPRequest_action - The action that WAF applied to the request.

$sel:captchaResponse:SampledHTTPRequest', sampledHTTPRequest_captchaResponse - The CAPTCHA response for the request.

$sel:challengeResponse:SampledHTTPRequest', sampledHTTPRequest_challengeResponse - The Challenge response for the request.

$sel:labels:SampledHTTPRequest', sampledHTTPRequest_labels - 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.

$sel:overriddenAction:SampledHTTPRequest', sampledHTTPRequest_overriddenAction - 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.

$sel:requestHeadersInserted:SampledHTTPRequest', sampledHTTPRequest_requestHeadersInserted - Custom request headers inserted by WAF into the request, according to the custom request configuration for the matching rule action.

$sel:responseCodeSent:SampledHTTPRequest', sampledHTTPRequest_responseCodeSent - The response code that was sent for the request.

$sel:ruleNameWithinRuleGroup:SampledHTTPRequest', sampledHTTPRequest_ruleNameWithinRuleGroup - The name of the Rule that the request matched. For managed rule groups, the format for this name is <vendor name>#<managed rule group name>#<rule name>. For your own rule groups, the format for this name is <rule group name>#<rule name>. If the rule is not in a rule group, this field is absent.

$sel:timestamp:SampledHTTPRequest', sampledHTTPRequest_timestamp - The time at which WAF received the request from your Amazon Web Services resource, in Unix time format (in seconds).

$sel:request:SampledHTTPRequest', sampledHTTPRequest_request - A complex type that contains detailed information about the request.

$sel:weight:SampledHTTPRequest', sampledHTTPRequest_weight - 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.

The action that WAF applied to the request.

The CAPTCHA response for the request.

The Challenge response for the request.

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.

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.

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

The response code that was sent for the request.

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

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

A complex type that contains detailed information about the request.

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.