| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::WAFRegional::HTTPRequest; | ||
| 3 | use Moose; | ||
| 4 | has ClientIP => (is => 'ro', isa => 'Str'); | ||
| 5 | has Country => (is => 'ro', isa => 'Str'); | ||
| 6 | has Headers => (is => 'ro', isa => 'ArrayRef[Paws::WAFRegional::HTTPHeader]'); | ||
| 7 | has HTTPVersion => (is => 'ro', isa => 'Str'); | ||
| 8 | has Method => (is => 'ro', isa => 'Str'); | ||
| 9 | has URI => (is => 'ro', isa => 'Str'); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::WAFRegional::HTTPRequest | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::WAFRegional::HTTPRequest object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { ClientIP => $value, ..., URI => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::WAFRegional::HTTPRequest object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->ClientIP | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | This is B<AWS WAF Classic> documentation. For more information, see AWS | ||
| 42 | WAF Classic | ||
| 43 | (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) | ||
| 44 | in the developer guide. | ||
| 45 | |||
| 46 | B<For the latest version of AWS WAF>, use the AWS WAFV2 API and see the | ||
| 47 | AWS WAF Developer Guide | ||
| 48 | (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). | ||
| 49 | With the latest version, AWS WAF has a single set of endpoints for | ||
| 50 | regional and global use. | ||
| 51 | |||
| 52 | The response from a GetSampledRequests request includes an | ||
| 53 | C<HTTPRequest> complex type that appears as C<Request> in the response | ||
| 54 | syntax. C<HTTPRequest> contains information about one of the web | ||
| 55 | requests that were returned by C<GetSampledRequests>. | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 ClientIP => Str | ||
| 61 | |||
| 62 | The IP address that the request originated from. If the C<WebACL> is | ||
| 63 | associated with a CloudFront distribution, this is the value of one of | ||
| 64 | the following fields in CloudFront access logs: | ||
| 65 | |||
| 66 | =over | ||
| 67 | |||
| 68 | =item * | ||
| 69 | |||
| 70 | C<c-ip>, if the viewer did not use an HTTP proxy or a load balancer to | ||
| 71 | send the request | ||
| 72 | |||
| 73 | =item * | ||
| 74 | |||
| 75 | C<x-forwarded-for>, if the viewer did use an HTTP proxy or a load | ||
| 76 | balancer to send the request | ||
| 77 | |||
| 78 | =back | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 Country => Str | ||
| 83 | |||
| 84 | The two-letter country code for the country that the request originated | ||
| 85 | from. For a current list of country codes, see the Wikipedia entry ISO | ||
| 86 | 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). | ||
| 87 | |||
| 88 | |||
| 89 | =head2 Headers => ArrayRef[L<Paws::WAFRegional::HTTPHeader>] | ||
| 90 | |||
| 91 | A complex type that contains two values for each header in the sampled | ||
| 92 | web request: the name of the header and the value of the header. | ||
| 93 | |||
| 94 | |||
| 95 | =head2 HTTPVersion => Str | ||
| 96 | |||
| 97 | The HTTP version specified in the sampled web request, for example, | ||
| 98 | C<HTTP/1.1>. | ||
| 99 | |||
| 100 | |||
| 101 | =head2 Method => Str | ||
| 102 | |||
| 103 | The HTTP method specified in the sampled web request. CloudFront | ||
| 104 | supports the following methods: C<DELETE>, C<GET>, C<HEAD>, C<OPTIONS>, | ||
| 105 | C<PATCH>, C<POST>, and C<PUT>. | ||
| 106 | |||
| 107 | |||
| 108 | =head2 URI => Str | ||
| 109 | |||
| 110 | The part of a web request that identifies the resource, for example, | ||
| 111 | C</images/daily-ad.jpg>. | ||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | =head1 SEE ALSO | ||
| 116 | |||
| 117 | This class forms part of L<Paws>, describing an object used in L<Paws::WAFRegional> | ||
| 118 | |||
| 119 | =head1 BUGS and CONTRIBUTIONS | ||
| 120 | |||
| 121 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 122 | |||
| 123 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 124 | |||
| 125 | =cut | ||
| 126 |