blib/lib/Paws/Connect/GetMetricData.pm untested

filter: Statementstmt 0.0% 0 / 19 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 21 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Connect::GetMetricData;
3 use Moose;
4 has EndTime => (is => 'ro', isa => 'Str', required => 1);
5 has Filters => (is => 'ro', isa => 'Paws::Connect::Filters', required => 1);
6 has Groupings => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
7 has HistoricalMetrics => (is => 'ro', isa => 'ArrayRef[Paws::Connect::HistoricalMetric]', required => 1);
8 has InstanceId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'InstanceId', required => 1);
9 has MaxResults => (is => 'ro', isa => 'Int');
10 has NextToken => (is => 'ro', isa => 'Str');
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 => 'GetMetricData');
16 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/metrics/historical/{InstanceId}');
17 class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
18 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Connect::GetMetricDataResponse');
19 1;
20  
21 ### main pod documentation begin ###
22  
23 =head1 NAME
24  
25 Paws::Connect::GetMetricData - Arguments for method GetMetricData on L<Paws::Connect>
26  
27 =head1 DESCRIPTION
28  
29 This class represents the parameters used for calling the method GetMetricData on the
30 L<Amazon Connect Service|Paws::Connect> service. Use the attributes of this class
31 as arguments to method GetMetricData.
32  
33 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetMetricData.
34  
35 =head1 SYNOPSIS
36  
37 my $connect = Paws->service('Connect');
38 my $GetMetricDataResponse = $connect->GetMetricData(
39 EndTime => '1970-01-01T01:00:00',
40 Filters => {
41 Channels => [
42 'VOICE', ... # values: VOICE, CHAT, TASK
43 ], # max: 1; OPTIONAL
44 Queues => [ 'MyQueueId', ... ], # min: 1, max: 100; OPTIONAL
45 },
46 HistoricalMetrics => [
47 {
48 Name => 'CONTACTS_QUEUED'
49 , # values: CONTACTS_QUEUED, CONTACTS_HANDLED, CONTACTS_ABANDONED, CONTACTS_CONSULTED, CONTACTS_AGENT_HUNG_UP_FIRST, CONTACTS_HANDLED_INCOMING, CONTACTS_HANDLED_OUTBOUND, CONTACTS_HOLD_ABANDONS, CONTACTS_TRANSFERRED_IN, CONTACTS_TRANSFERRED_OUT, CONTACTS_TRANSFERRED_IN_FROM_QUEUE, CONTACTS_TRANSFERRED_OUT_FROM_QUEUE, CONTACTS_MISSED, CALLBACK_CONTACTS_HANDLED, API_CONTACTS_HANDLED, OCCUPANCY, HANDLE_TIME, AFTER_CONTACT_WORK_TIME, QUEUED_TIME, ABANDON_TIME, QUEUE_ANSWER_TIME, HOLD_TIME, INTERACTION_TIME, INTERACTION_AND_HOLD_TIME, SERVICE_LEVEL; OPTIONAL
50 Statistic => 'SUM', # values: SUM, MAX, AVG; OPTIONAL
51 Threshold => {
52 Comparison => 'LT', # values: LT; OPTIONAL
53 ThresholdValue => 1, # OPTIONAL
54 }, # OPTIONAL
55 Unit => 'SECONDS', # values: SECONDS, COUNT, PERCENT; OPTIONAL
56 },
57 ...
58 ],
59 InstanceId => 'MyInstanceId',
60 StartTime => '1970-01-01T01:00:00',
61 Groupings => [
62 'QUEUE',
63 ... # values: QUEUE, CHANNEL
64 ], # OPTIONAL
65 MaxResults => 1, # OPTIONAL
66 NextToken => 'MyNextToken', # OPTIONAL
67 );
68  
69 # Results:
70 my $MetricResults = $GetMetricDataResponse->MetricResults;
71 my $NextToken = $GetMetricDataResponse->NextToken;
72  
73 # Returns a L<Paws::Connect::GetMetricDataResponse> object.
74  
75 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.
76 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/connect/GetMetricData>
77  
78 =head1 ATTRIBUTES
79  
80  
81 =head2 B<REQUIRED> EndTime => Str
82  
83 The timestamp, in UNIX Epoch time format, at which to end the reporting
84 interval for the retrieval of historical metrics data. The time must be
85 specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10,
86 and must be later than the start time timestamp.
87  
88 The time range between the start and end time must be less than 24
89 hours.
90  
91  
92  
93 =head2 B<REQUIRED> Filters => L<Paws::Connect::Filters>
94  
95 The queues, up to 100, or channels, to use to filter the metrics
96 returned. Metric data is retrieved only for the resources associated
97 with the queues or channels included in the filter. You can include
98 both queue IDs and queue ARNs in the same request. VOICE, CHAT, and
99 TASK channels are supported.
100  
101 To filter by C<Queues>, enter the queue ID/ARN, not the name of the
102 queue.
103  
104  
105  
106 =head2 Groupings => ArrayRef[Str|Undef]
107  
108 The grouping applied to the metrics returned. For example, when results
109 are grouped by queue, the metrics returned are grouped by queue. The
110 values returned apply to the metrics for each queue rather than
111 aggregated for all queues.
112  
113 If no grouping is specified, a summary of metrics for all queues is
114 returned.
115  
116  
117  
118 =head2 B<REQUIRED> HistoricalMetrics => ArrayRef[L<Paws::Connect::HistoricalMetric>]
119  
120 The metrics to retrieve. Specify the name, unit, and statistic for each
121 metric. The following historical metrics are available. For a
122 description of each metric, see Historical Metrics Definitions
123 (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html)
124 in the I<Amazon Connect Administrator Guide>.
125  
126 This API does not support a contacts incoming metric (there's no
127 CONTACTS_INCOMING metric missing from the documented list).
128  
129 =over
130  
131 =item ABANDON_TIME
132  
133 Unit: SECONDS
134  
135 Statistic: AVG
136  
137 =item AFTER_CONTACT_WORK_TIME
138  
139 Unit: SECONDS
140  
141 Statistic: AVG
142  
143 =item API_CONTACTS_HANDLED
144  
145 Unit: COUNT
146  
147 Statistic: SUM
148  
149 =item CALLBACK_CONTACTS_HANDLED
150  
151 Unit: COUNT
152  
153 Statistic: SUM
154  
155 =item CONTACTS_ABANDONED
156  
157 Unit: COUNT
158  
159 Statistic: SUM
160  
161 =item CONTACTS_AGENT_HUNG_UP_FIRST
162  
163 Unit: COUNT
164  
165 Statistic: SUM
166  
167 =item CONTACTS_CONSULTED
168  
169 Unit: COUNT
170  
171 Statistic: SUM
172  
173 =item CONTACTS_HANDLED
174  
175 Unit: COUNT
176  
177 Statistic: SUM
178  
179 =item CONTACTS_HANDLED_INCOMING
180  
181 Unit: COUNT
182  
183 Statistic: SUM
184  
185 =item CONTACTS_HANDLED_OUTBOUND
186  
187 Unit: COUNT
188  
189 Statistic: SUM
190  
191 =item CONTACTS_HOLD_ABANDONS
192  
193 Unit: COUNT
194  
195 Statistic: SUM
196  
197 =item CONTACTS_MISSED
198  
199 Unit: COUNT
200  
201 Statistic: SUM
202  
203 =item CONTACTS_QUEUED
204  
205 Unit: COUNT
206  
207 Statistic: SUM
208  
209 =item CONTACTS_TRANSFERRED_IN
210  
211 Unit: COUNT
212  
213 Statistic: SUM
214  
215 =item CONTACTS_TRANSFERRED_IN_FROM_QUEUE
216  
217 Unit: COUNT
218  
219 Statistic: SUM
220  
221 =item CONTACTS_TRANSFERRED_OUT
222  
223 Unit: COUNT
224  
225 Statistic: SUM
226  
227 =item CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
228  
229 Unit: COUNT
230  
231 Statistic: SUM
232  
233 =item HANDLE_TIME
234  
235 Unit: SECONDS
236  
237 Statistic: AVG
238  
239 =item HOLD_TIME
240  
241 Unit: SECONDS
242  
243 Statistic: AVG
244  
245 =item INTERACTION_AND_HOLD_TIME
246  
247 Unit: SECONDS
248  
249 Statistic: AVG
250  
251 =item INTERACTION_TIME
252  
253 Unit: SECONDS
254  
255 Statistic: AVG
256  
257 =item OCCUPANCY
258  
259 Unit: PERCENT
260  
261 Statistic: AVG
262  
263 =item QUEUE_ANSWER_TIME
264  
265 Unit: SECONDS
266  
267 Statistic: AVG
268  
269 =item QUEUED_TIME
270  
271 Unit: SECONDS
272  
273 Statistic: MAX
274  
275 =item SERVICE_LEVEL
276  
277 You can include up to 20 SERVICE_LEVEL metrics in a request.
278  
279 Unit: PERCENT
280  
281 Statistic: AVG
282  
283 Threshold: For C<ThresholdValue>, enter any whole number from 1 to
284 604800 (inclusive), in seconds. For C<Comparison>, you must enter C<LT>
285 (for "Less than").
286  
287 =back
288  
289  
290  
291  
292 =head2 B<REQUIRED> InstanceId => Str
293  
294 The identifier of the Amazon Connect instance. You can find the
295 instanceId in the ARN of the instance.
296  
297  
298  
299 =head2 MaxResults => Int
300  
301 The maximum number of results to return per page.
302  
303  
304  
305 =head2 NextToken => Str
306  
307 The token for the next set of results. Use the value returned in the
308 previous response in the next request to retrieve the next set of
309 results.
310  
311  
312  
313 =head2 B<REQUIRED> StartTime => Str
314  
315 The timestamp, in UNIX Epoch time format, at which to start the
316 reporting interval for the retrieval of historical metrics data. The
317 time must be specified using a multiple of 5 minutes, such as 10:05,
318 10:10, 10:15.
319  
320 The start time cannot be earlier than 24 hours before the time of the
321 request. Historical metrics are available only for 24 hours.
322  
323  
324  
325  
326 =head1 SEE ALSO
327  
328 This class forms part of L<Paws>, documenting arguments for method GetMetricData in L<Paws::Connect>
329  
330 =head1 BUGS and CONTRIBUTIONS
331  
332 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
333  
334 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
335  
336 =cut
337