aws-sdk-computeoptimizer 1.5.0 → 1.10.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/lib/aws-sdk-computeoptimizer.rb +3 -2
- data/lib/aws-sdk-computeoptimizer/client.rb +184 -46
- data/lib/aws-sdk-computeoptimizer/client_api.rb +92 -0
- data/lib/aws-sdk-computeoptimizer/types.rb +529 -55
- metadata +4 -4
@@ -84,11 +84,6 @@ module Aws::ComputeOptimizer
|
|
84
84
|
# group is correctly provisioned to run your workload based on the
|
85
85
|
# chosen instance type. For optimized resources, Compute Optimizer
|
86
86
|
# might recommend a new generation instance type.
|
87
|
-
#
|
88
|
-
# <note markdown="1"> The values that are returned might be `NOT_OPTIMIZED` or
|
89
|
-
# `OPTIMIZED`.
|
90
|
-
#
|
91
|
-
# </note>
|
92
87
|
# @return [String]
|
93
88
|
#
|
94
89
|
# @!attribute [rw] utilization_metrics
|
@@ -142,6 +137,18 @@ module Aws::ComputeOptimizer
|
|
142
137
|
# @!attribute [rw] projected_utilization_metrics
|
143
138
|
# An array of objects that describe the projected utilization metrics
|
144
139
|
# of the Auto Scaling group recommendation option.
|
140
|
+
#
|
141
|
+
# <note markdown="1"> The `Cpu` and `Memory` metrics are the only projected utilization
|
142
|
+
# metrics returned. Additionally, the `Memory` metric is returned only
|
143
|
+
# for resources that have the unified CloudWatch agent installed on
|
144
|
+
# them. For more information, see [Enabling Memory Utilization with
|
145
|
+
# the CloudWatch Agent][1].
|
146
|
+
#
|
147
|
+
# </note>
|
148
|
+
#
|
149
|
+
#
|
150
|
+
#
|
151
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent
|
145
152
|
# @return [Array<Types::UtilizationMetric>]
|
146
153
|
#
|
147
154
|
# @!attribute [rw] performance_risk
|
@@ -245,6 +252,102 @@ module Aws::ComputeOptimizer
|
|
245
252
|
include Aws::Structure
|
246
253
|
end
|
247
254
|
|
255
|
+
# Describes a filter that returns a more specific list of Amazon Elastic
|
256
|
+
# Block Store (Amazon EBS) volume recommendations.
|
257
|
+
#
|
258
|
+
# This filter is used with the `GetEBSVolumeRecommendations` action.
|
259
|
+
#
|
260
|
+
# @note When making an API call, you may pass EBSFilter
|
261
|
+
# data as a hash:
|
262
|
+
#
|
263
|
+
# {
|
264
|
+
# name: "Finding", # accepts Finding
|
265
|
+
# values: ["FilterValue"],
|
266
|
+
# }
|
267
|
+
#
|
268
|
+
# @!attribute [rw] name
|
269
|
+
# The name of the filter.
|
270
|
+
#
|
271
|
+
# Specify `Finding` to return recommendations with a specific finding
|
272
|
+
# classification (e.g., `Optimized`).
|
273
|
+
# @return [String]
|
274
|
+
#
|
275
|
+
# @!attribute [rw] values
|
276
|
+
# The value of the filter.
|
277
|
+
#
|
278
|
+
# The valid values are `Optimized`, or `NotOptimized`.
|
279
|
+
# @return [Array<String>]
|
280
|
+
#
|
281
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/EBSFilter AWS API Documentation
|
282
|
+
#
|
283
|
+
class EBSFilter < Struct.new(
|
284
|
+
:name,
|
285
|
+
:values)
|
286
|
+
SENSITIVE = []
|
287
|
+
include Aws::Structure
|
288
|
+
end
|
289
|
+
|
290
|
+
# Describes a utilization metric of an Amazon Elastic Block Store
|
291
|
+
# (Amazon EBS) volume.
|
292
|
+
#
|
293
|
+
# Compare the utilization metric data of your resource against its
|
294
|
+
# projected utilization metric data to determine the performance
|
295
|
+
# difference between your current resource and the recommended option.
|
296
|
+
#
|
297
|
+
# @!attribute [rw] name
|
298
|
+
# The name of the utilization metric.
|
299
|
+
#
|
300
|
+
# The following utilization metrics are available:
|
301
|
+
#
|
302
|
+
# * `VolumeReadOpsPerSecond` - The completed read operations per
|
303
|
+
# second from the volume in a specified period of time.
|
304
|
+
#
|
305
|
+
# Unit: Count
|
306
|
+
#
|
307
|
+
# * `VolumeWriteOpsPerSecond` - The completed write operations per
|
308
|
+
# second to the volume in a specified period of time.
|
309
|
+
#
|
310
|
+
# Unit: Count
|
311
|
+
#
|
312
|
+
# * `VolumeReadBytesPerSecond` - The bytes read per second from the
|
313
|
+
# volume in a specified period of time.
|
314
|
+
#
|
315
|
+
# Unit: Bytes
|
316
|
+
#
|
317
|
+
# * `VolumeWriteBytesPerSecond` - The bytes written to the volume in a
|
318
|
+
# specified period of time.
|
319
|
+
#
|
320
|
+
# Unit: Bytes
|
321
|
+
# @return [String]
|
322
|
+
#
|
323
|
+
# @!attribute [rw] statistic
|
324
|
+
# The statistic of the utilization metric.
|
325
|
+
#
|
326
|
+
# The following statistics are available:
|
327
|
+
#
|
328
|
+
# * `Average` - This is the value of Sum / SampleCount during the
|
329
|
+
# specified period, or the average value observed during the
|
330
|
+
# specified period.
|
331
|
+
#
|
332
|
+
# * `Maximum` - The highest value observed during the specified
|
333
|
+
# period. Use this value to determine high volumes of activity for
|
334
|
+
# your application.
|
335
|
+
# @return [String]
|
336
|
+
#
|
337
|
+
# @!attribute [rw] value
|
338
|
+
# The value of the utilization metric.
|
339
|
+
# @return [Float]
|
340
|
+
#
|
341
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/EBSUtilizationMetric AWS API Documentation
|
342
|
+
#
|
343
|
+
class EBSUtilizationMetric < Struct.new(
|
344
|
+
:name,
|
345
|
+
:statistic,
|
346
|
+
:value)
|
347
|
+
SENSITIVE = []
|
348
|
+
include Aws::Structure
|
349
|
+
end
|
350
|
+
|
248
351
|
# @note When making an API call, you may pass ExportAutoScalingGroupRecommendationsRequest
|
249
352
|
# data as a hash:
|
250
353
|
#
|
@@ -256,7 +359,7 @@ module Aws::ComputeOptimizer
|
|
256
359
|
# values: ["FilterValue"],
|
257
360
|
# },
|
258
361
|
# ],
|
259
|
-
# fields_to_export: ["AccountId"], # accepts AccountId, AutoScalingGroupArn, AutoScalingGroupName, Finding, UtilizationMetricsCpuMaximum, UtilizationMetricsMemoryMaximum, LookbackPeriodInDays, CurrentConfigurationInstanceType, CurrentConfigurationDesiredCapacity, CurrentConfigurationMinSize, CurrentConfigurationMaxSize, CurrentOnDemandPrice, CurrentStandardOneYearNoUpfrontReservedPrice, CurrentStandardThreeYearNoUpfrontReservedPrice, CurrentVCpus, CurrentMemory, CurrentStorage, CurrentNetwork, RecommendationOptionsConfigurationInstanceType, RecommendationOptionsConfigurationDesiredCapacity, RecommendationOptionsConfigurationMinSize, RecommendationOptionsConfigurationMaxSize, RecommendationOptionsProjectedUtilizationMetricsCpuMaximum, RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum, RecommendationOptionsPerformanceRisk, RecommendationOptionsOnDemandPrice, RecommendationOptionsStandardOneYearNoUpfrontReservedPrice, RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice, RecommendationOptionsVcpus, RecommendationOptionsMemory, RecommendationOptionsStorage, RecommendationOptionsNetwork, LastRefreshTimestamp
|
362
|
+
# fields_to_export: ["AccountId"], # accepts AccountId, AutoScalingGroupArn, AutoScalingGroupName, Finding, UtilizationMetricsCpuMaximum, UtilizationMetricsMemoryMaximum, UtilizationMetricsEbsReadOpsPerSecondMaximum, UtilizationMetricsEbsWriteOpsPerSecondMaximum, UtilizationMetricsEbsReadBytesPerSecondMaximum, UtilizationMetricsEbsWriteBytesPerSecondMaximum, LookbackPeriodInDays, CurrentConfigurationInstanceType, CurrentConfigurationDesiredCapacity, CurrentConfigurationMinSize, CurrentConfigurationMaxSize, CurrentOnDemandPrice, CurrentStandardOneYearNoUpfrontReservedPrice, CurrentStandardThreeYearNoUpfrontReservedPrice, CurrentVCpus, CurrentMemory, CurrentStorage, CurrentNetwork, RecommendationOptionsConfigurationInstanceType, RecommendationOptionsConfigurationDesiredCapacity, RecommendationOptionsConfigurationMinSize, RecommendationOptionsConfigurationMaxSize, RecommendationOptionsProjectedUtilizationMetricsCpuMaximum, RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum, RecommendationOptionsPerformanceRisk, RecommendationOptionsOnDemandPrice, RecommendationOptionsStandardOneYearNoUpfrontReservedPrice, RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice, RecommendationOptionsVcpus, RecommendationOptionsMemory, RecommendationOptionsStorage, RecommendationOptionsNetwork, LastRefreshTimestamp
|
260
363
|
# s3_destination_config: { # required
|
261
364
|
# bucket: "DestinationBucket",
|
262
365
|
# key_prefix: "DestinationKeyPrefix",
|
@@ -269,8 +372,8 @@ module Aws::ComputeOptimizer
|
|
269
372
|
# The IDs of the AWS accounts for which to export Auto Scaling group
|
270
373
|
# recommendations.
|
271
374
|
#
|
272
|
-
# If your account is the
|
273
|
-
# parameter to specify the member accounts for which you want to
|
375
|
+
# If your account is the management account of an organization, use
|
376
|
+
# this parameter to specify the member accounts for which you want to
|
274
377
|
# export recommendations.
|
275
378
|
#
|
276
379
|
# This parameter cannot be specified together with the include member
|
@@ -289,7 +392,13 @@ module Aws::ComputeOptimizer
|
|
289
392
|
# @return [Array<Types::Filter>]
|
290
393
|
#
|
291
394
|
# @!attribute [rw] fields_to_export
|
292
|
-
# The recommendations data to include in the export file.
|
395
|
+
# The recommendations data to include in the export file. For more
|
396
|
+
# information about the fields that can be exported, see [Exported
|
397
|
+
# files][1] in the *Compute Optimizer User Guide*.
|
398
|
+
#
|
399
|
+
#
|
400
|
+
#
|
401
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files
|
293
402
|
# @return [Array<String>]
|
294
403
|
#
|
295
404
|
# @!attribute [rw] s3_destination_config
|
@@ -319,8 +428,8 @@ module Aws::ComputeOptimizer
|
|
319
428
|
#
|
320
429
|
# @!attribute [rw] include_member_accounts
|
321
430
|
# Indicates whether to include recommendations for resources in all
|
322
|
-
# member accounts of the organization if your account is the
|
323
|
-
# account of an organization.
|
431
|
+
# member accounts of the organization if your account is the
|
432
|
+
# management account of an organization.
|
324
433
|
#
|
325
434
|
# The member accounts must also be opted in to Compute Optimizer.
|
326
435
|
#
|
@@ -396,7 +505,7 @@ module Aws::ComputeOptimizer
|
|
396
505
|
# values: ["FilterValue"],
|
397
506
|
# },
|
398
507
|
# ],
|
399
|
-
# fields_to_export: ["AccountId"], # accepts AccountId, InstanceArn, InstanceName, Finding, LookbackPeriodInDays, CurrentInstanceType, UtilizationMetricsCpuMaximum, UtilizationMetricsMemoryMaximum, CurrentOnDemandPrice, CurrentStandardOneYearNoUpfrontReservedPrice, CurrentStandardThreeYearNoUpfrontReservedPrice, CurrentVCpus, CurrentMemory, CurrentStorage, CurrentNetwork, RecommendationOptionsInstanceType, RecommendationOptionsProjectedUtilizationMetricsCpuMaximum, RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum, RecommendationOptionsPerformanceRisk, RecommendationOptionsVcpus, RecommendationOptionsMemory, RecommendationOptionsStorage, RecommendationOptionsNetwork, RecommendationOptionsOnDemandPrice, RecommendationOptionsStandardOneYearNoUpfrontReservedPrice, RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice, RecommendationsSourcesRecommendationSourceArn, RecommendationsSourcesRecommendationSourceType, LastRefreshTimestamp
|
508
|
+
# fields_to_export: ["AccountId"], # accepts AccountId, InstanceArn, InstanceName, Finding, LookbackPeriodInDays, CurrentInstanceType, UtilizationMetricsCpuMaximum, UtilizationMetricsMemoryMaximum, UtilizationMetricsEbsReadOpsPerSecondMaximum, UtilizationMetricsEbsWriteOpsPerSecondMaximum, UtilizationMetricsEbsReadBytesPerSecondMaximum, UtilizationMetricsEbsWriteBytesPerSecondMaximum, CurrentOnDemandPrice, CurrentStandardOneYearNoUpfrontReservedPrice, CurrentStandardThreeYearNoUpfrontReservedPrice, CurrentVCpus, CurrentMemory, CurrentStorage, CurrentNetwork, RecommendationOptionsInstanceType, RecommendationOptionsProjectedUtilizationMetricsCpuMaximum, RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum, RecommendationOptionsPerformanceRisk, RecommendationOptionsVcpus, RecommendationOptionsMemory, RecommendationOptionsStorage, RecommendationOptionsNetwork, RecommendationOptionsOnDemandPrice, RecommendationOptionsStandardOneYearNoUpfrontReservedPrice, RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice, RecommendationsSourcesRecommendationSourceArn, RecommendationsSourcesRecommendationSourceType, LastRefreshTimestamp
|
400
509
|
# s3_destination_config: { # required
|
401
510
|
# bucket: "DestinationBucket",
|
402
511
|
# key_prefix: "DestinationKeyPrefix",
|
@@ -409,8 +518,8 @@ module Aws::ComputeOptimizer
|
|
409
518
|
# The IDs of the AWS accounts for which to export instance
|
410
519
|
# recommendations.
|
411
520
|
#
|
412
|
-
# If your account is the
|
413
|
-
# parameter to specify the member accounts for which you want to
|
521
|
+
# If your account is the management account of an organization, use
|
522
|
+
# this parameter to specify the member accounts for which you want to
|
414
523
|
# export recommendations.
|
415
524
|
#
|
416
525
|
# This parameter cannot be specified together with the include member
|
@@ -429,7 +538,13 @@ module Aws::ComputeOptimizer
|
|
429
538
|
# @return [Array<Types::Filter>]
|
430
539
|
#
|
431
540
|
# @!attribute [rw] fields_to_export
|
432
|
-
# The recommendations data to include in the export file.
|
541
|
+
# The recommendations data to include in the export file. For more
|
542
|
+
# information about the fields that can be exported, see [Exported
|
543
|
+
# files][1] in the *Compute Optimizer User Guide*.
|
544
|
+
#
|
545
|
+
#
|
546
|
+
#
|
547
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files
|
433
548
|
# @return [Array<String>]
|
434
549
|
#
|
435
550
|
# @!attribute [rw] s3_destination_config
|
@@ -459,8 +574,8 @@ module Aws::ComputeOptimizer
|
|
459
574
|
#
|
460
575
|
# @!attribute [rw] include_member_accounts
|
461
576
|
# Indicates whether to include recommendations for resources in all
|
462
|
-
# member accounts of the organization if your account is the
|
463
|
-
# account of an organization.
|
577
|
+
# member accounts of the organization if your account is the
|
578
|
+
# management account of an organization.
|
464
579
|
#
|
465
580
|
# The member accounts must also be opted in to Compute Optimizer.
|
466
581
|
#
|
@@ -508,6 +623,9 @@ module Aws::ComputeOptimizer
|
|
508
623
|
# Describes a filter that returns a more specific list of
|
509
624
|
# recommendations.
|
510
625
|
#
|
626
|
+
# This filter is used with the `GetAutoScalingGroupRecommendations` and
|
627
|
+
# `GetEC2InstanceRecommendations` actions.
|
628
|
+
#
|
511
629
|
# @note When making an API call, you may pass Filter
|
512
630
|
# data as a hash:
|
513
631
|
#
|
@@ -519,7 +637,7 @@ module Aws::ComputeOptimizer
|
|
519
637
|
# @!attribute [rw] name
|
520
638
|
# The name of the filter.
|
521
639
|
#
|
522
|
-
# Specify `Finding` to return recommendations with a specific
|
640
|
+
# Specify `Finding` to return recommendations with a specific finding
|
523
641
|
# classification (e.g., `Overprovisioned`).
|
524
642
|
#
|
525
643
|
# Specify `RecommendationSourceType` to return recommendations of a
|
@@ -529,17 +647,20 @@ module Aws::ComputeOptimizer
|
|
529
647
|
# @!attribute [rw] values
|
530
648
|
# The value of the filter.
|
531
649
|
#
|
532
|
-
#
|
533
|
-
#
|
534
|
-
#
|
535
|
-
#
|
650
|
+
# The valid values for this parameter are as follows, depending on
|
651
|
+
# what you specify for the `name` parameter and the resource type that
|
652
|
+
# you wish to filter results for:
|
653
|
+
#
|
654
|
+
# * Specify `Optimized` or `NotOptimized` if you specified the `name`
|
655
|
+
# parameter as `Finding` and you want to filter results for Auto
|
656
|
+
# Scaling groups.
|
536
657
|
#
|
537
|
-
#
|
538
|
-
#
|
539
|
-
#
|
658
|
+
# * Specify `Underprovisioned`, `Overprovisioned`, or `Optimized` if
|
659
|
+
# you specified the `name` parameter as `Finding` and you want to
|
660
|
+
# filter results for EC2 instances.
|
540
661
|
#
|
541
|
-
#
|
542
|
-
#
|
662
|
+
# * Specify `Ec2Instance` or `AutoScalingGroup` if you specified the
|
663
|
+
# `name` parameter as `RecommendationSourceType`.
|
543
664
|
# @return [Array<String>]
|
544
665
|
#
|
545
666
|
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/Filter AWS API Documentation
|
@@ -571,8 +692,8 @@ module Aws::ComputeOptimizer
|
|
571
692
|
# The IDs of the AWS accounts for which to return Auto Scaling group
|
572
693
|
# recommendations.
|
573
694
|
#
|
574
|
-
# If your account is the
|
575
|
-
# parameter to specify the member accounts for which you want to
|
695
|
+
# If your account is the management account of an organization, use
|
696
|
+
# this parameter to specify the member accounts for which you want to
|
576
697
|
# return Auto Scaling group recommendations.
|
577
698
|
#
|
578
699
|
# Only one account ID can be specified per request.
|
@@ -643,6 +764,96 @@ module Aws::ComputeOptimizer
|
|
643
764
|
include Aws::Structure
|
644
765
|
end
|
645
766
|
|
767
|
+
# @note When making an API call, you may pass GetEBSVolumeRecommendationsRequest
|
768
|
+
# data as a hash:
|
769
|
+
#
|
770
|
+
# {
|
771
|
+
# volume_arns: ["VolumeArn"],
|
772
|
+
# next_token: "NextToken",
|
773
|
+
# max_results: 1,
|
774
|
+
# filters: [
|
775
|
+
# {
|
776
|
+
# name: "Finding", # accepts Finding
|
777
|
+
# values: ["FilterValue"],
|
778
|
+
# },
|
779
|
+
# ],
|
780
|
+
# account_ids: ["AccountId"],
|
781
|
+
# }
|
782
|
+
#
|
783
|
+
# @!attribute [rw] volume_arns
|
784
|
+
# The Amazon Resource Name (ARN) of the volumes for which to return
|
785
|
+
# recommendations.
|
786
|
+
# @return [Array<String>]
|
787
|
+
#
|
788
|
+
# @!attribute [rw] next_token
|
789
|
+
# The token to advance to the next page of volume recommendations.
|
790
|
+
# @return [String]
|
791
|
+
#
|
792
|
+
# @!attribute [rw] max_results
|
793
|
+
# The maximum number of volume recommendations to return with a single
|
794
|
+
# request.
|
795
|
+
#
|
796
|
+
# To retrieve the remaining results, make another request with the
|
797
|
+
# returned `NextToken` value.
|
798
|
+
# @return [Integer]
|
799
|
+
#
|
800
|
+
# @!attribute [rw] filters
|
801
|
+
# An array of objects that describe a filter that returns a more
|
802
|
+
# specific list of volume recommendations.
|
803
|
+
# @return [Array<Types::EBSFilter>]
|
804
|
+
#
|
805
|
+
# @!attribute [rw] account_ids
|
806
|
+
# The IDs of the AWS accounts for which to return volume
|
807
|
+
# recommendations.
|
808
|
+
#
|
809
|
+
# If your account is the management account of an organization, use
|
810
|
+
# this parameter to specify the member accounts for which you want to
|
811
|
+
# return volume recommendations.
|
812
|
+
#
|
813
|
+
# Only one account ID can be specified per request.
|
814
|
+
# @return [Array<String>]
|
815
|
+
#
|
816
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/GetEBSVolumeRecommendationsRequest AWS API Documentation
|
817
|
+
#
|
818
|
+
class GetEBSVolumeRecommendationsRequest < Struct.new(
|
819
|
+
:volume_arns,
|
820
|
+
:next_token,
|
821
|
+
:max_results,
|
822
|
+
:filters,
|
823
|
+
:account_ids)
|
824
|
+
SENSITIVE = []
|
825
|
+
include Aws::Structure
|
826
|
+
end
|
827
|
+
|
828
|
+
# @!attribute [rw] next_token
|
829
|
+
# The token to use to advance to the next page of volume
|
830
|
+
# recommendations.
|
831
|
+
#
|
832
|
+
# This value is null when there are no more pages of volume
|
833
|
+
# recommendations to return.
|
834
|
+
# @return [String]
|
835
|
+
#
|
836
|
+
# @!attribute [rw] volume_recommendations
|
837
|
+
# An array of objects that describe volume recommendations.
|
838
|
+
# @return [Array<Types::VolumeRecommendation>]
|
839
|
+
#
|
840
|
+
# @!attribute [rw] errors
|
841
|
+
# An array of objects that describe errors of the request.
|
842
|
+
#
|
843
|
+
# For example, an error is returned if you request recommendations for
|
844
|
+
# an unsupported volume.
|
845
|
+
# @return [Array<Types::GetRecommendationError>]
|
846
|
+
#
|
847
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/GetEBSVolumeRecommendationsResponse AWS API Documentation
|
848
|
+
#
|
849
|
+
class GetEBSVolumeRecommendationsResponse < Struct.new(
|
850
|
+
:next_token,
|
851
|
+
:volume_recommendations,
|
852
|
+
:errors)
|
853
|
+
SENSITIVE = []
|
854
|
+
include Aws::Structure
|
855
|
+
end
|
856
|
+
|
646
857
|
# @note When making an API call, you may pass GetEC2InstanceRecommendationsRequest
|
647
858
|
# data as a hash:
|
648
859
|
#
|
@@ -685,8 +896,8 @@ module Aws::ComputeOptimizer
|
|
685
896
|
# The IDs of the AWS accounts for which to return instance
|
686
897
|
# recommendations.
|
687
898
|
#
|
688
|
-
# If your account is the
|
689
|
-
# parameter to specify the member accounts for which you want to
|
899
|
+
# If your account is the management account of an organization, use
|
900
|
+
# this parameter to specify the member accounts for which you want to
|
690
901
|
# return instance recommendations.
|
691
902
|
#
|
692
903
|
# Only one account ID can be specified per request.
|
@@ -809,7 +1020,8 @@ module Aws::ComputeOptimizer
|
|
809
1020
|
#
|
810
1021
|
# @!attribute [rw] member_accounts_enrolled
|
811
1022
|
# Confirms the enrollment status of member accounts within the
|
812
|
-
# organization, if the account is a
|
1023
|
+
# organization, if the account is a management account of an
|
1024
|
+
# organization.
|
813
1025
|
# @return [Boolean]
|
814
1026
|
#
|
815
1027
|
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/GetEnrollmentStatusResponse AWS API Documentation
|
@@ -863,8 +1075,8 @@ module Aws::ComputeOptimizer
|
|
863
1075
|
# The IDs of the AWS accounts for which to return recommendation
|
864
1076
|
# summaries.
|
865
1077
|
#
|
866
|
-
# If your account is the
|
867
|
-
# parameter to specify the member accounts for which you want to
|
1078
|
+
# If your account is the management account of an organization, use
|
1079
|
+
# this parameter to specify the member accounts for which you want to
|
868
1080
|
# return recommendation summaries.
|
869
1081
|
#
|
870
1082
|
# Only one account ID can be specified per request.
|
@@ -956,11 +1168,6 @@ module Aws::ComputeOptimizer
|
|
956
1168
|
# your workloads with optimal performance and infrastructure cost.
|
957
1169
|
# For optimized resources, AWS Compute Optimizer might recommend a
|
958
1170
|
# new generation instance type.
|
959
|
-
#
|
960
|
-
# <note markdown="1"> The values that are returned might be `UNDER_PROVISIONED`,
|
961
|
-
# `OVER_PROVISIONED`, or `OPTIMIZED`.
|
962
|
-
#
|
963
|
-
# </note>
|
964
1171
|
# @return [String]
|
965
1172
|
#
|
966
1173
|
# @!attribute [rw] utilization_metrics
|
@@ -1014,6 +1221,18 @@ module Aws::ComputeOptimizer
|
|
1014
1221
|
# @!attribute [rw] projected_utilization_metrics
|
1015
1222
|
# An array of objects that describe the projected utilization metrics
|
1016
1223
|
# of the instance recommendation option.
|
1224
|
+
#
|
1225
|
+
# <note markdown="1"> The `Cpu` and `Memory` metrics are the only projected utilization
|
1226
|
+
# metrics returned. Additionally, the `Memory` metric is returned only
|
1227
|
+
# for resources that have the unified CloudWatch agent installed on
|
1228
|
+
# them. For more information, see [Enabling Memory Utilization with
|
1229
|
+
# the CloudWatch Agent][1].
|
1230
|
+
#
|
1231
|
+
# </note>
|
1232
|
+
#
|
1233
|
+
#
|
1234
|
+
#
|
1235
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent
|
1017
1236
|
# @return [Array<Types::UtilizationMetric>]
|
1018
1237
|
#
|
1019
1238
|
# @!attribute [rw] performance_risk
|
@@ -1096,11 +1315,16 @@ module Aws::ComputeOptimizer
|
|
1096
1315
|
# @!attribute [rw] values
|
1097
1316
|
# The value of the filter.
|
1098
1317
|
#
|
1099
|
-
#
|
1100
|
-
#
|
1318
|
+
# The valid values for this parameter are as follows, depending on
|
1319
|
+
# what you specify for the `name` parameter:
|
1101
1320
|
#
|
1102
|
-
#
|
1103
|
-
#
|
1321
|
+
# * Specify `Ec2Instance` or `AutoScalingGroup` if you specified the
|
1322
|
+
# `name` parameter as `ResourceType`. There is no filter for EBS
|
1323
|
+
# volumes because volume recommendations cannot be exported at this
|
1324
|
+
# time.
|
1325
|
+
#
|
1326
|
+
# * Specify `Queued`, `InProgress`, `Complete`, or `Failed` if you
|
1327
|
+
# specified the `name` parameter as `JobStatus`.
|
1104
1328
|
# @return [Array<String>]
|
1105
1329
|
#
|
1106
1330
|
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/JobFilter AWS API Documentation
|
@@ -1153,20 +1377,60 @@ module Aws::ComputeOptimizer
|
|
1153
1377
|
end
|
1154
1378
|
|
1155
1379
|
# Describes a projected utilization metric of a recommendation option,
|
1156
|
-
# such as an Amazon EC2 instance.
|
1380
|
+
# such as an Amazon EC2 instance. This represents the projected
|
1381
|
+
# utilization of a recommendation option had you used that resource
|
1382
|
+
# during the analyzed period.
|
1383
|
+
#
|
1384
|
+
# Compare the utilization metric data of your resource against its
|
1385
|
+
# projected utilization metric data to determine the performance
|
1386
|
+
# difference between your current resource and the recommended option.
|
1387
|
+
#
|
1388
|
+
# <note markdown="1"> The `Cpu` and `Memory` metrics are the only projected utilization
|
1389
|
+
# metrics returned when you run the
|
1390
|
+
# `GetEC2RecommendationProjectedMetrics` action. Additionally, the
|
1391
|
+
# `Memory` metric is returned only for resources that have the unified
|
1392
|
+
# CloudWatch agent installed on them. For more information, see
|
1393
|
+
# [Enabling Memory Utilization with the CloudWatch Agent][1].
|
1394
|
+
#
|
1395
|
+
# </note>
|
1396
|
+
#
|
1397
|
+
#
|
1398
|
+
#
|
1399
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent
|
1157
1400
|
#
|
1158
1401
|
# @!attribute [rw] name
|
1159
1402
|
# The name of the projected utilization metric.
|
1160
1403
|
#
|
1161
|
-
#
|
1162
|
-
# CloudWatch agent installed on them. For more information, see
|
1163
|
-
# [Enabling Memory Utilization with the CloudWatch Agent][1].
|
1404
|
+
# The following projected utilization metrics are returned:
|
1164
1405
|
#
|
1165
|
-
#
|
1406
|
+
# * `Cpu` - The projected percentage of allocated EC2 compute units
|
1407
|
+
# that would be in use on the recommendation option had you used
|
1408
|
+
# that resource during the analyzed period. This metric identifies
|
1409
|
+
# the processing power required to run an application on the
|
1410
|
+
# recommendation option.
|
1411
|
+
#
|
1412
|
+
# Depending on the instance type, tools in your operating system can
|
1413
|
+
# show a lower percentage than CloudWatch when the instance is not
|
1414
|
+
# allocated a full processor core.
|
1415
|
+
#
|
1416
|
+
# Units: Percent
|
1417
|
+
#
|
1418
|
+
# * `Memory` - The percentage of memory that would be in use on the
|
1419
|
+
# recommendation option had you used that resource during the
|
1420
|
+
# analyzed period. This metric identifies the amount of memory
|
1421
|
+
# required to run an application on the recommendation option.
|
1166
1422
|
#
|
1423
|
+
# Units: Percent
|
1167
1424
|
#
|
1425
|
+
# <note markdown="1"> The `Memory` metric is returned only for resources that have the
|
1426
|
+
# unified CloudWatch agent installed on them. For more information,
|
1427
|
+
# see [Enabling Memory Utilization with the CloudWatch Agent][1].
|
1168
1428
|
#
|
1169
|
-
#
|
1429
|
+
# </note>
|
1430
|
+
#
|
1431
|
+
#
|
1432
|
+
#
|
1433
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent
|
1170
1434
|
# @return [String]
|
1171
1435
|
#
|
1172
1436
|
# @!attribute [rw] timestamps
|
@@ -1284,6 +1548,19 @@ module Aws::ComputeOptimizer
|
|
1284
1548
|
|
1285
1549
|
# Describes a projected utilization metric of a recommendation option.
|
1286
1550
|
#
|
1551
|
+
# <note markdown="1"> The `Cpu` and `Memory` metrics are the only projected utilization
|
1552
|
+
# metrics returned when you run the
|
1553
|
+
# `GetEC2RecommendationProjectedMetrics` action. Additionally, the
|
1554
|
+
# `Memory` metric is returned only for resources that have the unified
|
1555
|
+
# CloudWatch agent installed on them. For more information, see
|
1556
|
+
# [Enabling Memory Utilization with the CloudWatch Agent][1].
|
1557
|
+
#
|
1558
|
+
# </note>
|
1559
|
+
#
|
1560
|
+
#
|
1561
|
+
#
|
1562
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent
|
1563
|
+
#
|
1287
1564
|
# @!attribute [rw] recommended_instance_type
|
1288
1565
|
# The recommended instance type.
|
1289
1566
|
# @return [String]
|
@@ -1464,7 +1741,7 @@ module Aws::ComputeOptimizer
|
|
1464
1741
|
#
|
1465
1742
|
# @!attribute [rw] include_member_accounts
|
1466
1743
|
# Indicates whether to enroll member accounts of the organization if
|
1467
|
-
# the your account is the
|
1744
|
+
# the your account is the management account of an organization.
|
1468
1745
|
# @return [Boolean]
|
1469
1746
|
#
|
1470
1747
|
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/UpdateEnrollmentStatusRequest AWS API Documentation
|
@@ -1498,22 +1775,76 @@ module Aws::ComputeOptimizer
|
|
1498
1775
|
# Describes a utilization metric of a resource, such as an Amazon EC2
|
1499
1776
|
# instance.
|
1500
1777
|
#
|
1778
|
+
# Compare the utilization metric data of your resource against its
|
1779
|
+
# projected utilization metric data to determine the performance
|
1780
|
+
# difference between your current resource and the recommended option.
|
1781
|
+
#
|
1501
1782
|
# @!attribute [rw] name
|
1502
1783
|
# The name of the utilization metric.
|
1503
1784
|
#
|
1504
|
-
#
|
1505
|
-
# CloudWatch agent installed on them. For more information, see
|
1506
|
-
# [Enabling Memory Utilization with the CloudWatch Agent][1].
|
1785
|
+
# The following utilization metrics are available:
|
1507
1786
|
#
|
1508
|
-
#
|
1787
|
+
# * `Cpu` - The percentage of allocated EC2 compute units that are
|
1788
|
+
# currently in use on the instance. This metric identifies the
|
1789
|
+
# processing power required to run an application on the instance.
|
1790
|
+
#
|
1791
|
+
# Depending on the instance type, tools in your operating system can
|
1792
|
+
# show a lower percentage than CloudWatch when the instance is not
|
1793
|
+
# allocated a full processor core.
|
1794
|
+
#
|
1795
|
+
# Units: Percent
|
1796
|
+
#
|
1797
|
+
# * `Memory` - The percentage of memory that is currently in use on
|
1798
|
+
# the instance. This metric identifies the amount of memory required
|
1799
|
+
# to run an application on the instance.
|
1800
|
+
#
|
1801
|
+
# Units: Percent
|
1802
|
+
#
|
1803
|
+
# <note markdown="1"> The `Memory` metric is returned only for resources that have the
|
1804
|
+
# unified CloudWatch agent installed on them. For more information,
|
1805
|
+
# see [Enabling Memory Utilization with the CloudWatch Agent][1].
|
1806
|
+
#
|
1807
|
+
# </note>
|
1808
|
+
#
|
1809
|
+
# * `EBS_READ_OPS_PER_SECOND` - The completed read operations from all
|
1810
|
+
# EBS volumes attached to the instance in a specified period of
|
1811
|
+
# time.
|
1509
1812
|
#
|
1813
|
+
# Unit: Count
|
1510
1814
|
#
|
1815
|
+
# * `EBS_WRITE_OPS_PER_SECOND` - The completed write operations to all
|
1816
|
+
# EBS volumes attached to the instance in a specified period of
|
1817
|
+
# time.
|
1511
1818
|
#
|
1512
|
-
#
|
1819
|
+
# Unit: Count
|
1820
|
+
#
|
1821
|
+
# * `EBS_READ_BYTES_PER_SECOND` - The bytes read from all EBS volumes
|
1822
|
+
# attached to the instance in a specified period of time.
|
1823
|
+
#
|
1824
|
+
# Unit: Bytes
|
1825
|
+
#
|
1826
|
+
# * `EBS_WRITE_BYTES_PER_SECOND` - The bytes written to all EBS
|
1827
|
+
# volumes attached to the instance in a specified period of time.
|
1828
|
+
#
|
1829
|
+
# Unit: Bytes
|
1830
|
+
#
|
1831
|
+
#
|
1832
|
+
#
|
1833
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent
|
1513
1834
|
# @return [String]
|
1514
1835
|
#
|
1515
1836
|
# @!attribute [rw] statistic
|
1516
1837
|
# The statistic of the utilization metric.
|
1838
|
+
#
|
1839
|
+
# The following statistics are available:
|
1840
|
+
#
|
1841
|
+
# * `Average` - This is the value of Sum / SampleCount during the
|
1842
|
+
# specified period, or the average value observed during the
|
1843
|
+
# specified period.
|
1844
|
+
#
|
1845
|
+
# * `Maximum` - The highest value observed during the specified
|
1846
|
+
# period. Use this value to determine high volumes of activity for
|
1847
|
+
# your application.
|
1517
1848
|
# @return [String]
|
1518
1849
|
#
|
1519
1850
|
# @!attribute [rw] value
|
@@ -1530,5 +1861,148 @@ module Aws::ComputeOptimizer
|
|
1530
1861
|
include Aws::Structure
|
1531
1862
|
end
|
1532
1863
|
|
1864
|
+
# Describes the configuration of an Amazon Elastic Block Store (Amazon
|
1865
|
+
# EBS) volume.
|
1866
|
+
#
|
1867
|
+
# @!attribute [rw] volume_type
|
1868
|
+
# The volume type.
|
1869
|
+
#
|
1870
|
+
# This can be `gp2` for General Purpose SSD, `io1` or `io2` for
|
1871
|
+
# Provisioned IOPS SSD, `st1` for Throughput Optimized HDD, `sc1` for
|
1872
|
+
# Cold HDD, or `standard` for Magnetic volumes.
|
1873
|
+
# @return [String]
|
1874
|
+
#
|
1875
|
+
# @!attribute [rw] volume_size
|
1876
|
+
# The size of the volume, in GiB.
|
1877
|
+
# @return [Integer]
|
1878
|
+
#
|
1879
|
+
# @!attribute [rw] volume_baseline_iops
|
1880
|
+
# The baseline IOPS of the volume.
|
1881
|
+
# @return [Integer]
|
1882
|
+
#
|
1883
|
+
# @!attribute [rw] volume_burst_iops
|
1884
|
+
# The burst IOPS of the volume.
|
1885
|
+
# @return [Integer]
|
1886
|
+
#
|
1887
|
+
# @!attribute [rw] volume_baseline_throughput
|
1888
|
+
# The baseline throughput of the volume.
|
1889
|
+
# @return [Integer]
|
1890
|
+
#
|
1891
|
+
# @!attribute [rw] volume_burst_throughput
|
1892
|
+
# The burst throughput of the volume.
|
1893
|
+
# @return [Integer]
|
1894
|
+
#
|
1895
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/VolumeConfiguration AWS API Documentation
|
1896
|
+
#
|
1897
|
+
class VolumeConfiguration < Struct.new(
|
1898
|
+
:volume_type,
|
1899
|
+
:volume_size,
|
1900
|
+
:volume_baseline_iops,
|
1901
|
+
:volume_burst_iops,
|
1902
|
+
:volume_baseline_throughput,
|
1903
|
+
:volume_burst_throughput)
|
1904
|
+
SENSITIVE = []
|
1905
|
+
include Aws::Structure
|
1906
|
+
end
|
1907
|
+
|
1908
|
+
# Describes an Amazon Elastic Block Store (Amazon EBS) volume
|
1909
|
+
# recommendation.
|
1910
|
+
#
|
1911
|
+
# @!attribute [rw] volume_arn
|
1912
|
+
# The Amazon Resource Name (ARN) of the current volume.
|
1913
|
+
# @return [String]
|
1914
|
+
#
|
1915
|
+
# @!attribute [rw] account_id
|
1916
|
+
# The AWS account ID of the volume.
|
1917
|
+
# @return [String]
|
1918
|
+
#
|
1919
|
+
# @!attribute [rw] current_configuration
|
1920
|
+
# An array of objects that describe the current configuration of the
|
1921
|
+
# volume.
|
1922
|
+
# @return [Types::VolumeConfiguration]
|
1923
|
+
#
|
1924
|
+
# @!attribute [rw] finding
|
1925
|
+
# The finding classification for the volume.
|
1926
|
+
#
|
1927
|
+
# Findings for volumes include:
|
1928
|
+
#
|
1929
|
+
# * <b> <code>NotOptimized</code> </b>—A volume is considered not
|
1930
|
+
# optimized when AWS Compute Optimizer identifies a recommendation
|
1931
|
+
# that can provide better performance for your workload.
|
1932
|
+
#
|
1933
|
+
# * <b> <code>Optimized</code> </b>—An volume is considered optimized
|
1934
|
+
# when Compute Optimizer determines that the volume is correctly
|
1935
|
+
# provisioned to run your workload based on the chosen volume type.
|
1936
|
+
# For optimized resources, Compute Optimizer might recommend a new
|
1937
|
+
# generation volume type.
|
1938
|
+
# @return [String]
|
1939
|
+
#
|
1940
|
+
# @!attribute [rw] utilization_metrics
|
1941
|
+
# An array of objects that describe the utilization metrics of the
|
1942
|
+
# volume.
|
1943
|
+
# @return [Array<Types::EBSUtilizationMetric>]
|
1944
|
+
#
|
1945
|
+
# @!attribute [rw] look_back_period_in_days
|
1946
|
+
# The number of days for which utilization metrics were analyzed for
|
1947
|
+
# the volume.
|
1948
|
+
# @return [Float]
|
1949
|
+
#
|
1950
|
+
# @!attribute [rw] volume_recommendation_options
|
1951
|
+
# An array of objects that describe the recommendation options for the
|
1952
|
+
# volume.
|
1953
|
+
# @return [Array<Types::VolumeRecommendationOption>]
|
1954
|
+
#
|
1955
|
+
# @!attribute [rw] last_refresh_timestamp
|
1956
|
+
# The time stamp of when the volume recommendation was last refreshed.
|
1957
|
+
# @return [Time]
|
1958
|
+
#
|
1959
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/VolumeRecommendation AWS API Documentation
|
1960
|
+
#
|
1961
|
+
class VolumeRecommendation < Struct.new(
|
1962
|
+
:volume_arn,
|
1963
|
+
:account_id,
|
1964
|
+
:current_configuration,
|
1965
|
+
:finding,
|
1966
|
+
:utilization_metrics,
|
1967
|
+
:look_back_period_in_days,
|
1968
|
+
:volume_recommendation_options,
|
1969
|
+
:last_refresh_timestamp)
|
1970
|
+
SENSITIVE = []
|
1971
|
+
include Aws::Structure
|
1972
|
+
end
|
1973
|
+
|
1974
|
+
# Describes a recommendation option for an Amazon Elastic Block Store
|
1975
|
+
# (Amazon EBS) instance.
|
1976
|
+
#
|
1977
|
+
# @!attribute [rw] configuration
|
1978
|
+
# An array of objects that describe a volume configuration.
|
1979
|
+
# @return [Types::VolumeConfiguration]
|
1980
|
+
#
|
1981
|
+
# @!attribute [rw] performance_risk
|
1982
|
+
# The performance risk of the volume recommendation option.
|
1983
|
+
#
|
1984
|
+
# Performance risk is the likelihood of the recommended volume type
|
1985
|
+
# not meeting the performance requirement of your workload.
|
1986
|
+
#
|
1987
|
+
# The lowest performance risk is categorized as `0`, and the highest
|
1988
|
+
# as `5`.
|
1989
|
+
# @return [Float]
|
1990
|
+
#
|
1991
|
+
# @!attribute [rw] rank
|
1992
|
+
# The rank of the volume recommendation option.
|
1993
|
+
#
|
1994
|
+
# The top recommendation option is ranked as `1`.
|
1995
|
+
# @return [Integer]
|
1996
|
+
#
|
1997
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/VolumeRecommendationOption AWS API Documentation
|
1998
|
+
#
|
1999
|
+
class VolumeRecommendationOption < Struct.new(
|
2000
|
+
:configuration,
|
2001
|
+
:performance_risk,
|
2002
|
+
:rank)
|
2003
|
+
SENSITIVE = []
|
2004
|
+
include Aws::Structure
|
2005
|
+
end
|
2006
|
+
|
1533
2007
|
end
|
1534
2008
|
end
|