blib/lib/Paws/ComputeOptimizer.pm untested

filter: Statementstmt 0.0% 0 / 54 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 20 Podpod 0.0% 0 / 19 totaltotal 0.0% 0 / 93 CC 1 SCAR 6.9
CC
1
Cov
0%
service
2.0
signing_name
2.0
version
2.0
CRAP 2.0
1 package Paws::ComputeOptimizer;
2 use Moose;
3 sub service { 'compute-optimizer' }
4 sub signing_name { 'compute-optimizer' }
5 sub version { '2019-11-01' }
6 sub target_prefix { 'ComputeOptimizerService' }
7 sub json_version { "1.0" }
8 has max_attempts => (is => 'ro', isa => 'Int', default => 5);
9 has retry => (is => 'ro', isa => 'HashRef', default => sub {
10 { base => 'rand', type => 'exponential', growth_factor => 2 }
11 });
12 has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [
13 ] });
14  
15 with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::JsonCaller';
16  
17
18 sub DescribeRecommendationExportJobs {
19 my $self = shift;
20 my $call_object = $self->new_with_coercions('Paws::ComputeOptimizer::DescribeRecommendationExportJobs', @_);
21 return $self->caller->do_call($self, $call_object);
22 }
23 sub ExportAutoScalingGroupRecommendations {
24 my $self = shift;
25 my $call_object = $self->new_with_coercions('Paws::ComputeOptimizer::ExportAutoScalingGroupRecommendations', @_);
26 return $self->caller->do_call($self, $call_object);
27 }
28 sub ExportEBSVolumeRecommendations {
29 my $self = shift;
30 my $call_object = $self->new_with_coercions('Paws::ComputeOptimizer::ExportEBSVolumeRecommendations', @_);
31 return $self->caller->do_call($self, $call_object);
32 }
33 sub ExportEC2InstanceRecommendations {
34 my $self = shift;
35 my $call_object = $self->new_with_coercions('Paws::ComputeOptimizer::ExportEC2InstanceRecommendations', @_);
36 return $self->caller->do_call($self, $call_object);
37 }
38 sub ExportLambdaFunctionRecommendations {
39 my $self = shift;
40 my $call_object = $self->new_with_coercions('Paws::ComputeOptimizer::ExportLambdaFunctionRecommendations', @_);
41 return $self->caller->do_call($self, $call_object);
42 }
43 sub GetAutoScalingGroupRecommendations {
44 my $self = shift;
45 my $call_object = $self->new_with_coercions('Paws::ComputeOptimizer::GetAutoScalingGroupRecommendations', @_);
46 return $self->caller->do_call($self, $call_object);
47 }
48 sub GetEBSVolumeRecommendations {
49 my $self = shift;
50 my $call_object = $self->new_with_coercions('Paws::ComputeOptimizer::GetEBSVolumeRecommendations', @_);
51 return $self->caller->do_call($self, $call_object);
52 }
53 sub GetEC2InstanceRecommendations {
54 my $self = shift;
55 my $call_object = $self->new_with_coercions('Paws::ComputeOptimizer::GetEC2InstanceRecommendations', @_);
56 return $self->caller->do_call($self, $call_object);
57 }
58 sub GetEC2RecommendationProjectedMetrics {
59 my $self = shift;
60 my $call_object = $self->new_with_coercions('Paws::ComputeOptimizer::GetEC2RecommendationProjectedMetrics', @_);
61 return $self->caller->do_call($self, $call_object);
62 }
63 sub GetEnrollmentStatus {
64 my $self = shift;
65 my $call_object = $self->new_with_coercions('Paws::ComputeOptimizer::GetEnrollmentStatus', @_);
66 return $self->caller->do_call($self, $call_object);
67 }
68 sub GetLambdaFunctionRecommendations {
69 my $self = shift;
70 my $call_object = $self->new_with_coercions('Paws::ComputeOptimizer::GetLambdaFunctionRecommendations', @_);
71 return $self->caller->do_call($self, $call_object);
72 }
73 sub GetRecommendationSummaries {
74 my $self = shift;
75 my $call_object = $self->new_with_coercions('Paws::ComputeOptimizer::GetRecommendationSummaries', @_);
76 return $self->caller->do_call($self, $call_object);
77 }
78 sub UpdateEnrollmentStatus {
79 my $self = shift;
80 my $call_object = $self->new_with_coercions('Paws::ComputeOptimizer::UpdateEnrollmentStatus', @_);
81 return $self->caller->do_call($self, $call_object);
82 }
83
84  
85  
86 sub operations { qw/DescribeRecommendationExportJobs ExportAutoScalingGroupRecommendations ExportEBSVolumeRecommendations ExportEC2InstanceRecommendations ExportLambdaFunctionRecommendations GetAutoScalingGroupRecommendations GetEBSVolumeRecommendations GetEC2InstanceRecommendations GetEC2RecommendationProjectedMetrics GetEnrollmentStatus GetLambdaFunctionRecommendations GetRecommendationSummaries UpdateEnrollmentStatus / }
87  
88 1;
89  
90 ### main pod documentation begin ###
91  
92 =head1 NAME
93  
94 Paws::ComputeOptimizer - Perl Interface to AWS AWS Compute Optimizer
95  
96 =head1 SYNOPSIS
97  
98 use Paws;
99  
100 my $obj = Paws->service('ComputeOptimizer');
101 my $res = $obj->Method(
102 Arg1 => $val1,
103 Arg2 => [ 'V1', 'V2' ],
104 # if Arg3 is an object, the HashRef will be used as arguments to the constructor
105 # of the arguments type
106 Arg3 => { Att1 => 'Val1' },
107 # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
108 # the constructor of the arguments type
109 Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
110 );
111  
112 =head1 DESCRIPTION
113  
114 AWS Compute Optimizer is a service that analyzes the configuration and
115 utilization metrics of your AWS compute resources, such as EC2
116 instances, Auto Scaling groups, AWS Lambda functions, and Amazon EBS
117 volumes. It reports whether your resources are optimal, and generates
118 optimization recommendations to reduce the cost and improve the
119 performance of your workloads. Compute Optimizer also provides recent
120 utilization metric data, as well as projected utilization metric data
121 for the recommendations, which you can use to evaluate which
122 recommendation provides the best price-performance trade-off. The
123 analysis of your usage patterns can help you decide when to move or
124 resize your running resources, and still meet your performance and
125 capacity requirements. For more information about Compute Optimizer,
126 including the required permissions to use the service, see the AWS
127 Compute Optimizer User Guide
128 (https://docs.aws.amazon.com/compute-optimizer/latest/ug/).
129  
130 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01>
131  
132  
133 =head1 METHODS
134  
135 =head2 DescribeRecommendationExportJobs
136  
137 =over
138  
139 =item [Filters => ArrayRef[L<Paws::ComputeOptimizer::JobFilter>]]
140  
141 =item [JobIds => ArrayRef[Str|Undef]]
142  
143 =item [MaxResults => Int]
144  
145 =item [NextToken => Str]
146  
147  
148 =back
149  
150 Each argument is described in detail in: L<Paws::ComputeOptimizer::DescribeRecommendationExportJobs>
151  
152 Returns: a L<Paws::ComputeOptimizer::DescribeRecommendationExportJobsResponse> instance
153  
154 Describes recommendation export jobs created in the last seven days.
155  
156 Use the C<ExportAutoScalingGroupRecommendations> or
157 C<ExportEC2InstanceRecommendations> actions to request an export of
158 your recommendations. Then use the C<DescribeRecommendationExportJobs>
159 action to view your export jobs.
160  
161  
162 =head2 ExportAutoScalingGroupRecommendations
163  
164 =over
165  
166 =item S3DestinationConfig => L<Paws::ComputeOptimizer::S3DestinationConfig>
167  
168 =item [AccountIds => ArrayRef[Str|Undef]]
169  
170 =item [FieldsToExport => ArrayRef[Str|Undef]]
171  
172 =item [FileFormat => Str]
173  
174 =item [Filters => ArrayRef[L<Paws::ComputeOptimizer::Filter>]]
175  
176 =item [IncludeMemberAccounts => Bool]
177  
178  
179 =back
180  
181 Each argument is described in detail in: L<Paws::ComputeOptimizer::ExportAutoScalingGroupRecommendations>
182  
183 Returns: a L<Paws::ComputeOptimizer::ExportAutoScalingGroupRecommendationsResponse> instance
184  
185 Exports optimization recommendations for Auto Scaling groups.
186  
187 Recommendations are exported in a comma-separated values (.csv) file,
188 and its metadata in a JavaScript Object Notation (.json) file, to an
189 existing Amazon Simple Storage Service (Amazon S3) bucket that you
190 specify. For more information, see Exporting Recommendations
191 (https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html)
192 in the I<Compute Optimizer User Guide>.
193  
194 You can have only one Auto Scaling group export job in progress per AWS
195 Region.
196  
197  
198 =head2 ExportEBSVolumeRecommendations
199  
200 =over
201  
202 =item S3DestinationConfig => L<Paws::ComputeOptimizer::S3DestinationConfig>
203  
204 =item [AccountIds => ArrayRef[Str|Undef]]
205  
206 =item [FieldsToExport => ArrayRef[Str|Undef]]
207  
208 =item [FileFormat => Str]
209  
210 =item [Filters => ArrayRef[L<Paws::ComputeOptimizer::EBSFilter>]]
211  
212 =item [IncludeMemberAccounts => Bool]
213  
214  
215 =back
216  
217 Each argument is described in detail in: L<Paws::ComputeOptimizer::ExportEBSVolumeRecommendations>
218  
219 Returns: a L<Paws::ComputeOptimizer::ExportEBSVolumeRecommendationsResponse> instance
220  
221 Exports optimization recommendations for Amazon EBS volumes.
222  
223 Recommendations are exported in a comma-separated values (.csv) file,
224 and its metadata in a JavaScript Object Notation (.json) file, to an
225 existing Amazon Simple Storage Service (Amazon S3) bucket that you
226 specify. For more information, see Exporting Recommendations
227 (https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html)
228 in the I<Compute Optimizer User Guide>.
229  
230 You can have only one Amazon EBS volume export job in progress per AWS
231 Region.
232  
233  
234 =head2 ExportEC2InstanceRecommendations
235  
236 =over
237  
238 =item S3DestinationConfig => L<Paws::ComputeOptimizer::S3DestinationConfig>
239  
240 =item [AccountIds => ArrayRef[Str|Undef]]
241  
242 =item [FieldsToExport => ArrayRef[Str|Undef]]
243  
244 =item [FileFormat => Str]
245  
246 =item [Filters => ArrayRef[L<Paws::ComputeOptimizer::Filter>]]
247  
248 =item [IncludeMemberAccounts => Bool]
249  
250  
251 =back
252  
253 Each argument is described in detail in: L<Paws::ComputeOptimizer::ExportEC2InstanceRecommendations>
254  
255 Returns: a L<Paws::ComputeOptimizer::ExportEC2InstanceRecommendationsResponse> instance
256  
257 Exports optimization recommendations for Amazon EC2 instances.
258  
259 Recommendations are exported in a comma-separated values (.csv) file,
260 and its metadata in a JavaScript Object Notation (.json) file, to an
261 existing Amazon Simple Storage Service (Amazon S3) bucket that you
262 specify. For more information, see Exporting Recommendations
263 (https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html)
264 in the I<Compute Optimizer User Guide>.
265  
266 You can have only one Amazon EC2 instance export job in progress per
267 AWS Region.
268  
269  
270 =head2 ExportLambdaFunctionRecommendations
271  
272 =over
273  
274 =item S3DestinationConfig => L<Paws::ComputeOptimizer::S3DestinationConfig>
275  
276 =item [AccountIds => ArrayRef[Str|Undef]]
277  
278 =item [FieldsToExport => ArrayRef[Str|Undef]]
279  
280 =item [FileFormat => Str]
281  
282 =item [Filters => ArrayRef[L<Paws::ComputeOptimizer::LambdaFunctionRecommendationFilter>]]
283  
284 =item [IncludeMemberAccounts => Bool]
285  
286  
287 =back
288  
289 Each argument is described in detail in: L<Paws::ComputeOptimizer::ExportLambdaFunctionRecommendations>
290  
291 Returns: a L<Paws::ComputeOptimizer::ExportLambdaFunctionRecommendationsResponse> instance
292  
293 Exports optimization recommendations for AWS Lambda functions.
294  
295 Recommendations are exported in a comma-separated values (.csv) file,
296 and its metadata in a JavaScript Object Notation (.json) file, to an
297 existing Amazon Simple Storage Service (Amazon S3) bucket that you
298 specify. For more information, see Exporting Recommendations
299 (https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html)
300 in the I<Compute Optimizer User Guide>.
301  
302 You can have only one Lambda function export job in progress per AWS
303 Region.
304  
305  
306 =head2 GetAutoScalingGroupRecommendations
307  
308 =over
309  
310 =item [AccountIds => ArrayRef[Str|Undef]]
311  
312 =item [AutoScalingGroupArns => ArrayRef[Str|Undef]]
313  
314 =item [Filters => ArrayRef[L<Paws::ComputeOptimizer::Filter>]]
315  
316 =item [MaxResults => Int]
317  
318 =item [NextToken => Str]
319  
320  
321 =back
322  
323 Each argument is described in detail in: L<Paws::ComputeOptimizer::GetAutoScalingGroupRecommendations>
324  
325 Returns: a L<Paws::ComputeOptimizer::GetAutoScalingGroupRecommendationsResponse> instance
326  
327 Returns Auto Scaling group recommendations.
328  
329 AWS Compute Optimizer generates recommendations for Amazon EC2 Auto
330 Scaling groups that meet a specific set of requirements. For more
331 information, see the Supported resources and requirements
332 (https://docs.aws.amazon.com/compute-optimizer/latest/ug/requirements.html)
333 in the I<AWS Compute Optimizer User Guide>.
334  
335  
336 =head2 GetEBSVolumeRecommendations
337  
338 =over
339  
340 =item [AccountIds => ArrayRef[Str|Undef]]
341  
342 =item [Filters => ArrayRef[L<Paws::ComputeOptimizer::EBSFilter>]]
343  
344 =item [MaxResults => Int]
345  
346 =item [NextToken => Str]
347  
348 =item [VolumeArns => ArrayRef[Str|Undef]]
349  
350  
351 =back
352  
353 Each argument is described in detail in: L<Paws::ComputeOptimizer::GetEBSVolumeRecommendations>
354  
355 Returns: a L<Paws::ComputeOptimizer::GetEBSVolumeRecommendationsResponse> instance
356  
357 Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations.
358  
359 AWS Compute Optimizer generates recommendations for Amazon EBS volumes
360 that meet a specific set of requirements. For more information, see the
361 Supported resources and requirements
362 (https://docs.aws.amazon.com/compute-optimizer/latest/ug/requirements.html)
363 in the I<AWS Compute Optimizer User Guide>.
364  
365  
366 =head2 GetEC2InstanceRecommendations
367  
368 =over
369  
370 =item [AccountIds => ArrayRef[Str|Undef]]
371  
372 =item [Filters => ArrayRef[L<Paws::ComputeOptimizer::Filter>]]
373  
374 =item [InstanceArns => ArrayRef[Str|Undef]]
375  
376 =item [MaxResults => Int]
377  
378 =item [NextToken => Str]
379  
380  
381 =back
382  
383 Each argument is described in detail in: L<Paws::ComputeOptimizer::GetEC2InstanceRecommendations>
384  
385 Returns: a L<Paws::ComputeOptimizer::GetEC2InstanceRecommendationsResponse> instance
386  
387 Returns Amazon EC2 instance recommendations.
388  
389 AWS Compute Optimizer generates recommendations for Amazon Elastic
390 Compute Cloud (Amazon EC2) instances that meet a specific set of
391 requirements. For more information, see the Supported resources and
392 requirements
393 (https://docs.aws.amazon.com/compute-optimizer/latest/ug/requirements.html)
394 in the I<AWS Compute Optimizer User Guide>.
395  
396  
397 =head2 GetEC2RecommendationProjectedMetrics
398  
399 =over
400  
401 =item EndTime => Str
402  
403 =item InstanceArn => Str
404  
405 =item Period => Int
406  
407 =item StartTime => Str
408  
409 =item Stat => Str
410  
411  
412 =back
413  
414 Each argument is described in detail in: L<Paws::ComputeOptimizer::GetEC2RecommendationProjectedMetrics>
415  
416 Returns: a L<Paws::ComputeOptimizer::GetEC2RecommendationProjectedMetricsResponse> instance
417  
418 Returns the projected utilization metrics of Amazon EC2 instance
419 recommendations.
420  
421 The C<Cpu> and C<Memory> metrics are the only projected utilization
422 metrics returned when you run this action. Additionally, the C<Memory>
423 metric is returned only for resources that have the unified CloudWatch
424 agent installed on them. For more information, see Enabling Memory
425 Utilization with the CloudWatch Agent
426 (https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent).
427  
428  
429 =head2 GetEnrollmentStatus
430  
431  
432  
433  
434  
435  
436 Each argument is described in detail in: L<Paws::ComputeOptimizer::GetEnrollmentStatus>
437  
438 Returns: a L<Paws::ComputeOptimizer::GetEnrollmentStatusResponse> instance
439  
440 Returns the enrollment (opt in) status of an account to the AWS Compute
441 Optimizer service.
442  
443 If the account is the management account of an organization, this
444 action also confirms the enrollment status of member accounts within
445 the organization.
446  
447  
448 =head2 GetLambdaFunctionRecommendations
449  
450 =over
451  
452 =item [AccountIds => ArrayRef[Str|Undef]]
453  
454 =item [Filters => ArrayRef[L<Paws::ComputeOptimizer::LambdaFunctionRecommendationFilter>]]
455  
456 =item [FunctionArns => ArrayRef[Str|Undef]]
457  
458 =item [MaxResults => Int]
459  
460 =item [NextToken => Str]
461  
462  
463 =back
464  
465 Each argument is described in detail in: L<Paws::ComputeOptimizer::GetLambdaFunctionRecommendations>
466  
467 Returns: a L<Paws::ComputeOptimizer::GetLambdaFunctionRecommendationsResponse> instance
468  
469 Returns AWS Lambda function recommendations.
470  
471 AWS Compute Optimizer generates recommendations for functions that meet
472 a specific set of requirements. For more information, see the Supported
473 resources and requirements
474 (https://docs.aws.amazon.com/compute-optimizer/latest/ug/requirements.html)
475 in the I<AWS Compute Optimizer User Guide>.
476  
477  
478 =head2 GetRecommendationSummaries
479  
480 =over
481  
482 =item [AccountIds => ArrayRef[Str|Undef]]
483  
484 =item [MaxResults => Int]
485  
486 =item [NextToken => Str]
487  
488  
489 =back
490  
491 Each argument is described in detail in: L<Paws::ComputeOptimizer::GetRecommendationSummaries>
492  
493 Returns: a L<Paws::ComputeOptimizer::GetRecommendationSummariesResponse> instance
494  
495 Returns the optimization findings for an account.
496  
497 It returns the number of:
498  
499 =over
500  
501 =item *
502  
503 Amazon EC2 instances in an account that are C<Underprovisioned>,
504 C<Overprovisioned>, or C<Optimized>.
505  
506 =item *
507  
508 Auto Scaling groups in an account that are C<NotOptimized>, or
509 C<Optimized>.
510  
511 =item *
512  
513 Amazon EBS volumes in an account that are C<NotOptimized>, or
514 C<Optimized>.
515  
516 =item *
517  
518 Lambda functions in an account that are C<NotOptimized>, or
519 C<Optimized>.
520  
521 =back
522  
523  
524  
525 =head2 UpdateEnrollmentStatus
526  
527 =over
528  
529 =item Status => Str
530  
531 =item [IncludeMemberAccounts => Bool]
532  
533  
534 =back
535  
536 Each argument is described in detail in: L<Paws::ComputeOptimizer::UpdateEnrollmentStatus>
537  
538 Returns: a L<Paws::ComputeOptimizer::UpdateEnrollmentStatusResponse> instance
539  
540 Updates the enrollment (opt in and opt out) status of an account to the
541 AWS Compute Optimizer service.
542  
543 If the account is a management account of an organization, this action
544 can also be used to enroll member accounts within the organization.
545  
546 You must have the appropriate permissions to opt in to Compute
547 Optimizer, to view its recommendations, and to opt out. For more
548 information, see Controlling access with AWS Identity and Access
549 Management
550 (https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html)
551 in the I<AWS Compute Optimizer User Guide>.
552  
553 When you opt in, Compute Optimizer automatically creates a
554 Service-Linked Role in your account to access its data. For more
555 information, see Using Service-Linked Roles for AWS Compute Optimizer
556 (https://docs.aws.amazon.com/compute-optimizer/latest/ug/using-service-linked-roles.html)
557 in the I<AWS Compute Optimizer User Guide>.
558  
559  
560  
561  
562 =head1 PAGINATORS
563  
564 Paginator methods are helpers that repetively call methods that return partial results
565  
566  
567  
568  
569 =head1 SEE ALSO
570  
571 This service class forms part of L<Paws>
572  
573 =head1 BUGS and CONTRIBUTIONS
574  
575 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
576  
577 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
578  
579 =cut
580