| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::WAFV2::SampledHTTPRequest; | ||
| 3 | use Moose; | ||
| 4 | has Action => (is => 'ro', isa => 'Str'); | ||
| 5 | has Labels => (is => 'ro', isa => 'ArrayRef[Paws::WAFV2::Label]'); | ||
| 6 | has Request => (is => 'ro', isa => 'Paws::WAFV2::HTTPRequest', required => 1); | ||
| 7 | has RequestHeadersInserted => (is => 'ro', isa => 'ArrayRef[Paws::WAFV2::HTTPHeader]'); | ||
| 8 | has ResponseCodeSent => (is => 'ro', isa => 'Int'); | ||
| 9 | has RuleNameWithinRuleGroup => (is => 'ro', isa => 'Str'); | ||
| 10 | has Timestamp => (is => 'ro', isa => 'Str'); | ||
| 11 | has Weight => (is => 'ro', isa => 'Int', required => 1); | ||
| 12 | |||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::WAFV2::SampledHTTPRequest | ||
| 20 | |||
| 21 | =head1 USAGE | ||
| 22 | |||
| 23 | This class represents one of two things: | ||
| 24 | |||
| 25 | =head3 Arguments in a call to a service | ||
| 26 | |||
| 27 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 28 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 29 | |||
| 30 | As an example, if Att1 is expected to be a Paws::WAFV2::SampledHTTPRequest object: | ||
| 31 | |||
| 32 | $service_obj->Method(Att1 => { Action => $value, ..., Weight => $value }); | ||
| 33 | |||
| 34 | =head3 Results returned from an API call | ||
| 35 | |||
| 36 | Use accessors for each attribute. If Att1 is expected to be an Paws::WAFV2::SampledHTTPRequest object: | ||
| 37 | |||
| 38 | $result = $service_obj->Method(...); | ||
| 39 | $result->Att1->Action | ||
| 40 | |||
| 41 | =head1 DESCRIPTION | ||
| 42 | |||
| 43 | Represents a single sampled web request. The response from | ||
| 44 | GetSampledRequests includes a C<SampledHTTPRequests> complex type that | ||
| 45 | appears as C<SampledRequests> in the response syntax. | ||
| 46 | C<SampledHTTPRequests> contains an array of C<SampledHTTPRequest> | ||
| 47 | objects. | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 Action => Str | ||
| 53 | |||
| 54 | The action for the C<Rule> that the request matched: C<ALLOW>, | ||
| 55 | C<BLOCK>, or C<COUNT>. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 Labels => ArrayRef[L<Paws::WAFV2::Label>] | ||
| 59 | |||
| 60 | Labels applied to the web request by matching rules. WAF applies fully | ||
| 61 | qualified labels to matching web requests. A fully qualified label is | ||
| 62 | the concatenation of a label namespace and a rule label. The rule's | ||
| 63 | rule group or web ACL defines the label namespace. | ||
| 64 | |||
| 65 | For example, | ||
| 66 | C<awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA> | ||
| 67 | or C<awswaf:managed:aws:managed-rule-set:header:encoding:utf8>. | ||
| 68 | |||
| 69 | |||
| 70 | =head2 B<REQUIRED> Request => L<Paws::WAFV2::HTTPRequest> | ||
| 71 | |||
| 72 | A complex type that contains detailed information about the request. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 RequestHeadersInserted => ArrayRef[L<Paws::WAFV2::HTTPHeader>] | ||
| 76 | |||
| 77 | Custom request headers inserted by WAF into the request, according to | ||
| 78 | the custom request configuration for the matching rule action. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 ResponseCodeSent => Int | ||
| 82 | |||
| 83 | The response code that was sent for the request. | ||
| 84 | |||
| 85 | |||
| 86 | =head2 RuleNameWithinRuleGroup => Str | ||
| 87 | |||
| 88 | The name of the C<Rule> that the request matched. For managed rule | ||
| 89 | groups, the format for this name is C<E<lt>vendor | ||
| 90 | nameE<gt>#E<lt>managed rule group nameE<gt>#E<lt>rule nameE<gt>>. For | ||
| 91 | your own rule groups, the format for this name is C<E<lt>rule group | ||
| 92 | nameE<gt>#E<lt>rule nameE<gt>>. If the rule is not in a rule group, | ||
| 93 | this field is absent. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 Timestamp => Str | ||
| 97 | |||
| 98 | The time at which WAF received the request from your Amazon Web | ||
| 99 | Services resource, in Unix time format (in seconds). | ||
| 100 | |||
| 101 | |||
| 102 | =head2 B<REQUIRED> Weight => Int | ||
| 103 | |||
| 104 | A value that indicates how one result in the response relates | ||
| 105 | proportionally to other results in the response. For example, a result | ||
| 106 | that has a weight of C<2> represents roughly twice as many web requests | ||
| 107 | as a result that has a weight of C<1>. | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head1 SEE ALSO | ||
| 112 | |||
| 113 | This class forms part of L<Paws>, describing an object used in L<Paws::WAFV2> | ||
| 114 | |||
| 115 | =head1 BUGS and CONTRIBUTIONS | ||
| 116 | |||
| 117 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 118 | |||
| 119 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 120 | |||
| 121 | =cut | ||
| 122 |