aws-sdk-computeoptimizer 1.21.0 → 1.25.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-computeoptimizer/client.rb +212 -113
- data/lib/aws-sdk-computeoptimizer/client_api.rb +60 -0
- data/lib/aws-sdk-computeoptimizer/types.rb +423 -181
- data/lib/aws-sdk-computeoptimizer.rb +1 -1
- metadata +5 -5
@@ -23,6 +23,41 @@ module Aws::ComputeOptimizer
|
|
23
23
|
include Aws::Structure
|
24
24
|
end
|
25
25
|
|
26
|
+
# Describes the enrollment status of an organization's member accounts
|
27
|
+
# in Compute Optimizer.
|
28
|
+
#
|
29
|
+
# @!attribute [rw] account_id
|
30
|
+
# The Amazon Web Services account ID.
|
31
|
+
# @return [String]
|
32
|
+
#
|
33
|
+
# @!attribute [rw] status
|
34
|
+
# The account enrollment status.
|
35
|
+
# @return [String]
|
36
|
+
#
|
37
|
+
# @!attribute [rw] status_reason
|
38
|
+
# The reason for the account enrollment status.
|
39
|
+
#
|
40
|
+
# For example, an account might show a status of `Pending` because
|
41
|
+
# member accounts of an organization require more time to be enrolled
|
42
|
+
# in the service.
|
43
|
+
# @return [String]
|
44
|
+
#
|
45
|
+
# @!attribute [rw] last_updated_timestamp
|
46
|
+
# The Unix epoch timestamp, in seconds, of when the account enrollment
|
47
|
+
# status was last updated.
|
48
|
+
# @return [Time]
|
49
|
+
#
|
50
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/AccountEnrollmentStatus AWS API Documentation
|
51
|
+
#
|
52
|
+
class AccountEnrollmentStatus < Struct.new(
|
53
|
+
:account_id,
|
54
|
+
:status,
|
55
|
+
:status_reason,
|
56
|
+
:last_updated_timestamp)
|
57
|
+
SENSITIVE = []
|
58
|
+
include Aws::Structure
|
59
|
+
end
|
60
|
+
|
26
61
|
# Describes the configuration of an Auto Scaling group.
|
27
62
|
#
|
28
63
|
# @!attribute [rw] desired_capacity
|
@@ -58,7 +93,7 @@ module Aws::ComputeOptimizer
|
|
58
93
|
# Describes an Auto Scaling group recommendation.
|
59
94
|
#
|
60
95
|
# @!attribute [rw] account_id
|
61
|
-
# The
|
96
|
+
# The Amazon Web Services account ID of the Auto Scaling group.
|
62
97
|
# @return [String]
|
63
98
|
#
|
64
99
|
# @!attribute [rw] auto_scaling_group_arn
|
@@ -75,7 +110,7 @@ module Aws::ComputeOptimizer
|
|
75
110
|
# Findings for Auto Scaling groups include:
|
76
111
|
#
|
77
112
|
# * <b> <code>NotOptimized</code> </b>—An Auto Scaling group is
|
78
|
-
# considered not optimized when
|
113
|
+
# considered not optimized when Compute Optimizer identifies a
|
79
114
|
# recommendation that can provide better performance for your
|
80
115
|
# workload.
|
81
116
|
#
|
@@ -107,8 +142,8 @@ module Aws::ComputeOptimizer
|
|
107
142
|
# @return [Array<Types::AutoScalingGroupRecommendationOption>]
|
108
143
|
#
|
109
144
|
# @!attribute [rw] last_refresh_timestamp
|
110
|
-
# The
|
111
|
-
#
|
145
|
+
# The timestamp of when the Auto Scaling group recommendation was last
|
146
|
+
# refreshed.
|
112
147
|
# @return [Time]
|
113
148
|
#
|
114
149
|
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/AutoScalingGroupRecommendation AWS API Documentation
|
@@ -207,15 +242,15 @@ module Aws::ComputeOptimizer
|
|
207
242
|
# The identification numbers of the export jobs to return.
|
208
243
|
#
|
209
244
|
# An export job ID is returned when you create an export using the
|
210
|
-
#
|
211
|
-
#
|
245
|
+
# ExportAutoScalingGroupRecommendations or
|
246
|
+
# ExportEC2InstanceRecommendations actions.
|
212
247
|
#
|
213
248
|
# All export jobs created in the last seven days are returned if this
|
214
249
|
# parameter is omitted.
|
215
250
|
# @return [Array<String>]
|
216
251
|
#
|
217
252
|
# @!attribute [rw] filters
|
218
|
-
# An array of objects
|
253
|
+
# An array of objects to specify a filter that returns a more specific
|
219
254
|
# list of export jobs.
|
220
255
|
# @return [Array<Types::JobFilter>]
|
221
256
|
#
|
@@ -227,7 +262,7 @@ module Aws::ComputeOptimizer
|
|
227
262
|
# The maximum number of export jobs to return with a single request.
|
228
263
|
#
|
229
264
|
# To retrieve the remaining results, make another request with the
|
230
|
-
# returned `
|
265
|
+
# returned `nextToken` value.
|
231
266
|
# @return [Integer]
|
232
267
|
#
|
233
268
|
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/DescribeRecommendationExportJobsRequest AWS API Documentation
|
@@ -263,13 +298,13 @@ module Aws::ComputeOptimizer
|
|
263
298
|
|
264
299
|
# Describes a filter that returns a more specific list of Amazon Elastic
|
265
300
|
# Block Store (Amazon EBS) volume recommendations. Use this filter with
|
266
|
-
# the
|
301
|
+
# the GetEBSVolumeRecommendations action.
|
267
302
|
#
|
268
303
|
# You can use `LambdaFunctionRecommendationFilter` with the
|
269
|
-
#
|
270
|
-
#
|
271
|
-
#
|
272
|
-
#
|
304
|
+
# GetLambdaFunctionRecommendations action, `JobFilter` with the
|
305
|
+
# DescribeRecommendationExportJobs action, and `Filter` with the
|
306
|
+
# GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations
|
307
|
+
# actions.
|
273
308
|
#
|
274
309
|
# @note When making an API call, you may pass EBSFilter
|
275
310
|
# data as a hash:
|
@@ -283,7 +318,7 @@ module Aws::ComputeOptimizer
|
|
283
318
|
# The name of the filter.
|
284
319
|
#
|
285
320
|
# Specify `Finding` to return recommendations with a specific finding
|
286
|
-
# classification (
|
321
|
+
# classification (for example, `NotOptimized`).
|
287
322
|
# @return [String]
|
288
323
|
#
|
289
324
|
# @!attribute [rw] values
|
@@ -337,17 +372,17 @@ module Aws::ComputeOptimizer
|
|
337
372
|
# @!attribute [rw] statistic
|
338
373
|
# The statistic of the utilization metric.
|
339
374
|
#
|
340
|
-
# The Compute Optimizer API,
|
341
|
-
#
|
342
|
-
#
|
375
|
+
# The Compute Optimizer API, Command Line Interface (CLI), and SDKs
|
376
|
+
# return utilization metrics using only the `Maximum` statistic, which
|
377
|
+
# is the highest value observed during the specified period.
|
343
378
|
#
|
344
379
|
# The Compute Optimizer console displays graphs for some utilization
|
345
380
|
# metrics using the `Average` statistic, which is the value of `Sum` /
|
346
381
|
# `SampleCount` during the specified period. For more information, see
|
347
|
-
# [Viewing resource recommendations][1] in the *
|
348
|
-
#
|
349
|
-
#
|
350
|
-
#
|
382
|
+
# [Viewing resource recommendations][1] in the *Compute Optimizer User
|
383
|
+
# Guide*. You can also get averaged utilization metric data for your
|
384
|
+
# resources using Amazon CloudWatch. For more information, see the
|
385
|
+
# [Amazon CloudWatch User Guide][2].
|
351
386
|
#
|
352
387
|
#
|
353
388
|
#
|
@@ -369,6 +404,40 @@ module Aws::ComputeOptimizer
|
|
369
404
|
include Aws::Structure
|
370
405
|
end
|
371
406
|
|
407
|
+
# Describes a filter that returns a more specific list of account
|
408
|
+
# enrollment statuses. Use this filter with the
|
409
|
+
# GetEnrollmentStatusesForOrganization action.
|
410
|
+
#
|
411
|
+
# @note When making an API call, you may pass EnrollmentFilter
|
412
|
+
# data as a hash:
|
413
|
+
#
|
414
|
+
# {
|
415
|
+
# name: "Status", # accepts Status
|
416
|
+
# values: ["FilterValue"],
|
417
|
+
# }
|
418
|
+
#
|
419
|
+
# @!attribute [rw] name
|
420
|
+
# The name of the filter.
|
421
|
+
#
|
422
|
+
# Specify `Status` to return accounts with a specific enrollment
|
423
|
+
# status (for example, `Active`).
|
424
|
+
# @return [String]
|
425
|
+
#
|
426
|
+
# @!attribute [rw] values
|
427
|
+
# The value of the filter.
|
428
|
+
#
|
429
|
+
# The valid values are `Active`, `Inactive`, `Pending`, and `Failed`.
|
430
|
+
# @return [Array<String>]
|
431
|
+
#
|
432
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/EnrollmentFilter AWS API Documentation
|
433
|
+
#
|
434
|
+
class EnrollmentFilter < Struct.new(
|
435
|
+
:name,
|
436
|
+
:values)
|
437
|
+
SENSITIVE = []
|
438
|
+
include Aws::Structure
|
439
|
+
end
|
440
|
+
|
372
441
|
# @note When making an API call, you may pass ExportAutoScalingGroupRecommendationsRequest
|
373
442
|
# data as a hash:
|
374
443
|
#
|
@@ -387,11 +456,14 @@ module Aws::ComputeOptimizer
|
|
387
456
|
# },
|
388
457
|
# file_format: "Csv", # accepts Csv
|
389
458
|
# include_member_accounts: false,
|
459
|
+
# recommendation_preferences: {
|
460
|
+
# cpu_vendor_architectures: ["AWS_ARM64"], # accepts AWS_ARM64, CURRENT
|
461
|
+
# },
|
390
462
|
# }
|
391
463
|
#
|
392
464
|
# @!attribute [rw] account_ids
|
393
|
-
# The IDs of the
|
394
|
-
# recommendations.
|
465
|
+
# The IDs of the Amazon Web Services accounts for which to export Auto
|
466
|
+
# Scaling group recommendations.
|
395
467
|
#
|
396
468
|
# If your account is the management account of an organization, use
|
397
469
|
# this parameter to specify the member account for which you want to
|
@@ -408,7 +480,7 @@ module Aws::ComputeOptimizer
|
|
408
480
|
# @return [Array<String>]
|
409
481
|
#
|
410
482
|
# @!attribute [rw] filters
|
411
|
-
# An array of objects
|
483
|
+
# An array of objects to specify a filter that exports a more specific
|
412
484
|
# set of Auto Scaling group recommendations.
|
413
485
|
# @return [Array<Types::Filter>]
|
414
486
|
#
|
@@ -429,12 +501,12 @@ module Aws::ComputeOptimizer
|
|
429
501
|
# You must create the destination Amazon S3 bucket for your
|
430
502
|
# recommendations export before you create the export job. Compute
|
431
503
|
# Optimizer does not create the S3 bucket for you. After you create
|
432
|
-
# the S3 bucket, ensure that it has the required
|
504
|
+
# the S3 bucket, ensure that it has the required permissions policy to
|
433
505
|
# allow Compute Optimizer to write the export file to it. If you plan
|
434
506
|
# to specify an object prefix when you create the export job, you must
|
435
507
|
# include the object prefix in the policy that you add to the S3
|
436
508
|
# bucket. For more information, see [Amazon S3 Bucket Policy for
|
437
|
-
# Compute Optimizer][1] in the *Compute Optimizer
|
509
|
+
# Compute Optimizer][1] in the *Compute Optimizer User Guide*.
|
438
510
|
#
|
439
511
|
#
|
440
512
|
#
|
@@ -455,8 +527,8 @@ module Aws::ComputeOptimizer
|
|
455
527
|
# The member accounts must also be opted in to Compute Optimizer, and
|
456
528
|
# trusted access for Compute Optimizer must be enabled in the
|
457
529
|
# organization account. For more information, see [Compute Optimizer
|
458
|
-
# and
|
459
|
-
# Optimizer User Guide*.
|
530
|
+
# and Amazon Web Services Organizations trusted access][1] in the
|
531
|
+
# *Compute Optimizer User Guide*.
|
460
532
|
#
|
461
533
|
# Recommendations for member accounts of the organization are not
|
462
534
|
# included in the export file if this parameter is omitted.
|
@@ -472,6 +544,11 @@ module Aws::ComputeOptimizer
|
|
472
544
|
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access
|
473
545
|
# @return [Boolean]
|
474
546
|
#
|
547
|
+
# @!attribute [rw] recommendation_preferences
|
548
|
+
# An object to specify the preferences for the Auto Scaling group
|
549
|
+
# recommendations to export.
|
550
|
+
# @return [Types::RecommendationPreferences]
|
551
|
+
#
|
475
552
|
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/ExportAutoScalingGroupRecommendationsRequest AWS API Documentation
|
476
553
|
#
|
477
554
|
class ExportAutoScalingGroupRecommendationsRequest < Struct.new(
|
@@ -480,7 +557,8 @@ module Aws::ComputeOptimizer
|
|
480
557
|
:fields_to_export,
|
481
558
|
:s3_destination_config,
|
482
559
|
:file_format,
|
483
|
-
:include_member_accounts
|
560
|
+
:include_member_accounts,
|
561
|
+
:recommendation_preferences)
|
484
562
|
SENSITIVE = []
|
485
563
|
include Aws::Structure
|
486
564
|
end
|
@@ -488,8 +566,8 @@ module Aws::ComputeOptimizer
|
|
488
566
|
# @!attribute [rw] job_id
|
489
567
|
# The identification number of the export job.
|
490
568
|
#
|
491
|
-
# Use the
|
492
|
-
#
|
569
|
+
# Use the DescribeRecommendationExportJobs action, and specify the job
|
570
|
+
# ID to view the status of an export job.
|
493
571
|
# @return [String]
|
494
572
|
#
|
495
573
|
# @!attribute [rw] s3_destination
|
@@ -544,8 +622,8 @@ module Aws::ComputeOptimizer
|
|
544
622
|
# }
|
545
623
|
#
|
546
624
|
# @!attribute [rw] account_ids
|
547
|
-
# The IDs of the
|
548
|
-
# recommendations.
|
625
|
+
# The IDs of the Amazon Web Services accounts for which to export
|
626
|
+
# Amazon EBS volume recommendations.
|
549
627
|
#
|
550
628
|
# If your account is the management account of an organization, use
|
551
629
|
# this parameter to specify the member account for which you want to
|
@@ -562,7 +640,7 @@ module Aws::ComputeOptimizer
|
|
562
640
|
# @return [Array<String>]
|
563
641
|
#
|
564
642
|
# @!attribute [rw] filters
|
565
|
-
# An array of objects
|
643
|
+
# An array of objects to specify a filter that exports a more specific
|
566
644
|
# set of Amazon EBS volume recommendations.
|
567
645
|
# @return [Array<Types::EBSFilter>]
|
568
646
|
#
|
@@ -588,7 +666,7 @@ module Aws::ComputeOptimizer
|
|
588
666
|
# to specify an object prefix when you create the export job, you must
|
589
667
|
# include the object prefix in the policy that you add to the S3
|
590
668
|
# bucket. For more information, see [Amazon S3 Bucket Policy for
|
591
|
-
# Compute Optimizer][1] in the *Compute Optimizer
|
669
|
+
# Compute Optimizer][1] in the *Compute Optimizer User Guide*.
|
592
670
|
#
|
593
671
|
#
|
594
672
|
#
|
@@ -609,8 +687,8 @@ module Aws::ComputeOptimizer
|
|
609
687
|
# The member accounts must also be opted in to Compute Optimizer, and
|
610
688
|
# trusted access for Compute Optimizer must be enabled in the
|
611
689
|
# organization account. For more information, see [Compute Optimizer
|
612
|
-
# and
|
613
|
-
# Optimizer User Guide*.
|
690
|
+
# and Amazon Web Services Organizations trusted access][1] in the
|
691
|
+
# *Compute Optimizer User Guide*.
|
614
692
|
#
|
615
693
|
# Recommendations for member accounts of the organization are not
|
616
694
|
# included in the export file if this parameter is omitted.
|
@@ -642,8 +720,8 @@ module Aws::ComputeOptimizer
|
|
642
720
|
# @!attribute [rw] job_id
|
643
721
|
# The identification number of the export job.
|
644
722
|
#
|
645
|
-
# Use the
|
646
|
-
#
|
723
|
+
# Use the DescribeRecommendationExportJobs action, and specify the job
|
724
|
+
# ID to view the status of an export job.
|
647
725
|
# @return [String]
|
648
726
|
#
|
649
727
|
# @!attribute [rw] s3_destination
|
@@ -679,11 +757,14 @@ module Aws::ComputeOptimizer
|
|
679
757
|
# },
|
680
758
|
# file_format: "Csv", # accepts Csv
|
681
759
|
# include_member_accounts: false,
|
760
|
+
# recommendation_preferences: {
|
761
|
+
# cpu_vendor_architectures: ["AWS_ARM64"], # accepts AWS_ARM64, CURRENT
|
762
|
+
# },
|
682
763
|
# }
|
683
764
|
#
|
684
765
|
# @!attribute [rw] account_ids
|
685
|
-
# The IDs of the
|
686
|
-
# recommendations.
|
766
|
+
# The IDs of the Amazon Web Services accounts for which to export
|
767
|
+
# instance recommendations.
|
687
768
|
#
|
688
769
|
# If your account is the management account of an organization, use
|
689
770
|
# this parameter to specify the member account for which you want to
|
@@ -700,7 +781,7 @@ module Aws::ComputeOptimizer
|
|
700
781
|
# @return [Array<String>]
|
701
782
|
#
|
702
783
|
# @!attribute [rw] filters
|
703
|
-
# An array of objects
|
784
|
+
# An array of objects to specify a filter that exports a more specific
|
704
785
|
# set of instance recommendations.
|
705
786
|
# @return [Array<Types::Filter>]
|
706
787
|
#
|
@@ -721,12 +802,12 @@ module Aws::ComputeOptimizer
|
|
721
802
|
# You must create the destination Amazon S3 bucket for your
|
722
803
|
# recommendations export before you create the export job. Compute
|
723
804
|
# Optimizer does not create the S3 bucket for you. After you create
|
724
|
-
# the S3 bucket, ensure that it has the required
|
725
|
-
# allow Compute Optimizer to write the export file to it. If
|
726
|
-
# to specify an object prefix when you create the export job,
|
727
|
-
# include the object prefix in the
|
805
|
+
# the S3 bucket, ensure that it has the required permissions policy
|
806
|
+
# policy to allow Compute Optimizer to write the export file to it. If
|
807
|
+
# you plan to specify an object prefix when you create the export job,
|
808
|
+
# you must include the object prefix in the that you add to the S3
|
728
809
|
# bucket. For more information, see [Amazon S3 Bucket Policy for
|
729
|
-
# Compute Optimizer][1] in the *Compute Optimizer
|
810
|
+
# Compute Optimizer][1] in the *Compute Optimizer User Guide*.
|
730
811
|
#
|
731
812
|
#
|
732
813
|
#
|
@@ -747,8 +828,8 @@ module Aws::ComputeOptimizer
|
|
747
828
|
# The member accounts must also be opted in to Compute Optimizer, and
|
748
829
|
# trusted access for Compute Optimizer must be enabled in the
|
749
830
|
# organization account. For more information, see [Compute Optimizer
|
750
|
-
# and
|
751
|
-
# Optimizer User Guide*.
|
831
|
+
# and Amazon Web Services Organizations trusted access][1] in the
|
832
|
+
# *Compute Optimizer User Guide*.
|
752
833
|
#
|
753
834
|
# Recommendations for member accounts of the organization are not
|
754
835
|
# included in the export file if this parameter is omitted.
|
@@ -761,6 +842,11 @@ module Aws::ComputeOptimizer
|
|
761
842
|
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access
|
762
843
|
# @return [Boolean]
|
763
844
|
#
|
845
|
+
# @!attribute [rw] recommendation_preferences
|
846
|
+
# An object to specify the preferences for the Amazon EC2 instance
|
847
|
+
# recommendations to export.
|
848
|
+
# @return [Types::RecommendationPreferences]
|
849
|
+
#
|
764
850
|
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/ExportEC2InstanceRecommendationsRequest AWS API Documentation
|
765
851
|
#
|
766
852
|
class ExportEC2InstanceRecommendationsRequest < Struct.new(
|
@@ -769,7 +855,8 @@ module Aws::ComputeOptimizer
|
|
769
855
|
:fields_to_export,
|
770
856
|
:s3_destination_config,
|
771
857
|
:file_format,
|
772
|
-
:include_member_accounts
|
858
|
+
:include_member_accounts,
|
859
|
+
:recommendation_preferences)
|
773
860
|
SENSITIVE = []
|
774
861
|
include Aws::Structure
|
775
862
|
end
|
@@ -777,8 +864,8 @@ module Aws::ComputeOptimizer
|
|
777
864
|
# @!attribute [rw] job_id
|
778
865
|
# The identification number of the export job.
|
779
866
|
#
|
780
|
-
# Use the
|
781
|
-
#
|
867
|
+
# Use the DescribeRecommendationExportJobs action, and specify the job
|
868
|
+
# ID to view the status of an export job.
|
782
869
|
# @return [String]
|
783
870
|
#
|
784
871
|
# @!attribute [rw] s3_destination
|
@@ -816,8 +903,8 @@ module Aws::ComputeOptimizer
|
|
816
903
|
# }
|
817
904
|
#
|
818
905
|
# @!attribute [rw] account_ids
|
819
|
-
# The IDs of the
|
820
|
-
# recommendations.
|
906
|
+
# The IDs of the Amazon Web Services accounts for which to export
|
907
|
+
# Lambda function recommendations.
|
821
908
|
#
|
822
909
|
# If your account is the management account of an organization, use
|
823
910
|
# this parameter to specify the member account for which you want to
|
@@ -834,7 +921,7 @@ module Aws::ComputeOptimizer
|
|
834
921
|
# @return [Array<String>]
|
835
922
|
#
|
836
923
|
# @!attribute [rw] filters
|
837
|
-
# An array of objects
|
924
|
+
# An array of objects to specify a filter that exports a more specific
|
838
925
|
# set of Lambda function recommendations.
|
839
926
|
# @return [Array<Types::LambdaFunctionRecommendationFilter>]
|
840
927
|
#
|
@@ -860,7 +947,7 @@ module Aws::ComputeOptimizer
|
|
860
947
|
# to specify an object prefix when you create the export job, you must
|
861
948
|
# include the object prefix in the policy that you add to the S3
|
862
949
|
# bucket. For more information, see [Amazon S3 Bucket Policy for
|
863
|
-
# Compute Optimizer][1] in the *Compute Optimizer
|
950
|
+
# Compute Optimizer][1] in the *Compute Optimizer User Guide*.
|
864
951
|
#
|
865
952
|
#
|
866
953
|
#
|
@@ -881,8 +968,8 @@ module Aws::ComputeOptimizer
|
|
881
968
|
# The member accounts must also be opted in to Compute Optimizer, and
|
882
969
|
# trusted access for Compute Optimizer must be enabled in the
|
883
970
|
# organization account. For more information, see [Compute Optimizer
|
884
|
-
# and
|
885
|
-
# Optimizer User Guide*.
|
971
|
+
# and Amazon Web Services Organizations trusted access][1] in the
|
972
|
+
# *Compute Optimizer User Guide*.
|
886
973
|
#
|
887
974
|
# Recommendations for member accounts of the organization are not
|
888
975
|
# included in the export file if this parameter is omitted.
|
@@ -914,8 +1001,8 @@ module Aws::ComputeOptimizer
|
|
914
1001
|
# @!attribute [rw] job_id
|
915
1002
|
# The identification number of the export job.
|
916
1003
|
#
|
917
|
-
# Use the
|
918
|
-
#
|
1004
|
+
# Use the DescribeRecommendationExportJobs action, and specify the job
|
1005
|
+
# ID to view the status of an export job.
|
919
1006
|
# @return [String]
|
920
1007
|
#
|
921
1008
|
# @!attribute [rw] s3_destination
|
@@ -935,13 +1022,13 @@ module Aws::ComputeOptimizer
|
|
935
1022
|
|
936
1023
|
# Describes a filter that returns a more specific list of
|
937
1024
|
# recommendations. Use this filter with the
|
938
|
-
#
|
939
|
-
#
|
1025
|
+
# GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations
|
1026
|
+
# actions.
|
940
1027
|
#
|
941
|
-
# You can use `EBSFilter` with the
|
1028
|
+
# You can use `EBSFilter` with the GetEBSVolumeRecommendations action,
|
942
1029
|
# `LambdaFunctionRecommendationFilter` with the
|
943
|
-
#
|
944
|
-
#
|
1030
|
+
# GetLambdaFunctionRecommendations action, and `JobFilter` with the
|
1031
|
+
# DescribeRecommendationExportJobs action.
|
945
1032
|
#
|
946
1033
|
# @note When making an API call, you may pass Filter
|
947
1034
|
# data as a hash:
|
@@ -955,13 +1042,13 @@ module Aws::ComputeOptimizer
|
|
955
1042
|
# The name of the filter.
|
956
1043
|
#
|
957
1044
|
# Specify `Finding` to return recommendations with a specific finding
|
958
|
-
# classification (
|
1045
|
+
# classification (for example, `Underprovisioned`).
|
959
1046
|
#
|
960
1047
|
# Specify `RecommendationSourceType` to return recommendations of a
|
961
|
-
# specific resource type (
|
1048
|
+
# specific resource type (for example, `Ec2Instance`).
|
962
1049
|
#
|
963
1050
|
# Specify `FindingReasonCodes` to return recommendations with a
|
964
|
-
# specific finding reason code (
|
1051
|
+
# specific finding reason code (for example, `CPUUnderprovisioned`).
|
965
1052
|
# @return [String]
|
966
1053
|
#
|
967
1054
|
# @!attribute [rw] values
|
@@ -1088,11 +1175,14 @@ module Aws::ComputeOptimizer
|
|
1088
1175
|
# values: ["FilterValue"],
|
1089
1176
|
# },
|
1090
1177
|
# ],
|
1178
|
+
# recommendation_preferences: {
|
1179
|
+
# cpu_vendor_architectures: ["AWS_ARM64"], # accepts AWS_ARM64, CURRENT
|
1180
|
+
# },
|
1091
1181
|
# }
|
1092
1182
|
#
|
1093
1183
|
# @!attribute [rw] account_ids
|
1094
|
-
# The ID of the
|
1095
|
-
# recommendations.
|
1184
|
+
# The ID of the Amazon Web Services account for which to return Auto
|
1185
|
+
# Scaling group recommendations.
|
1096
1186
|
#
|
1097
1187
|
# If your account is the management account of an organization, use
|
1098
1188
|
# this parameter to specify the member account for which you want to
|
@@ -1116,14 +1206,19 @@ module Aws::ComputeOptimizer
|
|
1116
1206
|
# with a single request.
|
1117
1207
|
#
|
1118
1208
|
# To retrieve the remaining results, make another request with the
|
1119
|
-
# returned `
|
1209
|
+
# returned `nextToken` value.
|
1120
1210
|
# @return [Integer]
|
1121
1211
|
#
|
1122
1212
|
# @!attribute [rw] filters
|
1123
|
-
# An array of objects
|
1124
|
-
#
|
1213
|
+
# An array of objects to specify a filter that returns a more specific
|
1214
|
+
# list of Auto Scaling group recommendations.
|
1125
1215
|
# @return [Array<Types::Filter>]
|
1126
1216
|
#
|
1217
|
+
# @!attribute [rw] recommendation_preferences
|
1218
|
+
# An object to specify the preferences for the Auto Scaling group
|
1219
|
+
# recommendations to return in the response.
|
1220
|
+
# @return [Types::RecommendationPreferences]
|
1221
|
+
#
|
1127
1222
|
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/GetAutoScalingGroupRecommendationsRequest AWS API Documentation
|
1128
1223
|
#
|
1129
1224
|
class GetAutoScalingGroupRecommendationsRequest < Struct.new(
|
@@ -1131,7 +1226,8 @@ module Aws::ComputeOptimizer
|
|
1131
1226
|
:auto_scaling_group_arns,
|
1132
1227
|
:next_token,
|
1133
1228
|
:max_results,
|
1134
|
-
:filters
|
1229
|
+
:filters,
|
1230
|
+
:recommendation_preferences)
|
1135
1231
|
SENSITIVE = []
|
1136
1232
|
include Aws::Structure
|
1137
1233
|
end
|
@@ -1196,16 +1292,16 @@ module Aws::ComputeOptimizer
|
|
1196
1292
|
# request.
|
1197
1293
|
#
|
1198
1294
|
# To retrieve the remaining results, make another request with the
|
1199
|
-
# returned `
|
1295
|
+
# returned `nextToken` value.
|
1200
1296
|
# @return [Integer]
|
1201
1297
|
#
|
1202
1298
|
# @!attribute [rw] filters
|
1203
|
-
# An array of objects
|
1204
|
-
#
|
1299
|
+
# An array of objects to specify a filter that returns a more specific
|
1300
|
+
# list of volume recommendations.
|
1205
1301
|
# @return [Array<Types::EBSFilter>]
|
1206
1302
|
#
|
1207
1303
|
# @!attribute [rw] account_ids
|
1208
|
-
# The ID of the
|
1304
|
+
# The ID of the Amazon Web Services account for which to return volume
|
1209
1305
|
# recommendations.
|
1210
1306
|
#
|
1211
1307
|
# If your account is the management account of an organization, use
|
@@ -1270,6 +1366,9 @@ module Aws::ComputeOptimizer
|
|
1270
1366
|
# },
|
1271
1367
|
# ],
|
1272
1368
|
# account_ids: ["AccountId"],
|
1369
|
+
# recommendation_preferences: {
|
1370
|
+
# cpu_vendor_architectures: ["AWS_ARM64"], # accepts AWS_ARM64, CURRENT
|
1371
|
+
# },
|
1273
1372
|
# }
|
1274
1373
|
#
|
1275
1374
|
# @!attribute [rw] instance_arns
|
@@ -1286,17 +1385,17 @@ module Aws::ComputeOptimizer
|
|
1286
1385
|
# single request.
|
1287
1386
|
#
|
1288
1387
|
# To retrieve the remaining results, make another request with the
|
1289
|
-
# returned `
|
1388
|
+
# returned `nextToken` value.
|
1290
1389
|
# @return [Integer]
|
1291
1390
|
#
|
1292
1391
|
# @!attribute [rw] filters
|
1293
|
-
# An array of objects
|
1294
|
-
#
|
1392
|
+
# An array of objects to specify a filter that returns a more specific
|
1393
|
+
# list of instance recommendations.
|
1295
1394
|
# @return [Array<Types::Filter>]
|
1296
1395
|
#
|
1297
1396
|
# @!attribute [rw] account_ids
|
1298
|
-
# The ID of the
|
1299
|
-
# recommendations.
|
1397
|
+
# The ID of the Amazon Web Services account for which to return
|
1398
|
+
# instance recommendations.
|
1300
1399
|
#
|
1301
1400
|
# If your account is the management account of an organization, use
|
1302
1401
|
# this parameter to specify the member account for which you want to
|
@@ -1305,6 +1404,11 @@ module Aws::ComputeOptimizer
|
|
1305
1404
|
# Only one account ID can be specified per request.
|
1306
1405
|
# @return [Array<String>]
|
1307
1406
|
#
|
1407
|
+
# @!attribute [rw] recommendation_preferences
|
1408
|
+
# An object to specify the preferences for the Amazon EC2 instance
|
1409
|
+
# recommendations to return in the response.
|
1410
|
+
# @return [Types::RecommendationPreferences]
|
1411
|
+
#
|
1308
1412
|
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/GetEC2InstanceRecommendationsRequest AWS API Documentation
|
1309
1413
|
#
|
1310
1414
|
class GetEC2InstanceRecommendationsRequest < Struct.new(
|
@@ -1312,7 +1416,8 @@ module Aws::ComputeOptimizer
|
|
1312
1416
|
:next_token,
|
1313
1417
|
:max_results,
|
1314
1418
|
:filters,
|
1315
|
-
:account_ids
|
1419
|
+
:account_ids,
|
1420
|
+
:recommendation_preferences)
|
1316
1421
|
SENSITIVE = []
|
1317
1422
|
include Aws::Structure
|
1318
1423
|
end
|
@@ -1355,6 +1460,9 @@ module Aws::ComputeOptimizer
|
|
1355
1460
|
# period: 1, # required
|
1356
1461
|
# start_time: Time.now, # required
|
1357
1462
|
# end_time: Time.now, # required
|
1463
|
+
# recommendation_preferences: {
|
1464
|
+
# cpu_vendor_architectures: ["AWS_ARM64"], # accepts AWS_ARM64, CURRENT
|
1465
|
+
# },
|
1358
1466
|
# }
|
1359
1467
|
#
|
1360
1468
|
# @!attribute [rw] instance_arn
|
@@ -1371,13 +1479,18 @@ module Aws::ComputeOptimizer
|
|
1371
1479
|
# @return [Integer]
|
1372
1480
|
#
|
1373
1481
|
# @!attribute [rw] start_time
|
1374
|
-
# The
|
1482
|
+
# The timestamp of the first projected metrics data point to return.
|
1375
1483
|
# @return [Time]
|
1376
1484
|
#
|
1377
1485
|
# @!attribute [rw] end_time
|
1378
|
-
# The
|
1486
|
+
# The timestamp of the last projected metrics data point to return.
|
1379
1487
|
# @return [Time]
|
1380
1488
|
#
|
1489
|
+
# @!attribute [rw] recommendation_preferences
|
1490
|
+
# An object to specify the preferences for the Amazon EC2
|
1491
|
+
# recommendation projected metrics to return in the response.
|
1492
|
+
# @return [Types::RecommendationPreferences]
|
1493
|
+
#
|
1381
1494
|
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/GetEC2RecommendationProjectedMetricsRequest AWS API Documentation
|
1382
1495
|
#
|
1383
1496
|
class GetEC2RecommendationProjectedMetricsRequest < Struct.new(
|
@@ -1385,13 +1498,14 @@ module Aws::ComputeOptimizer
|
|
1385
1498
|
:stat,
|
1386
1499
|
:period,
|
1387
1500
|
:start_time,
|
1388
|
-
:end_time
|
1501
|
+
:end_time,
|
1502
|
+
:recommendation_preferences)
|
1389
1503
|
SENSITIVE = []
|
1390
1504
|
include Aws::Structure
|
1391
1505
|
end
|
1392
1506
|
|
1393
1507
|
# @!attribute [rw] recommended_option_projected_metrics
|
1394
|
-
# An array of objects that
|
1508
|
+
# An array of objects that describes projected metrics.
|
1395
1509
|
# @return [Array<Types::RecommendedOptionProjectedMetric>]
|
1396
1510
|
#
|
1397
1511
|
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/GetEC2RecommendationProjectedMetricsResponse AWS API Documentation
|
@@ -1421,17 +1535,94 @@ module Aws::ComputeOptimizer
|
|
1421
1535
|
# @return [String]
|
1422
1536
|
#
|
1423
1537
|
# @!attribute [rw] member_accounts_enrolled
|
1424
|
-
# Confirms the enrollment status of member accounts
|
1538
|
+
# Confirms the enrollment status of member accounts of the
|
1425
1539
|
# organization, if the account is a management account of an
|
1426
1540
|
# organization.
|
1427
1541
|
# @return [Boolean]
|
1428
1542
|
#
|
1543
|
+
# @!attribute [rw] last_updated_timestamp
|
1544
|
+
# The Unix epoch timestamp, in seconds, of when the account enrollment
|
1545
|
+
# status was last updated.
|
1546
|
+
# @return [Time]
|
1547
|
+
#
|
1548
|
+
# @!attribute [rw] number_of_member_accounts_opted_in
|
1549
|
+
# The count of organization member accounts that are opted in to the
|
1550
|
+
# service, if your account is an organization management account.
|
1551
|
+
# @return [Integer]
|
1552
|
+
#
|
1429
1553
|
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/GetEnrollmentStatusResponse AWS API Documentation
|
1430
1554
|
#
|
1431
1555
|
class GetEnrollmentStatusResponse < Struct.new(
|
1432
1556
|
:status,
|
1433
1557
|
:status_reason,
|
1434
|
-
:member_accounts_enrolled
|
1558
|
+
:member_accounts_enrolled,
|
1559
|
+
:last_updated_timestamp,
|
1560
|
+
:number_of_member_accounts_opted_in)
|
1561
|
+
SENSITIVE = []
|
1562
|
+
include Aws::Structure
|
1563
|
+
end
|
1564
|
+
|
1565
|
+
# @note When making an API call, you may pass GetEnrollmentStatusesForOrganizationRequest
|
1566
|
+
# data as a hash:
|
1567
|
+
#
|
1568
|
+
# {
|
1569
|
+
# filters: [
|
1570
|
+
# {
|
1571
|
+
# name: "Status", # accepts Status
|
1572
|
+
# values: ["FilterValue"],
|
1573
|
+
# },
|
1574
|
+
# ],
|
1575
|
+
# next_token: "NextToken",
|
1576
|
+
# max_results: 1,
|
1577
|
+
# }
|
1578
|
+
#
|
1579
|
+
# @!attribute [rw] filters
|
1580
|
+
# An array of objects to specify a filter that returns a more specific
|
1581
|
+
# list of account enrollment statuses.
|
1582
|
+
# @return [Array<Types::EnrollmentFilter>]
|
1583
|
+
#
|
1584
|
+
# @!attribute [rw] next_token
|
1585
|
+
# The token to advance to the next page of account enrollment
|
1586
|
+
# statuses.
|
1587
|
+
# @return [String]
|
1588
|
+
#
|
1589
|
+
# @!attribute [rw] max_results
|
1590
|
+
# The maximum number of account enrollment statuses to return with a
|
1591
|
+
# single request. You can specify up to 100 statuses to return with
|
1592
|
+
# each request.
|
1593
|
+
#
|
1594
|
+
# To retrieve the remaining results, make another request with the
|
1595
|
+
# returned `nextToken` value.
|
1596
|
+
# @return [Integer]
|
1597
|
+
#
|
1598
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/GetEnrollmentStatusesForOrganizationRequest AWS API Documentation
|
1599
|
+
#
|
1600
|
+
class GetEnrollmentStatusesForOrganizationRequest < Struct.new(
|
1601
|
+
:filters,
|
1602
|
+
:next_token,
|
1603
|
+
:max_results)
|
1604
|
+
SENSITIVE = []
|
1605
|
+
include Aws::Structure
|
1606
|
+
end
|
1607
|
+
|
1608
|
+
# @!attribute [rw] account_enrollment_statuses
|
1609
|
+
# An array of objects that describe the enrollment statuses of
|
1610
|
+
# organization member accounts.
|
1611
|
+
# @return [Array<Types::AccountEnrollmentStatus>]
|
1612
|
+
#
|
1613
|
+
# @!attribute [rw] next_token
|
1614
|
+
# The token to use to advance to the next page of account enrollment
|
1615
|
+
# statuses.
|
1616
|
+
#
|
1617
|
+
# This value is null when there are no more pages of account
|
1618
|
+
# enrollment statuses to return.
|
1619
|
+
# @return [String]
|
1620
|
+
#
|
1621
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/GetEnrollmentStatusesForOrganizationResponse AWS API Documentation
|
1622
|
+
#
|
1623
|
+
class GetEnrollmentStatusesForOrganizationResponse < Struct.new(
|
1624
|
+
:account_enrollment_statuses,
|
1625
|
+
:next_token)
|
1435
1626
|
SENSITIVE = []
|
1436
1627
|
include Aws::Structure
|
1437
1628
|
end
|
@@ -1462,8 +1653,7 @@ module Aws::ComputeOptimizer
|
|
1462
1653
|
# the function. If you specify a qualified ARN with a version suffix,
|
1463
1654
|
# Compute Optimizer will return recommendations for the specified
|
1464
1655
|
# function version. For more information about using function
|
1465
|
-
# versions, see [Using versions][1] in the *
|
1466
|
-
# Guide*.
|
1656
|
+
# versions, see [Using versions][1] in the *Lambda Developer Guide*.
|
1467
1657
|
#
|
1468
1658
|
#
|
1469
1659
|
#
|
@@ -1471,8 +1661,8 @@ module Aws::ComputeOptimizer
|
|
1471
1661
|
# @return [Array<String>]
|
1472
1662
|
#
|
1473
1663
|
# @!attribute [rw] account_ids
|
1474
|
-
# The ID of the
|
1475
|
-
# recommendations.
|
1664
|
+
# The ID of the Amazon Web Services account for which to return
|
1665
|
+
# function recommendations.
|
1476
1666
|
#
|
1477
1667
|
# If your account is the management account of an organization, use
|
1478
1668
|
# this parameter to specify the member account for which you want to
|
@@ -1482,8 +1672,8 @@ module Aws::ComputeOptimizer
|
|
1482
1672
|
# @return [Array<String>]
|
1483
1673
|
#
|
1484
1674
|
# @!attribute [rw] filters
|
1485
|
-
# An array of objects
|
1486
|
-
#
|
1675
|
+
# An array of objects to specify a filter that returns a more specific
|
1676
|
+
# list of function recommendations.
|
1487
1677
|
# @return [Array<Types::LambdaFunctionRecommendationFilter>]
|
1488
1678
|
#
|
1489
1679
|
# @!attribute [rw] next_token
|
@@ -1495,7 +1685,7 @@ module Aws::ComputeOptimizer
|
|
1495
1685
|
# single request.
|
1496
1686
|
#
|
1497
1687
|
# To retrieve the remaining results, make another request with the
|
1498
|
-
# returned `
|
1688
|
+
# returned `nextToken` value.
|
1499
1689
|
# @return [Integer]
|
1500
1690
|
#
|
1501
1691
|
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/GetLambdaFunctionRecommendationsRequest AWS API Documentation
|
@@ -1569,8 +1759,8 @@ module Aws::ComputeOptimizer
|
|
1569
1759
|
# }
|
1570
1760
|
#
|
1571
1761
|
# @!attribute [rw] account_ids
|
1572
|
-
# The ID of the
|
1573
|
-
# summaries.
|
1762
|
+
# The ID of the Amazon Web Services account for which to return
|
1763
|
+
# recommendation summaries.
|
1574
1764
|
#
|
1575
1765
|
# If your account is the management account of an organization, use
|
1576
1766
|
# this parameter to specify the member account for which you want to
|
@@ -1588,7 +1778,7 @@ module Aws::ComputeOptimizer
|
|
1588
1778
|
# single request.
|
1589
1779
|
#
|
1590
1780
|
# To retrieve the remaining results, make another request with the
|
1591
|
-
# returned `
|
1781
|
+
# returned `nextToken` value.
|
1592
1782
|
# @return [Integer]
|
1593
1783
|
#
|
1594
1784
|
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/GetRecommendationSummariesRequest AWS API Documentation
|
@@ -1629,7 +1819,7 @@ module Aws::ComputeOptimizer
|
|
1629
1819
|
# @return [String]
|
1630
1820
|
#
|
1631
1821
|
# @!attribute [rw] account_id
|
1632
|
-
# The
|
1822
|
+
# The Amazon Web Services account ID of the instance.
|
1633
1823
|
# @return [String]
|
1634
1824
|
#
|
1635
1825
|
# @!attribute [rw] instance_name
|
@@ -1661,7 +1851,7 @@ module Aws::ComputeOptimizer
|
|
1661
1851
|
# * <b> <code>Optimized</code> </b>—An instance is considered
|
1662
1852
|
# optimized when all specifications of your instance, such as CPU,
|
1663
1853
|
# memory, and network, meet the performance requirements of your
|
1664
|
-
# workload and is not over provisioned. For optimized resources,
|
1854
|
+
# workload and is not over provisioned. For optimized resources,
|
1665
1855
|
# Compute Optimizer might recommend a new generation instance type.
|
1666
1856
|
# @return [String]
|
1667
1857
|
#
|
@@ -1699,7 +1889,7 @@ module Aws::ComputeOptimizer
|
|
1699
1889
|
# <note markdown="1"> Memory utilization is analyzed only for resources that have the
|
1700
1890
|
# unified CloudWatch agent installed on them. For more information,
|
1701
1891
|
# see [Enabling memory utilization with the Amazon CloudWatch
|
1702
|
-
# Agent][1] in the *
|
1892
|
+
# Agent][1] in the *Compute Optimizer User Guide*. On Linux
|
1703
1893
|
# instances, Compute Optimizer analyses the `mem_used_percent`
|
1704
1894
|
# metric in the `CWAgent` namespace, or the legacy
|
1705
1895
|
# `MemoryUtilization` metric in the `System/Linux` namespace. On
|
@@ -1832,7 +2022,7 @@ module Aws::ComputeOptimizer
|
|
1832
2022
|
# @return [Array<Types::RecommendationSource>]
|
1833
2023
|
#
|
1834
2024
|
# @!attribute [rw] last_refresh_timestamp
|
1835
|
-
# The
|
2025
|
+
# The timestamp of when the instance recommendation was last
|
1836
2026
|
# refreshed.
|
1837
2027
|
# @return [Time]
|
1838
2028
|
#
|
@@ -1904,12 +2094,12 @@ module Aws::ComputeOptimizer
|
|
1904
2094
|
# current instance. For example, the recommended instance type
|
1905
2095
|
# supports enhanced networking and the current instance might not.
|
1906
2096
|
# To enable enhanced networking for the recommended instance type,
|
1907
|
-
# you
|
1908
|
-
#
|
1909
|
-
#
|
1910
|
-
#
|
1911
|
-
#
|
1912
|
-
#
|
2097
|
+
# you must install the Elastic Network Adapter (ENA) driver or the
|
2098
|
+
# Intel 82599 Virtual Function driver. For more information, see
|
2099
|
+
# [Networking and storage features][6] and [Enhanced networking on
|
2100
|
+
# Linux][7] in the *Amazon EC2 User Guide for Linux*, or [Networking
|
2101
|
+
# and storage features][8] and [Enhanced networking on Windows][9]
|
2102
|
+
# in the *Amazon EC2 User Guide for Windows*.
|
1913
2103
|
#
|
1914
2104
|
# * <b> <code>StorageInterface</code> </b> — The storage interface of
|
1915
2105
|
# the recommended instance type is different than that of the
|
@@ -1929,11 +2119,11 @@ module Aws::ComputeOptimizer
|
|
1929
2119
|
# the data on your instance store volumes if you want to preserve
|
1930
2120
|
# them. For more information, see [How do I back up an instance
|
1931
2121
|
# store volume on my Amazon EC2 instance to Amazon EBS?][12] in the
|
1932
|
-
# *
|
1933
|
-
# [Networking and storage features][6] and [Amazon
|
1934
|
-
# store][13] in the *Amazon EC2 User Guide for Linux*,
|
1935
|
-
# [Networking and storage features][8] and [Amazon EC2
|
1936
|
-
# store][14] in the *Amazon EC2 User Guide for Windows*.
|
2122
|
+
# *Amazon Web Services Premium Support Knowledge Base*. For more
|
2123
|
+
# information, see [Networking and storage features][6] and [Amazon
|
2124
|
+
# EC2 instance store][13] in the *Amazon EC2 User Guide for Linux*,
|
2125
|
+
# or see [Networking and storage features][8] and [Amazon EC2
|
2126
|
+
# instance store][14] in the *Amazon EC2 User Guide for Windows*.
|
1937
2127
|
#
|
1938
2128
|
# * <b> <code>VirtualizationType</code> </b> — The recommended
|
1939
2129
|
# instance type uses the hardware virtual machine (HVM)
|
@@ -1944,6 +2134,17 @@ module Aws::ComputeOptimizer
|
|
1944
2134
|
# Linux*, or [Windows AMI virtualization types][16] in the *Amazon
|
1945
2135
|
# EC2 User Guide for Windows*.
|
1946
2136
|
#
|
2137
|
+
# * <b> <code>Architecture</code> </b> — The CPU architecture between
|
2138
|
+
# the recommended instance type and the current instance is
|
2139
|
+
# different. For example, the recommended instance type might use an
|
2140
|
+
# Arm CPU architecture and the current instance type might use a
|
2141
|
+
# different one, such as x86. Before migrating, you should consider
|
2142
|
+
# recompiling the software on your instance for the new
|
2143
|
+
# architecture. Alternatively, you might switch to an Amazon Machine
|
2144
|
+
# Image (AMI) that supports the new architecture. For more
|
2145
|
+
# information about the CPU architecture for each instance type, see
|
2146
|
+
# [Amazon EC2 Instance Types][17].
|
2147
|
+
#
|
1947
2148
|
#
|
1948
2149
|
#
|
1949
2150
|
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-resize.html
|
@@ -1962,6 +2163,7 @@ module Aws::ComputeOptimizer
|
|
1962
2163
|
# [14]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/InstanceStorage.html
|
1963
2164
|
# [15]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/virtualization_types.html
|
1964
2165
|
# [16]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/windows-ami-version-history.html#virtualization-types
|
2166
|
+
# [17]: http://aws.amazon.com/ec2/instance-types/
|
1965
2167
|
# @return [Array<String>]
|
1966
2168
|
#
|
1967
2169
|
# @!attribute [rw] performance_risk
|
@@ -2014,7 +2216,8 @@ module Aws::ComputeOptimizer
|
|
2014
2216
|
include Aws::Structure
|
2015
2217
|
end
|
2016
2218
|
|
2017
|
-
#
|
2219
|
+
# The value supplied for the input parameter is out of range or not
|
2220
|
+
# valid.
|
2018
2221
|
#
|
2019
2222
|
# @!attribute [rw] message
|
2020
2223
|
# @return [String]
|
@@ -2028,14 +2231,14 @@ module Aws::ComputeOptimizer
|
|
2028
2231
|
end
|
2029
2232
|
|
2030
2233
|
# Describes a filter that returns a more specific list of recommendation
|
2031
|
-
# export jobs. Use this filter with the
|
2032
|
-
#
|
2234
|
+
# export jobs. Use this filter with the DescribeRecommendationExportJobs
|
2235
|
+
# action.
|
2033
2236
|
#
|
2034
|
-
# You can use `EBSFilter` with the
|
2237
|
+
# You can use `EBSFilter` with the GetEBSVolumeRecommendations action,
|
2035
2238
|
# `LambdaFunctionRecommendationFilter` with the
|
2036
|
-
#
|
2037
|
-
#
|
2038
|
-
#
|
2239
|
+
# GetLambdaFunctionRecommendations action, and `Filter` with the
|
2240
|
+
# GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations
|
2241
|
+
# actions.
|
2039
2242
|
#
|
2040
2243
|
# @note When making an API call, you may pass JobFilter
|
2041
2244
|
# data as a hash:
|
@@ -2049,7 +2252,7 @@ module Aws::ComputeOptimizer
|
|
2049
2252
|
# The name of the filter.
|
2050
2253
|
#
|
2051
2254
|
# Specify `ResourceType` to return export jobs of a specific resource
|
2052
|
-
# type (
|
2255
|
+
# type (for example, `Ec2Instance`).
|
2053
2256
|
#
|
2054
2257
|
# Specify `JobStatus` to return export jobs with a specific status
|
2055
2258
|
# (e.g, `Complete`).
|
@@ -2079,7 +2282,7 @@ module Aws::ComputeOptimizer
|
|
2079
2282
|
include Aws::Structure
|
2080
2283
|
end
|
2081
2284
|
|
2082
|
-
# Describes a projected utilization metric of an
|
2285
|
+
# Describes a projected utilization metric of an Lambda function
|
2083
2286
|
# recommendation option.
|
2084
2287
|
#
|
2085
2288
|
# @!attribute [rw] name
|
@@ -2104,7 +2307,7 @@ module Aws::ComputeOptimizer
|
|
2104
2307
|
include Aws::Structure
|
2105
2308
|
end
|
2106
2309
|
|
2107
|
-
# Describes a recommendation option for an
|
2310
|
+
# Describes a recommendation option for an Lambda function.
|
2108
2311
|
#
|
2109
2312
|
# @!attribute [rw] rank
|
2110
2313
|
# The rank of the function recommendation option.
|
@@ -2131,7 +2334,7 @@ module Aws::ComputeOptimizer
|
|
2131
2334
|
include Aws::Structure
|
2132
2335
|
end
|
2133
2336
|
|
2134
|
-
# Describes an
|
2337
|
+
# Describes an Lambda function recommendation.
|
2135
2338
|
#
|
2136
2339
|
# @!attribute [rw] function_arn
|
2137
2340
|
# The Amazon Resource Name (ARN) of the current function.
|
@@ -2142,7 +2345,7 @@ module Aws::ComputeOptimizer
|
|
2142
2345
|
# @return [String]
|
2143
2346
|
#
|
2144
2347
|
# @!attribute [rw] account_id
|
2145
|
-
# The
|
2348
|
+
# The Amazon Web Services account ID of the function.
|
2146
2349
|
# @return [String]
|
2147
2350
|
#
|
2148
2351
|
# @!attribute [rw] current_memory_size
|
@@ -2151,7 +2354,7 @@ module Aws::ComputeOptimizer
|
|
2151
2354
|
# @return [Integer]
|
2152
2355
|
#
|
2153
2356
|
# @!attribute [rw] number_of_invocations
|
2154
|
-
# The number of times your function code was
|
2357
|
+
# The number of times your function code was applied during the
|
2155
2358
|
# look-back period.
|
2156
2359
|
# @return [Integer]
|
2157
2360
|
#
|
@@ -2166,7 +2369,7 @@ module Aws::ComputeOptimizer
|
|
2166
2369
|
# @return [Float]
|
2167
2370
|
#
|
2168
2371
|
# @!attribute [rw] last_refresh_timestamp
|
2169
|
-
# The
|
2372
|
+
# The timestamp of when the function recommendation was last
|
2170
2373
|
# refreshed.
|
2171
2374
|
# @return [Time]
|
2172
2375
|
#
|
@@ -2230,8 +2433,8 @@ module Aws::ComputeOptimizer
|
|
2230
2433
|
# * <b> <code>InsufficientData</code> </b> — The function does not
|
2231
2434
|
# have sufficient metric data for Compute Optimizer to generate a
|
2232
2435
|
# recommendation. For more information, see the [Supported resources
|
2233
|
-
# and requirements][1] in the *
|
2234
|
-
#
|
2436
|
+
# and requirements][1] in the *Compute Optimizer User Guide*. This
|
2437
|
+
# finding reason code is part of the `Unavailable` finding
|
2235
2438
|
# classification.
|
2236
2439
|
#
|
2237
2440
|
# * <b> <code>Inconclusive</code> </b> — The function does not qualify
|
@@ -2267,14 +2470,14 @@ module Aws::ComputeOptimizer
|
|
2267
2470
|
include Aws::Structure
|
2268
2471
|
end
|
2269
2472
|
|
2270
|
-
# Describes a filter that returns a more specific list of
|
2473
|
+
# Describes a filter that returns a more specific list of Lambda
|
2271
2474
|
# function recommendations. Use this filter with the
|
2272
|
-
#
|
2475
|
+
# GetLambdaFunctionRecommendations action.
|
2273
2476
|
#
|
2274
|
-
# You can use `EBSFilter` with the
|
2275
|
-
# `JobFilter` with the
|
2276
|
-
# `Filter` with the
|
2277
|
-
#
|
2477
|
+
# You can use `EBSFilter` with the GetEBSVolumeRecommendations action,
|
2478
|
+
# `JobFilter` with the DescribeRecommendationExportJobs action, and
|
2479
|
+
# `Filter` with the GetAutoScalingGroupRecommendations and
|
2480
|
+
# GetEC2InstanceRecommendations actions.
|
2278
2481
|
#
|
2279
2482
|
# @note When making an API call, you may pass LambdaFunctionRecommendationFilter
|
2280
2483
|
# data as a hash:
|
@@ -2288,10 +2491,11 @@ module Aws::ComputeOptimizer
|
|
2288
2491
|
# The name of the filter.
|
2289
2492
|
#
|
2290
2493
|
# Specify `Finding` to return recommendations with a specific finding
|
2291
|
-
# classification (
|
2494
|
+
# classification (for example, `NotOptimized`).
|
2292
2495
|
#
|
2293
2496
|
# Specify `FindingReasonCode` to return recommendations with a
|
2294
|
-
# specific finding reason code (
|
2497
|
+
# specific finding reason code (for example,
|
2498
|
+
# `MemoryUnderprovisioned`).
|
2295
2499
|
# @return [String]
|
2296
2500
|
#
|
2297
2501
|
# @!attribute [rw] values
|
@@ -2317,7 +2521,7 @@ module Aws::ComputeOptimizer
|
|
2317
2521
|
include Aws::Structure
|
2318
2522
|
end
|
2319
2523
|
|
2320
|
-
# Describes a utilization metric of an
|
2524
|
+
# Describes a utilization metric of an Lambda function.
|
2321
2525
|
#
|
2322
2526
|
# @!attribute [rw] name
|
2323
2527
|
# The name of the utilization metric.
|
@@ -2333,17 +2537,17 @@ module Aws::ComputeOptimizer
|
|
2333
2537
|
# @!attribute [rw] statistic
|
2334
2538
|
# The statistic of the utilization metric.
|
2335
2539
|
#
|
2336
|
-
# The Compute Optimizer API,
|
2337
|
-
#
|
2338
|
-
#
|
2540
|
+
# The Compute Optimizer API, Command Line Interface (CLI), and SDKs
|
2541
|
+
# return utilization metrics using only the `Maximum` statistic, which
|
2542
|
+
# is the highest value observed during the specified period.
|
2339
2543
|
#
|
2340
2544
|
# The Compute Optimizer console displays graphs for some utilization
|
2341
2545
|
# metrics using the `Average` statistic, which is the value of `Sum` /
|
2342
2546
|
# `SampleCount` during the specified period. For more information, see
|
2343
|
-
# [Viewing resource recommendations][1] in the *
|
2344
|
-
#
|
2345
|
-
#
|
2346
|
-
#
|
2547
|
+
# [Viewing resource recommendations][1] in the *Compute Optimizer User
|
2548
|
+
# Guide*. You can also get averaged utilization metric data for your
|
2549
|
+
# resources using Amazon CloudWatch. For more information, see the
|
2550
|
+
# [Amazon CloudWatch User Guide][2].
|
2347
2551
|
#
|
2348
2552
|
#
|
2349
2553
|
#
|
@@ -2378,8 +2582,8 @@ module Aws::ComputeOptimizer
|
|
2378
2582
|
include Aws::Structure
|
2379
2583
|
end
|
2380
2584
|
|
2381
|
-
# The request must contain either a valid (registered)
|
2382
|
-
# or X.509 certificate.
|
2585
|
+
# The request must contain either a valid (registered) Amazon Web
|
2586
|
+
# Services access key ID or X.509 certificate.
|
2383
2587
|
#
|
2384
2588
|
# @!attribute [rw] message
|
2385
2589
|
# @return [String]
|
@@ -2392,7 +2596,7 @@ module Aws::ComputeOptimizer
|
|
2392
2596
|
include Aws::Structure
|
2393
2597
|
end
|
2394
2598
|
|
2395
|
-
# The account is not opted in to
|
2599
|
+
# The account is not opted in to Compute Optimizer.
|
2396
2600
|
#
|
2397
2601
|
# @!attribute [rw] message
|
2398
2602
|
# @return [String]
|
@@ -2415,11 +2619,11 @@ module Aws::ComputeOptimizer
|
|
2415
2619
|
# difference between your current resource and the recommended option.
|
2416
2620
|
#
|
2417
2621
|
# <note markdown="1"> The `Cpu` and `Memory` metrics are the only projected utilization
|
2418
|
-
# metrics returned when you run the
|
2419
|
-
#
|
2420
|
-
#
|
2421
|
-
#
|
2422
|
-
#
|
2622
|
+
# metrics returned when you run the GetEC2RecommendationProjectedMetrics
|
2623
|
+
# action. Additionally, the `Memory` metric is returned only for
|
2624
|
+
# resources that have the unified CloudWatch agent installed on them.
|
2625
|
+
# For more information, see [Enabling Memory Utilization with the
|
2626
|
+
# CloudWatch Agent][1].
|
2423
2627
|
#
|
2424
2628
|
# </note>
|
2425
2629
|
#
|
@@ -2463,7 +2667,7 @@ module Aws::ComputeOptimizer
|
|
2463
2667
|
# @return [String]
|
2464
2668
|
#
|
2465
2669
|
# @!attribute [rw] timestamps
|
2466
|
-
# The
|
2670
|
+
# The timestamps of the projected utilization metric.
|
2467
2671
|
# @return [Array<Time>]
|
2468
2672
|
#
|
2469
2673
|
# @!attribute [rw] values
|
@@ -2501,12 +2705,12 @@ module Aws::ComputeOptimizer
|
|
2501
2705
|
|
2502
2706
|
# Describes a recommendation export job.
|
2503
2707
|
#
|
2504
|
-
# Use the
|
2708
|
+
# Use the DescribeRecommendationExportJobs action to view your
|
2505
2709
|
# recommendation export jobs.
|
2506
2710
|
#
|
2507
|
-
# Use the
|
2508
|
-
#
|
2509
|
-
#
|
2711
|
+
# Use the ExportAutoScalingGroupRecommendations or
|
2712
|
+
# ExportEC2InstanceRecommendations actions to request an export of your
|
2713
|
+
# recommendations.
|
2510
2714
|
#
|
2511
2715
|
# @!attribute [rw] job_id
|
2512
2716
|
# The identification number of the export job.
|
@@ -2550,6 +2754,44 @@ module Aws::ComputeOptimizer
|
|
2550
2754
|
include Aws::Structure
|
2551
2755
|
end
|
2552
2756
|
|
2757
|
+
# Describes preferences for recommendations.
|
2758
|
+
#
|
2759
|
+
# @note When making an API call, you may pass RecommendationPreferences
|
2760
|
+
# data as a hash:
|
2761
|
+
#
|
2762
|
+
# {
|
2763
|
+
# cpu_vendor_architectures: ["AWS_ARM64"], # accepts AWS_ARM64, CURRENT
|
2764
|
+
# }
|
2765
|
+
#
|
2766
|
+
# @!attribute [rw] cpu_vendor_architectures
|
2767
|
+
# Specifies the CPU vendor and architecture for Amazon EC2 instance
|
2768
|
+
# and Auto Scaling group recommendations.
|
2769
|
+
#
|
2770
|
+
# For example, when you specify `AWS_ARM64` with:
|
2771
|
+
#
|
2772
|
+
# * A GetEC2InstanceRecommendations or
|
2773
|
+
# GetAutoScalingGroupRecommendations request, Compute Optimizer
|
2774
|
+
# returns recommendations that consist of Graviton2 instance types
|
2775
|
+
# only.
|
2776
|
+
#
|
2777
|
+
# * A GetEC2RecommendationProjectedMetrics request, Compute Optimizer
|
2778
|
+
# returns projected utilization metrics for Graviton2 instance type
|
2779
|
+
# recommendations only.
|
2780
|
+
#
|
2781
|
+
# * A ExportEC2InstanceRecommendations or
|
2782
|
+
# ExportAutoScalingGroupRecommendations request, Compute Optimizer
|
2783
|
+
# exports recommendations that consist of Graviton2 instance types
|
2784
|
+
# only.
|
2785
|
+
# @return [Array<String>]
|
2786
|
+
#
|
2787
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/RecommendationPreferences AWS API Documentation
|
2788
|
+
#
|
2789
|
+
class RecommendationPreferences < Struct.new(
|
2790
|
+
:cpu_vendor_architectures)
|
2791
|
+
SENSITIVE = []
|
2792
|
+
include Aws::Structure
|
2793
|
+
end
|
2794
|
+
|
2553
2795
|
# Describes the source of a recommendation, such as an Amazon EC2
|
2554
2796
|
# instance or Auto Scaling group.
|
2555
2797
|
#
|
@@ -2581,7 +2823,7 @@ module Aws::ComputeOptimizer
|
|
2581
2823
|
# @return [String]
|
2582
2824
|
#
|
2583
2825
|
# @!attribute [rw] account_id
|
2584
|
-
# The
|
2826
|
+
# The Amazon Web Services account ID of the recommendation summary.
|
2585
2827
|
# @return [String]
|
2586
2828
|
#
|
2587
2829
|
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/RecommendationSummary AWS API Documentation
|
@@ -2597,11 +2839,11 @@ module Aws::ComputeOptimizer
|
|
2597
2839
|
# Describes a projected utilization metric of a recommendation option.
|
2598
2840
|
#
|
2599
2841
|
# <note markdown="1"> The `Cpu` and `Memory` metrics are the only projected utilization
|
2600
|
-
# metrics returned when you run the
|
2601
|
-
#
|
2602
|
-
#
|
2603
|
-
#
|
2604
|
-
#
|
2842
|
+
# metrics returned when you run the GetEC2RecommendationProjectedMetrics
|
2843
|
+
# action. Additionally, the `Memory` metric is returned only for
|
2844
|
+
# resources that have the unified CloudWatch agent installed on them.
|
2845
|
+
# For more information, see [Enabling Memory Utilization with the
|
2846
|
+
# CloudWatch Agent][1].
|
2605
2847
|
#
|
2606
2848
|
# </note>
|
2607
2849
|
#
|
@@ -2695,7 +2937,7 @@ module Aws::ComputeOptimizer
|
|
2695
2937
|
# specify an object prefix when you create the export job, you must
|
2696
2938
|
# include the object prefix in the policy that you add to the S3 bucket.
|
2697
2939
|
# For more information, see [Amazon S3 Bucket Policy for Compute
|
2698
|
-
# Optimizer][1] in the *Compute Optimizer
|
2940
|
+
# Optimizer][1] in the *Compute Optimizer User Guide*.
|
2699
2941
|
#
|
2700
2942
|
#
|
2701
2943
|
#
|
@@ -2792,9 +3034,9 @@ module Aws::ComputeOptimizer
|
|
2792
3034
|
#
|
2793
3035
|
# * `Active` - Opts in your account to the Compute Optimizer service.
|
2794
3036
|
# Compute Optimizer begins analyzing the configuration and
|
2795
|
-
# utilization metrics of your
|
2796
|
-
# more information, see [Metrics analyzed by
|
2797
|
-
# Optimizer][1] in the *
|
3037
|
+
# utilization metrics of your Amazon Web Services resources after
|
3038
|
+
# you opt in. For more information, see [Metrics analyzed by Compute
|
3039
|
+
# Optimizer][1] in the *Compute Optimizer User Guide*.
|
2798
3040
|
#
|
2799
3041
|
# * `Inactive` - Opts out your account from the Compute Optimizer
|
2800
3042
|
# service. Your account's recommendations and related metrics data
|
@@ -2958,17 +3200,17 @@ module Aws::ComputeOptimizer
|
|
2958
3200
|
# @!attribute [rw] statistic
|
2959
3201
|
# The statistic of the utilization metric.
|
2960
3202
|
#
|
2961
|
-
# The Compute Optimizer API,
|
2962
|
-
#
|
2963
|
-
#
|
3203
|
+
# The Compute Optimizer API, Command Line Interface (CLI), and SDKs
|
3204
|
+
# return utilization metrics using only the `Maximum` statistic, which
|
3205
|
+
# is the highest value observed during the specified period.
|
2964
3206
|
#
|
2965
3207
|
# The Compute Optimizer console displays graphs for some utilization
|
2966
3208
|
# metrics using the `Average` statistic, which is the value of `Sum` /
|
2967
3209
|
# `SampleCount` during the specified period. For more information, see
|
2968
|
-
# [Viewing resource recommendations][1] in the *
|
2969
|
-
#
|
2970
|
-
#
|
2971
|
-
#
|
3210
|
+
# [Viewing resource recommendations][1] in the *Compute Optimizer User
|
3211
|
+
# Guide*. You can also get averaged utilization metric data for your
|
3212
|
+
# resources using Amazon CloudWatch. For more information, see the
|
3213
|
+
# [Amazon CloudWatch User Guide][2].
|
2972
3214
|
#
|
2973
3215
|
#
|
2974
3216
|
#
|
@@ -3042,7 +3284,7 @@ module Aws::ComputeOptimizer
|
|
3042
3284
|
# @return [String]
|
3043
3285
|
#
|
3044
3286
|
# @!attribute [rw] account_id
|
3045
|
-
# The
|
3287
|
+
# The Amazon Web Services account ID of the volume.
|
3046
3288
|
# @return [String]
|
3047
3289
|
#
|
3048
3290
|
# @!attribute [rw] current_configuration
|
@@ -3056,8 +3298,8 @@ module Aws::ComputeOptimizer
|
|
3056
3298
|
# Findings for volumes include:
|
3057
3299
|
#
|
3058
3300
|
# * <b> <code>NotOptimized</code> </b>—A volume is considered not
|
3059
|
-
# optimized when
|
3060
|
-
#
|
3301
|
+
# optimized when Compute Optimizer identifies a recommendation that
|
3302
|
+
# can provide better performance for your workload.
|
3061
3303
|
#
|
3062
3304
|
# * <b> <code>Optimized</code> </b>—An volume is considered optimized
|
3063
3305
|
# when Compute Optimizer determines that the volume is correctly
|
@@ -3082,7 +3324,7 @@ module Aws::ComputeOptimizer
|
|
3082
3324
|
# @return [Array<Types::VolumeRecommendationOption>]
|
3083
3325
|
#
|
3084
3326
|
# @!attribute [rw] last_refresh_timestamp
|
3085
|
-
# The
|
3327
|
+
# The timestamp of when the volume recommendation was last refreshed.
|
3086
3328
|
# @return [Time]
|
3087
3329
|
#
|
3088
3330
|
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/VolumeRecommendation AWS API Documentation
|