blib/lib/Paws/CloudWatch/GetInsightRuleReport.pm untested

filter: Statementstmt 0.0% 0 / 16 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 18 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::CloudWatch::GetInsightRuleReport;
3 use Moose;
4 has EndTime => (is => 'ro', isa => 'Str', required => 1);
5 has MaxContributorCount => (is => 'ro', isa => 'Int');
6 has Metrics => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
7 has OrderBy => (is => 'ro', isa => 'Str');
8 has Period => (is => 'ro', isa => 'Int', required => 1);
9 has RuleName => (is => 'ro', isa => 'Str', required => 1);
10 has StartTime => (is => 'ro', isa => 'Str', required => 1);
11  
12 use MooseX::ClassAttribute;
13  
14 class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetInsightRuleReport');
15 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudWatch::GetInsightRuleReportOutput');
16 class_has _result_key => (isa => 'Str', is => 'ro', default => 'GetInsightRuleReportResult');
17 1;
18  
19 ### main pod documentation begin ###
20  
21 =head1 NAME
22  
23 Paws::CloudWatch::GetInsightRuleReport - Arguments for method GetInsightRuleReport on L<Paws::CloudWatch>
24  
25 =head1 DESCRIPTION
26  
27 This class represents the parameters used for calling the method GetInsightRuleReport on the
28 L<Amazon CloudWatch|Paws::CloudWatch> service. Use the attributes of this class
29 as arguments to method GetInsightRuleReport.
30  
31 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetInsightRuleReport.
32  
33 =head1 SYNOPSIS
34  
35 my $monitoring = Paws->service('CloudWatch');
36 my $GetInsightRuleReportOutput = $monitoring->GetInsightRuleReport(
37 EndTime => '1970-01-01T01:00:00',
38 Period => 1,
39 RuleName => 'MyInsightRuleName',
40 StartTime => '1970-01-01T01:00:00',
41 MaxContributorCount => 1, # OPTIONAL
42 Metrics => [
43 'MyInsightRuleMetricName', ... # min: 1, max: 32
44 ], # OPTIONAL
45 OrderBy => 'MyInsightRuleOrderBy', # OPTIONAL
46 );
47  
48 # Results:
49 my $AggregateValue = $GetInsightRuleReportOutput->AggregateValue;
50 my $AggregationStatistic =
51 $GetInsightRuleReportOutput->AggregationStatistic;
52 my $ApproximateUniqueCount =
53 $GetInsightRuleReportOutput->ApproximateUniqueCount;
54 my $Contributors = $GetInsightRuleReportOutput->Contributors;
55 my $KeyLabels = $GetInsightRuleReportOutput->KeyLabels;
56 my $MetricDatapoints = $GetInsightRuleReportOutput->MetricDatapoints;
57  
58 # Returns a L<Paws::CloudWatch::GetInsightRuleReportOutput> object.
59  
60 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.
61 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/monitoring/GetInsightRuleReport>
62  
63 =head1 ATTRIBUTES
64  
65  
66 =head2 B<REQUIRED> EndTime => Str
67  
68 The end time of the data to use in the report. When used in a raw HTTP
69 Query API, it is formatted as C<yyyy-MM-dd'T'HH:mm:ss>. For example,
70 C<2019-07-01T23:59:59>.
71  
72  
73  
74 =head2 MaxContributorCount => Int
75  
76 The maximum number of contributors to include in the report. The range
77 is 1 to 100. If you omit this, the default of 10 is used.
78  
79  
80  
81 =head2 Metrics => ArrayRef[Str|Undef]
82  
83 Specifies which metrics to use for aggregation of contributor values
84 for the report. You can specify one or more of the following metrics:
85  
86 =over
87  
88 =item *
89  
90 C<UniqueContributors> -- the number of unique contributors for each
91 data point.
92  
93 =item *
94  
95 C<MaxContributorValue> -- the value of the top contributor for each
96 data point. The identity of the contributor might change for each data
97 point in the graph.
98  
99 If this rule aggregates by COUNT, the top contributor for each data
100 point is the contributor with the most occurrences in that period. If
101 the rule aggregates by SUM, the top contributor is the contributor with
102 the highest sum in the log field specified by the rule's C<Value>,
103 during that period.
104  
105 =item *
106  
107 C<SampleCount> -- the number of data points matched by the rule.
108  
109 =item *
110  
111 C<Sum> -- the sum of the values from all contributors during the time
112 period represented by that data point.
113  
114 =item *
115  
116 C<Minimum> -- the minimum value from a single observation during the
117 time period represented by that data point.
118  
119 =item *
120  
121 C<Maximum> -- the maximum value from a single observation during the
122 time period represented by that data point.
123  
124 =item *
125  
126 C<Average> -- the average value from all contributors during the time
127 period represented by that data point.
128  
129 =back
130  
131  
132  
133  
134 =head2 OrderBy => Str
135  
136 Determines what statistic to use to rank the contributors. Valid values
137 are SUM and MAXIMUM.
138  
139  
140  
141 =head2 B<REQUIRED> Period => Int
142  
143 The period, in seconds, to use for the statistics in the
144 C<InsightRuleMetricDatapoint> results.
145  
146  
147  
148 =head2 B<REQUIRED> RuleName => Str
149  
150 The name of the rule that you want to see data from.
151  
152  
153  
154 =head2 B<REQUIRED> StartTime => Str
155  
156 The start time of the data to use in the report. When used in a raw
157 HTTP Query API, it is formatted as C<yyyy-MM-dd'T'HH:mm:ss>. For
158 example, C<2019-07-01T23:59:59>.
159  
160  
161  
162  
163 =head1 SEE ALSO
164  
165 This class forms part of L<Paws>, documenting arguments for method GetInsightRuleReport in L<Paws::CloudWatch>
166  
167 =head1 BUGS and CONTRIBUTIONS
168  
169 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
170  
171 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
172  
173 =cut
174