| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::WAFV2::TimeWindow; | ||
| 3 | use Moose; | ||
| 4 | has EndTime => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has StartTime => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::WAFV2::TimeWindow | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::WAFV2::TimeWindow object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { EndTime => $value, ..., StartTime => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::WAFV2::TimeWindow object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->EndTime | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | In a GetSampledRequests request, the C<StartTime> and C<EndTime> | ||
| 38 | objects specify the time range for which you want WAF to return a | ||
| 39 | sample of web requests. | ||
| 40 | |||
| 41 | You must specify the times in Coordinated Universal Time (UTC) format. | ||
| 42 | UTC format includes the special designator, C<Z>. For example, | ||
| 43 | C<"2016-09-27T14:50Z">. You can specify any time range in the previous | ||
| 44 | three hours. | ||
| 45 | |||
| 46 | In a GetSampledRequests response, the C<StartTime> and C<EndTime> | ||
| 47 | objects specify the time range for which WAF actually returned a sample | ||
| 48 | of web requests. WAF gets the specified number of requests from among | ||
| 49 | the first 5,000 requests that your Amazon Web Services resource | ||
| 50 | receives during the specified time period. If your resource receives | ||
| 51 | more than 5,000 requests during that period, WAF stops sampling after | ||
| 52 | the 5,000th request. In that case, C<EndTime> is the time that WAF | ||
| 53 | received the 5,000th request. | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 B<REQUIRED> EndTime => Str | ||
| 59 | |||
| 60 | The end of the time range from which you want C<GetSampledRequests> to | ||
| 61 | return a sample of the requests that your Amazon Web Services resource | ||
| 62 | received. You must specify the times in Coordinated Universal Time | ||
| 63 | (UTC) format. UTC format includes the special designator, C<Z>. For | ||
| 64 | example, C<"2016-09-27T14:50Z">. You can specify any time range in the | ||
| 65 | previous three hours. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 B<REQUIRED> StartTime => Str | ||
| 69 | |||
| 70 | The beginning of the time range from which you want | ||
| 71 | C<GetSampledRequests> to return a sample of the requests that your | ||
| 72 | Amazon Web Services resource received. You must specify the times in | ||
| 73 | Coordinated Universal Time (UTC) format. UTC format includes the | ||
| 74 | special designator, C<Z>. For example, C<"2016-09-27T14:50Z">. You can | ||
| 75 | specify any time range in the previous three hours. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head1 SEE ALSO | ||
| 80 | |||
| 81 | This class forms part of L<Paws>, describing an object used in L<Paws::WAFV2> | ||
| 82 | |||
| 83 | =head1 BUGS and CONTRIBUTIONS | ||
| 84 | |||
| 85 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 86 | |||
| 87 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 88 | |||
| 89 | =cut | ||
| 90 |