blib/lib/Paws/PerformanceInsights/GetResourceMetrics.pm untested

filter: Statementstmt 0.0% 0 / 17 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 19 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::PerformanceInsights::GetResourceMetrics;
3 use Moose;
4 has EndTime => (is => 'ro', isa => 'Str', required => 1);
5 has Identifier => (is => 'ro', isa => 'Str', required => 1);
6 has MaxResults => (is => 'ro', isa => 'Int');
7 has MetricQueries => (is => 'ro', isa => 'ArrayRef[Paws::PerformanceInsights::MetricQuery]', required => 1);
8 has NextToken => (is => 'ro', isa => 'Str');
9 has PeriodInSeconds => (is => 'ro', isa => 'Int');
10 has ServiceType => (is => 'ro', isa => 'Str', required => 1);
11 has StartTime => (is => 'ro', isa => 'Str', required => 1);
12  
13 use MooseX::ClassAttribute;
14  
15 class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetResourceMetrics');
16 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::PerformanceInsights::GetResourceMetricsResponse');
17 class_has _result_key => (isa => 'Str', is => 'ro');
18 1;
19  
20 ### main pod documentation begin ###
21  
22 =head1 NAME
23  
24 Paws::PerformanceInsights::GetResourceMetrics - Arguments for method GetResourceMetrics on L<Paws::PerformanceInsights>
25  
26 =head1 DESCRIPTION
27  
28 This class represents the parameters used for calling the method GetResourceMetrics on the
29 L<AWS Performance Insights|Paws::PerformanceInsights> service. Use the attributes of this class
30 as arguments to method GetResourceMetrics.
31  
32 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetResourceMetrics.
33  
34 =head1 SYNOPSIS
35  
36 my $pi = Paws->service('PerformanceInsights');
37 my $GetResourceMetricsResponse = $pi->GetResourceMetrics(
38 EndTime => '1970-01-01T01:00:00',
39 Identifier => 'MyRequestString',
40 MetricQueries => [
41 {
42 Metric => 'MyRequestString', # max: 256
43 Filter => {
44 'MyRequestString' =>
45 'MyRequestString', # key: max: 256, value: max: 256
46 }, # OPTIONAL
47 GroupBy => {
48 Group => 'MyRequestString', # max: 256
49 Dimensions => [
50 'MyRequestString', ... # max: 256
51 ], # min: 1, max: 10; OPTIONAL
52 Limit => 1, # min: 1, max: 10; OPTIONAL
53 }, # OPTIONAL
54 },
55 ...
56 ],
57 ServiceType => 'RDS',
58 StartTime => '1970-01-01T01:00:00',
59 MaxResults => 1, # OPTIONAL
60 NextToken => 'MyNextToken', # OPTIONAL
61 PeriodInSeconds => 1, # OPTIONAL
62 );
63  
64 # Results:
65 my $AlignedEndTime = $GetResourceMetricsResponse->AlignedEndTime;
66 my $AlignedStartTime = $GetResourceMetricsResponse->AlignedStartTime;
67 my $Identifier = $GetResourceMetricsResponse->Identifier;
68 my $MetricList = $GetResourceMetricsResponse->MetricList;
69 my $NextToken = $GetResourceMetricsResponse->NextToken;
70  
71 # Returns a L<Paws::PerformanceInsights::GetResourceMetricsResponse> object.
72  
73 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.
74 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/pi/GetResourceMetrics>
75  
76 =head1 ATTRIBUTES
77  
78  
79 =head2 B<REQUIRED> EndTime => Str
80  
81 The date and time specifying the end of the requested time series data.
82 The value specified is I<exclusive> - data points less than (but not
83 equal to) C<EndTime> will be returned.
84  
85 The value for C<EndTime> must be later than the value for C<StartTime>.
86  
87  
88  
89 =head2 B<REQUIRED> Identifier => Str
90  
91 An immutable, AWS Region-unique identifier for a data source.
92 Performance Insights gathers metrics from this data source.
93  
94 To use a DB instance as a data source, specify its C<DbiResourceId>
95 value. For example, specify C<db-FAIHNTYBKTGAUSUZQYPDS2GW4A>.
96  
97  
98  
99 =head2 MaxResults => Int
100  
101 The maximum number of items to return in the response. If more items
102 exist than the specified C<MaxRecords> value, a pagination token is
103 included in the response so that the remaining results can be
104 retrieved.
105  
106  
107  
108 =head2 B<REQUIRED> MetricQueries => ArrayRef[L<Paws::PerformanceInsights::MetricQuery>]
109  
110 An array of one or more queries to perform. Each query must specify a
111 Performance Insights metric, and can optionally specify aggregation and
112 filtering criteria.
113  
114  
115  
116 =head2 NextToken => Str
117  
118 An optional pagination token provided by a previous request. If this
119 parameter is specified, the response includes only records beyond the
120 token, up to the value specified by C<MaxRecords>.
121  
122  
123  
124 =head2 PeriodInSeconds => Int
125  
126 The granularity, in seconds, of the data points returned from
127 Performance Insights. A period can be as short as one second, or as
128 long as one day (86400 seconds). Valid values are:
129  
130 =over
131  
132 =item *
133  
134 C<1> (one second)
135  
136 =item *
137  
138 C<60> (one minute)
139  
140 =item *
141  
142 C<300> (five minutes)
143  
144 =item *
145  
146 C<3600> (one hour)
147  
148 =item *
149  
150 C<86400> (twenty-four hours)
151  
152 =back
153  
154 If you don't specify C<PeriodInSeconds>, then Performance Insights will
155 choose a value for you, with a goal of returning roughly 100-200 data
156 points in the response.
157  
158  
159  
160 =head2 B<REQUIRED> ServiceType => Str
161  
162 The AWS service for which Performance Insights returns metrics. The
163 only valid value for I<ServiceType> is C<RDS>.
164  
165 Valid values are: C<"RDS">
166  
167 =head2 B<REQUIRED> StartTime => Str
168  
169 The date and time specifying the beginning of the requested time series
170 data. You can't specify a C<StartTime> that's earlier than 7 days ago.
171 The value specified is I<inclusive> - data points equal to or greater
172 than C<StartTime> will be returned.
173  
174 The value for C<StartTime> must be earlier than the value for
175 C<EndTime>.
176  
177  
178  
179  
180 =head1 SEE ALSO
181  
182 This class forms part of L<Paws>, documenting arguments for method GetResourceMetrics in L<Paws::PerformanceInsights>
183  
184 =head1 BUGS and CONTRIBUTIONS
185  
186 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
187  
188 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
189  
190 =cut
191