blib/lib/Paws/WAF/GetSampledRequests.pm untested

filter: Statementstmt 0.0% 0 / 13 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 15 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::WAF::GetSampledRequests;
3 use Moose;
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::WAF::TimeWindow', required => 1);
7 has WebAclId => (is => 'ro', isa => 'Str', required => 1);
8  
9 use MooseX::ClassAttribute;
10  
11 class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetSampledRequests');
12 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WAF::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::WAF::GetSampledRequests - Arguments for method GetSampledRequests on L<Paws::WAF>
21  
22 =head1 DESCRIPTION
23  
24 This class represents the parameters used for calling the method GetSampledRequests on the
25 L<AWS WAF|Paws::WAF> 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 =head1 SYNOPSIS
31  
32 my $waf = Paws->service('WAF');
33 # To get a sampled requests
34 # The following example returns detailed information about 100 requests --a
35 # sample-- that AWS WAF randomly selects from among the first 5,000 requests
36 # that your AWS resource received between the time period 2016-09-27T15:50Z to
37 # 2016-09-27T15:50Z.
38 my $GetSampledRequestsResponse = $waf->GetSampledRequests(
39 'MaxItems' => 100,
40 'RuleId' => 'WAFRule-1-Example',
41 'TimeWindow' => {
42 'EndTime' => '2016-09-27T15:50Z',
43 'StartTime' => '2016-09-27T15:50Z'
44 },
45 'WebAclId' => 'createwebacl-1472061481310'
46 );
47  
48 # Results:
49 my $PopulationSize = $GetSampledRequestsResponse->PopulationSize;
50 my $SampledRequests = $GetSampledRequestsResponse->SampledRequests;
51 my $TimeWindow = $GetSampledRequestsResponse->TimeWindow;
52  
53 # Returns a L<Paws::WAF::GetSampledRequestsResponse> object.
54  
55 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.
56 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/waf/GetSampledRequests>
57  
58 =head1 ATTRIBUTES
59  
60  
61 =head2 B<REQUIRED> MaxItems => Int
62  
63 The number of requests that you want AWS WAF to return from among the
64 first 5,000 requests that your AWS resource received during the time
65 range. If your resource received fewer requests than the value of
66 C<MaxItems>, C<GetSampledRequests> returns information about all of
67 them.
68  
69  
70  
71 =head2 B<REQUIRED> RuleId => Str
72  
73 C<RuleId> is one of three values:
74  
75 =over
76  
77 =item *
78  
79 The C<RuleId> of the C<Rule> or the C<RuleGroupId> of the C<RuleGroup>
80 for which you want C<GetSampledRequests> to return a sample of
81 requests.
82  
83 =item *
84  
85 C<Default_Action>, which causes C<GetSampledRequests> to return a
86 sample of the requests that didn't match any of the rules in the
87 specified C<WebACL>.
88  
89 =back
90  
91  
92  
93  
94 =head2 B<REQUIRED> TimeWindow => L<Paws::WAF::TimeWindow>
95  
96 The start date and time and the end date and time of the range for
97 which you want C<GetSampledRequests> to return a sample of requests.
98 You must specify the times in Coordinated Universal Time (UTC) format.
99 UTC format includes the special designator, C<Z>. For example,
100 C<"2016-09-27T14:50Z">. You can specify any time range in the previous
101 three hours.
102  
103  
104  
105 =head2 B<REQUIRED> WebAclId => Str
106  
107 The C<WebACLId> of the C<WebACL> for which you want
108 C<GetSampledRequests> to return a sample of requests.
109  
110  
111  
112  
113 =head1 SEE ALSO
114  
115 This class forms part of L<Paws>, documenting arguments for method GetSampledRequests in L<Paws::WAF>
116  
117 =head1 BUGS and CONTRIBUTIONS
118  
119 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
120  
121 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
122  
123 =cut
124