File Coverage

blib/lib/Paws/WAF/TimeWindow.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


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