File Coverage

blib/lib/Paws/WAFRegional/GetSampledRequests.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::WAFRegional::GetSampledRequests;
3 1     1   434 use Moose;
  1         2  
  1         8  
4             has MaxItems => (is => 'ro', isa => 'Int', required => 1);
5             has RuleId => (is => 'ro', isa => 'Str', required => 1);
6             has TimeWindow => (is => 'ro', isa => 'Paws::WAFRegional::TimeWindow', required => 1);
7             has WebAclId => (is => 'ro', isa => 'Str', required => 1);
8              
9 1     1   6118 use MooseX::ClassAttribute;
  1         3  
  1         9  
10              
11             class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetSampledRequests');
12             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WAFRegional::GetSampledRequestsResponse');
13             class_has _result_key => (isa => 'Str', is => 'ro');
14             1;
15              
16             ### main pod documentation begin ###
17              
18             =head1 NAME
19              
20             Paws::WAFRegional::GetSampledRequests - Arguments for method GetSampledRequests on Paws::WAFRegional
21              
22             =head1 DESCRIPTION
23              
24             This class represents the parameters used for calling the method GetSampledRequests on the
25             AWS WAF Regional service. Use the attributes of this class
26             as arguments to method GetSampledRequests.
27              
28             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetSampledRequests.
29              
30             As an example:
31              
32             $service_obj->GetSampledRequests(Att1 => $value1, Att2 => $value2, ...);
33              
34             Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
35              
36             =head1 ATTRIBUTES
37              
38              
39             =head2 B<REQUIRED> MaxItems => Int
40              
41             The number of requests that you want AWS WAF to return from among the
42             first 5,000 requests that your AWS resource received during the time
43             range. If your resource received fewer requests than the value of
44             C<MaxItems>, C<GetSampledRequests> returns information about all of
45             them.
46              
47              
48              
49             =head2 B<REQUIRED> RuleId => Str
50              
51             C<RuleId> is one of two values:
52              
53             =over
54              
55             =item *
56              
57             The C<RuleId> of the C<Rule> for which you want C<GetSampledRequests>
58             to return a sample of requests.
59              
60             =item *
61              
62             C<Default_Action>, which causes C<GetSampledRequests> to return a
63             sample of the requests that didn't match any of the rules in the
64             specified C<WebACL>.
65              
66             =back
67              
68              
69              
70              
71             =head2 B<REQUIRED> TimeWindow => L<Paws::WAFRegional::TimeWindow>
72              
73             The start date and time and the end date and time of the range for
74             which you want C<GetSampledRequests> to return a sample of requests.
75             Specify the date and time in the following format:
76             C<"2016-09-27T14:50Z">. You can specify any time range in the previous
77             three hours.
78              
79              
80              
81             =head2 B<REQUIRED> WebAclId => Str
82              
83             The C<WebACLId> of the C<WebACL> for which you want
84             C<GetSampledRequests> to return a sample of requests.
85              
86              
87              
88              
89             =head1 SEE ALSO
90              
91             This class forms part of L<Paws>, documenting arguments for method GetSampledRequests in L<Paws::WAFRegional>
92              
93             =head1 BUGS and CONTRIBUTIONS
94              
95             The source code is located here: https://github.com/pplu/aws-sdk-perl
96              
97             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
98              
99             =cut
100