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.
Contents
- Request
-
A complex type that contains detailed information about the request.
Type: HTTPRequest object
Required: Yes
- 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
2represents roughly twice as many web requests as a result that has a weight of1.Type: Long
Valid Range: Minimum value of 0.
Required: Yes
- Action
-
The action that AWS WAF applied to the request.
Type: String
Required: No
- CaptchaResponse
-
The
CAPTCHAresponse for the request.Type: CaptchaResponse object
Required: No
- ChallengeResponse
-
The
Challengeresponse for the request.Type: ChallengeResponse object
Required: No
- Labels
-
Labels applied to the web request by matching rules. AWS 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:labelNameAorawswaf:managed:aws:managed-rule-set:header:encoding:utf8.Type: Array of Label objects
Required: No
- 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 AWS WAF applied is the
Actionvalue.Type: String
Required: No
- RequestHeadersInserted
-
Custom request headers inserted by AWS WAF into the request, according to the custom request configuration for the matching rule action.
Type: Array of HTTPHeader objects
Required: No
- ResponseCodeSent
-
The response code that was sent for the request.
Type: Integer
Valid Range: Minimum value of 200. Maximum value of 599.
Required: No
- RuleNameWithinRuleGroup
-
The name of the
Rulethat 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.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^[\w\-]+$Required: No
- Timestamp
-
The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds).
Type: Timestamp
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
