aws-sdk-computeoptimizer 1.16.0 → 1.20.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.rb +1 -1
- data/lib/aws-sdk-computeoptimizer/client.rb +303 -21
- data/lib/aws-sdk-computeoptimizer/client_api.rb +78 -0
- data/lib/aws-sdk-computeoptimizer/types.rb +752 -52
- metadata +7 -8
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 70cbc201e95f19f4e5a85c21f5815c05e988408f16b8ec916c4d7e7ceae1dd1e
|
4
|
+
data.tar.gz: 2f65d673af436791801c6675c0bd4d580ada241353a1ab2c86c26c133e61a578
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: bd3a79f8559c58c3f6aa09566c79070944259b88f255862ee22b824909db01a4c87ed6ed4c45f5f0a63e4fe45bcb782967eb0dc310eba3fbb9540849fc4b601d
|
7
|
+
data.tar.gz: e6f39ef18dcf1b3ff756a751f325ff9e06a1d118a504e04f3ccb4c709a474685810207ae3044a19b3b4dbc9e3b99052cd708cf5d7ec299144ac2ae25b687cf1f
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.20.0 (2021-07-28)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.19.0 (2021-07-20)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Documentation updates for Compute Optimizer
|
13
|
+
|
14
|
+
1.18.0 (2021-05-24)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Adds support for 1) additional instance types, 2) additional instance metrics, 3) finding reasons for instance recommendations, and 4) platform differences between a current instance and a recommended instance type.
|
18
|
+
|
19
|
+
1.17.0 (2021-05-18)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - This release enables compute optimizer to support exporting recommendations to Amazon S3 for EBS volumes and Lambda Functions.
|
23
|
+
|
4
24
|
1.16.0 (2021-03-10)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.20.0
|
@@ -393,7 +393,7 @@ module Aws::ComputeOptimizer
|
|
393
393
|
# resp.recommendation_export_jobs[0].destination.s3.bucket #=> String
|
394
394
|
# resp.recommendation_export_jobs[0].destination.s3.key #=> String
|
395
395
|
# resp.recommendation_export_jobs[0].destination.s3.metadata_key #=> String
|
396
|
-
# resp.recommendation_export_jobs[0].resource_type #=> String, one of "Ec2Instance", "AutoScalingGroup"
|
396
|
+
# resp.recommendation_export_jobs[0].resource_type #=> String, one of "Ec2Instance", "AutoScalingGroup", "EbsVolume", "LambdaFunction"
|
397
397
|
# resp.recommendation_export_jobs[0].status #=> String, one of "Queued", "InProgress", "Complete", "Failed"
|
398
398
|
# resp.recommendation_export_jobs[0].creation_timestamp #=> Time
|
399
399
|
# resp.recommendation_export_jobs[0].last_updated_timestamp #=> Time
|
@@ -481,7 +481,11 @@ module Aws::ComputeOptimizer
|
|
481
481
|
# member accounts of the organization if your account is the management
|
482
482
|
# account of an organization.
|
483
483
|
#
|
484
|
-
# The member accounts must also be opted in to Compute Optimizer
|
484
|
+
# The member accounts must also be opted in to Compute Optimizer, and
|
485
|
+
# trusted access for Compute Optimizer must be enabled in the
|
486
|
+
# organization account. For more information, see [Compute Optimizer and
|
487
|
+
# AWS Organizations trusted access][1] in the *AWS Compute Optimizer
|
488
|
+
# User Guide*.
|
485
489
|
#
|
486
490
|
# Recommendations for member accounts of the organization are not
|
487
491
|
# included in the export file if this parameter is omitted.
|
@@ -492,6 +496,10 @@ module Aws::ComputeOptimizer
|
|
492
496
|
# Recommendations for member accounts are not included in the export if
|
493
497
|
# this parameter, or the account IDs parameter, is omitted.
|
494
498
|
#
|
499
|
+
#
|
500
|
+
#
|
501
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access
|
502
|
+
#
|
495
503
|
# @return [Types::ExportAutoScalingGroupRecommendationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
496
504
|
#
|
497
505
|
# * {Types::ExportAutoScalingGroupRecommendationsResponse#job_id #job_id} => String
|
@@ -503,11 +511,11 @@ module Aws::ComputeOptimizer
|
|
503
511
|
# account_ids: ["AccountId"],
|
504
512
|
# filters: [
|
505
513
|
# {
|
506
|
-
# name: "Finding", # accepts Finding, RecommendationSourceType
|
514
|
+
# name: "Finding", # accepts Finding, FindingReasonCodes, RecommendationSourceType
|
507
515
|
# values: ["FilterValue"],
|
508
516
|
# },
|
509
517
|
# ],
|
510
|
-
# 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
|
518
|
+
# fields_to_export: ["AccountId"], # accepts AccountId, AutoScalingGroupArn, AutoScalingGroupName, Finding, UtilizationMetricsCpuMaximum, UtilizationMetricsMemoryMaximum, UtilizationMetricsEbsReadOpsPerSecondMaximum, UtilizationMetricsEbsWriteOpsPerSecondMaximum, UtilizationMetricsEbsReadBytesPerSecondMaximum, UtilizationMetricsEbsWriteBytesPerSecondMaximum, UtilizationMetricsDiskReadOpsPerSecondMaximum, UtilizationMetricsDiskWriteOpsPerSecondMaximum, UtilizationMetricsDiskReadBytesPerSecondMaximum, UtilizationMetricsDiskWriteBytesPerSecondMaximum, UtilizationMetricsNetworkInBytesPerSecondMaximum, UtilizationMetricsNetworkOutBytesPerSecondMaximum, UtilizationMetricsNetworkPacketsInPerSecondMaximum, UtilizationMetricsNetworkPacketsOutPerSecondMaximum, 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
|
511
519
|
# s3_destination_config: { # required
|
512
520
|
# bucket: "DestinationBucket",
|
513
521
|
# key_prefix: "DestinationKeyPrefix",
|
@@ -532,6 +540,137 @@ module Aws::ComputeOptimizer
|
|
532
540
|
req.send_request(options)
|
533
541
|
end
|
534
542
|
|
543
|
+
# Exports optimization recommendations for Amazon EBS volumes.
|
544
|
+
#
|
545
|
+
# Recommendations are exported in a comma-separated values (.csv) file,
|
546
|
+
# and its metadata in a JavaScript Object Notation (.json) file, to an
|
547
|
+
# existing Amazon Simple Storage Service (Amazon S3) bucket that you
|
548
|
+
# specify. For more information, see [Exporting Recommendations][1] in
|
549
|
+
# the *Compute Optimizer User Guide*.
|
550
|
+
#
|
551
|
+
# You can have only one Amazon EBS volume export job in progress per AWS
|
552
|
+
# Region.
|
553
|
+
#
|
554
|
+
#
|
555
|
+
#
|
556
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html
|
557
|
+
#
|
558
|
+
# @option params [Array<String>] :account_ids
|
559
|
+
# The IDs of the AWS accounts for which to export Amazon EBS volume
|
560
|
+
# recommendations.
|
561
|
+
#
|
562
|
+
# If your account is the management account of an organization, use this
|
563
|
+
# parameter to specify the member account for which you want to export
|
564
|
+
# recommendations.
|
565
|
+
#
|
566
|
+
# This parameter cannot be specified together with the include member
|
567
|
+
# accounts parameter. The parameters are mutually exclusive.
|
568
|
+
#
|
569
|
+
# Recommendations for member accounts are not included in the export if
|
570
|
+
# this parameter, or the include member accounts parameter, is omitted.
|
571
|
+
#
|
572
|
+
# You can specify multiple account IDs per request.
|
573
|
+
#
|
574
|
+
# @option params [Array<Types::EBSFilter>] :filters
|
575
|
+
# An array of objects that describe a filter to export a more specific
|
576
|
+
# set of Amazon EBS volume recommendations.
|
577
|
+
#
|
578
|
+
# @option params [Array<String>] :fields_to_export
|
579
|
+
# The recommendations data to include in the export file. For more
|
580
|
+
# information about the fields that can be exported, see [Exported
|
581
|
+
# files][1] in the *Compute Optimizer User Guide*.
|
582
|
+
#
|
583
|
+
#
|
584
|
+
#
|
585
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files
|
586
|
+
#
|
587
|
+
# @option params [required, Types::S3DestinationConfig] :s3_destination_config
|
588
|
+
# Describes the destination Amazon Simple Storage Service (Amazon S3)
|
589
|
+
# bucket name and key prefix for a recommendations export job.
|
590
|
+
#
|
591
|
+
# You must create the destination Amazon S3 bucket for your
|
592
|
+
# recommendations export before you create the export job. Compute
|
593
|
+
# Optimizer does not create the S3 bucket for you. After you create the
|
594
|
+
# S3 bucket, ensure that it has the required permission policy to allow
|
595
|
+
# Compute Optimizer to write the export file to it. If you plan to
|
596
|
+
# specify an object prefix when you create the export job, you must
|
597
|
+
# include the object prefix in the policy that you add to the S3 bucket.
|
598
|
+
# For more information, see [Amazon S3 Bucket Policy for Compute
|
599
|
+
# Optimizer][1] in the *Compute Optimizer user guide*.
|
600
|
+
#
|
601
|
+
#
|
602
|
+
#
|
603
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/create-s3-bucket-policy-for-compute-optimizer.html
|
604
|
+
#
|
605
|
+
# @option params [String] :file_format
|
606
|
+
# The format of the export file.
|
607
|
+
#
|
608
|
+
# The only export file format currently supported is `Csv`.
|
609
|
+
#
|
610
|
+
# @option params [Boolean] :include_member_accounts
|
611
|
+
# Indicates whether to include recommendations for resources in all
|
612
|
+
# member accounts of the organization if your account is the management
|
613
|
+
# account of an organization.
|
614
|
+
#
|
615
|
+
# The member accounts must also be opted in to Compute Optimizer, and
|
616
|
+
# trusted access for Compute Optimizer must be enabled in the
|
617
|
+
# organization account. For more information, see [Compute Optimizer and
|
618
|
+
# AWS Organizations trusted access][1] in the *AWS Compute Optimizer
|
619
|
+
# User Guide*.
|
620
|
+
#
|
621
|
+
# Recommendations for member accounts of the organization are not
|
622
|
+
# included in the export file if this parameter is omitted.
|
623
|
+
#
|
624
|
+
# This parameter cannot be specified together with the account IDs
|
625
|
+
# parameter. The parameters are mutually exclusive.
|
626
|
+
#
|
627
|
+
# Recommendations for member accounts are not included in the export if
|
628
|
+
# this parameter, or the account IDs parameter, is omitted.
|
629
|
+
#
|
630
|
+
#
|
631
|
+
#
|
632
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access
|
633
|
+
#
|
634
|
+
# @return [Types::ExportEBSVolumeRecommendationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
635
|
+
#
|
636
|
+
# * {Types::ExportEBSVolumeRecommendationsResponse#job_id #job_id} => String
|
637
|
+
# * {Types::ExportEBSVolumeRecommendationsResponse#s3_destination #s3_destination} => Types::S3Destination
|
638
|
+
#
|
639
|
+
# @example Request syntax with placeholder values
|
640
|
+
#
|
641
|
+
# resp = client.export_ebs_volume_recommendations({
|
642
|
+
# account_ids: ["AccountId"],
|
643
|
+
# filters: [
|
644
|
+
# {
|
645
|
+
# name: "Finding", # accepts Finding
|
646
|
+
# values: ["FilterValue"],
|
647
|
+
# },
|
648
|
+
# ],
|
649
|
+
# fields_to_export: ["AccountId"], # accepts AccountId, VolumeArn, Finding, UtilizationMetricsVolumeReadOpsPerSecondMaximum, UtilizationMetricsVolumeWriteOpsPerSecondMaximum, UtilizationMetricsVolumeReadBytesPerSecondMaximum, UtilizationMetricsVolumeWriteBytesPerSecondMaximum, LookbackPeriodInDays, CurrentConfigurationVolumeType, CurrentConfigurationVolumeBaselineIOPS, CurrentConfigurationVolumeBaselineThroughput, CurrentConfigurationVolumeBurstIOPS, CurrentConfigurationVolumeBurstThroughput, CurrentConfigurationVolumeSize, CurrentMonthlyPrice, RecommendationOptionsConfigurationVolumeType, RecommendationOptionsConfigurationVolumeBaselineIOPS, RecommendationOptionsConfigurationVolumeBaselineThroughput, RecommendationOptionsConfigurationVolumeBurstIOPS, RecommendationOptionsConfigurationVolumeBurstThroughput, RecommendationOptionsConfigurationVolumeSize, RecommendationOptionsMonthlyPrice, RecommendationOptionsPerformanceRisk, LastRefreshTimestamp
|
650
|
+
# s3_destination_config: { # required
|
651
|
+
# bucket: "DestinationBucket",
|
652
|
+
# key_prefix: "DestinationKeyPrefix",
|
653
|
+
# },
|
654
|
+
# file_format: "Csv", # accepts Csv
|
655
|
+
# include_member_accounts: false,
|
656
|
+
# })
|
657
|
+
#
|
658
|
+
# @example Response structure
|
659
|
+
#
|
660
|
+
# resp.job_id #=> String
|
661
|
+
# resp.s3_destination.bucket #=> String
|
662
|
+
# resp.s3_destination.key #=> String
|
663
|
+
# resp.s3_destination.metadata_key #=> String
|
664
|
+
#
|
665
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/ExportEBSVolumeRecommendations AWS API Documentation
|
666
|
+
#
|
667
|
+
# @overload export_ebs_volume_recommendations(params = {})
|
668
|
+
# @param [Hash] params ({})
|
669
|
+
def export_ebs_volume_recommendations(params = {}, options = {})
|
670
|
+
req = build_request(:export_ebs_volume_recommendations, params)
|
671
|
+
req.send_request(options)
|
672
|
+
end
|
673
|
+
|
535
674
|
# Exports optimization recommendations for Amazon EC2 instances.
|
536
675
|
#
|
537
676
|
# Recommendations are exported in a comma-separated values (.csv) file,
|
@@ -604,7 +743,11 @@ module Aws::ComputeOptimizer
|
|
604
743
|
# member accounts of the organization if your account is the management
|
605
744
|
# account of an organization.
|
606
745
|
#
|
607
|
-
# The member accounts must also be opted in to Compute Optimizer
|
746
|
+
# The member accounts must also be opted in to Compute Optimizer, and
|
747
|
+
# trusted access for Compute Optimizer must be enabled in the
|
748
|
+
# organization account. For more information, see [Compute Optimizer and
|
749
|
+
# AWS Organizations trusted access][1] in the *AWS Compute Optimizer
|
750
|
+
# User Guide*.
|
608
751
|
#
|
609
752
|
# Recommendations for member accounts of the organization are not
|
610
753
|
# included in the export file if this parameter is omitted.
|
@@ -612,6 +755,10 @@ module Aws::ComputeOptimizer
|
|
612
755
|
# Recommendations for member accounts are not included in the export if
|
613
756
|
# this parameter, or the account IDs parameter, is omitted.
|
614
757
|
#
|
758
|
+
#
|
759
|
+
#
|
760
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access
|
761
|
+
#
|
615
762
|
# @return [Types::ExportEC2InstanceRecommendationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
616
763
|
#
|
617
764
|
# * {Types::ExportEC2InstanceRecommendationsResponse#job_id #job_id} => String
|
@@ -623,11 +770,11 @@ module Aws::ComputeOptimizer
|
|
623
770
|
# account_ids: ["AccountId"],
|
624
771
|
# filters: [
|
625
772
|
# {
|
626
|
-
# name: "Finding", # accepts Finding, RecommendationSourceType
|
773
|
+
# name: "Finding", # accepts Finding, FindingReasonCodes, RecommendationSourceType
|
627
774
|
# values: ["FilterValue"],
|
628
775
|
# },
|
629
776
|
# ],
|
630
|
-
# 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
|
777
|
+
# fields_to_export: ["AccountId"], # accepts AccountId, InstanceArn, InstanceName, Finding, FindingReasonCodes, LookbackPeriodInDays, CurrentInstanceType, UtilizationMetricsCpuMaximum, UtilizationMetricsMemoryMaximum, UtilizationMetricsEbsReadOpsPerSecondMaximum, UtilizationMetricsEbsWriteOpsPerSecondMaximum, UtilizationMetricsEbsReadBytesPerSecondMaximum, UtilizationMetricsEbsWriteBytesPerSecondMaximum, UtilizationMetricsDiskReadOpsPerSecondMaximum, UtilizationMetricsDiskWriteOpsPerSecondMaximum, UtilizationMetricsDiskReadBytesPerSecondMaximum, UtilizationMetricsDiskWriteBytesPerSecondMaximum, UtilizationMetricsNetworkInBytesPerSecondMaximum, UtilizationMetricsNetworkOutBytesPerSecondMaximum, UtilizationMetricsNetworkPacketsInPerSecondMaximum, UtilizationMetricsNetworkPacketsOutPerSecondMaximum, CurrentOnDemandPrice, CurrentStandardOneYearNoUpfrontReservedPrice, CurrentStandardThreeYearNoUpfrontReservedPrice, CurrentVCpus, CurrentMemory, CurrentStorage, CurrentNetwork, RecommendationOptionsInstanceType, RecommendationOptionsProjectedUtilizationMetricsCpuMaximum, RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum, RecommendationOptionsPlatformDifferences, RecommendationOptionsPerformanceRisk, RecommendationOptionsVcpus, RecommendationOptionsMemory, RecommendationOptionsStorage, RecommendationOptionsNetwork, RecommendationOptionsOnDemandPrice, RecommendationOptionsStandardOneYearNoUpfrontReservedPrice, RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice, RecommendationsSourcesRecommendationSourceArn, RecommendationsSourcesRecommendationSourceType, LastRefreshTimestamp
|
631
778
|
# s3_destination_config: { # required
|
632
779
|
# bucket: "DestinationBucket",
|
633
780
|
# key_prefix: "DestinationKeyPrefix",
|
@@ -652,6 +799,137 @@ module Aws::ComputeOptimizer
|
|
652
799
|
req.send_request(options)
|
653
800
|
end
|
654
801
|
|
802
|
+
# Exports optimization recommendations for AWS Lambda functions.
|
803
|
+
#
|
804
|
+
# Recommendations are exported in a comma-separated values (.csv) file,
|
805
|
+
# and its metadata in a JavaScript Object Notation (.json) file, to an
|
806
|
+
# existing Amazon Simple Storage Service (Amazon S3) bucket that you
|
807
|
+
# specify. For more information, see [Exporting Recommendations][1] in
|
808
|
+
# the *Compute Optimizer User Guide*.
|
809
|
+
#
|
810
|
+
# You can have only one Lambda function export job in progress per AWS
|
811
|
+
# Region.
|
812
|
+
#
|
813
|
+
#
|
814
|
+
#
|
815
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html
|
816
|
+
#
|
817
|
+
# @option params [Array<String>] :account_ids
|
818
|
+
# The IDs of the AWS accounts for which to export Lambda function
|
819
|
+
# recommendations.
|
820
|
+
#
|
821
|
+
# If your account is the management account of an organization, use this
|
822
|
+
# parameter to specify the member account for which you want to export
|
823
|
+
# recommendations.
|
824
|
+
#
|
825
|
+
# This parameter cannot be specified together with the include member
|
826
|
+
# accounts parameter. The parameters are mutually exclusive.
|
827
|
+
#
|
828
|
+
# Recommendations for member accounts are not included in the export if
|
829
|
+
# this parameter, or the include member accounts parameter, is omitted.
|
830
|
+
#
|
831
|
+
# You can specify multiple account IDs per request.
|
832
|
+
#
|
833
|
+
# @option params [Array<Types::LambdaFunctionRecommendationFilter>] :filters
|
834
|
+
# An array of objects that describe a filter to export a more specific
|
835
|
+
# set of Lambda function recommendations.
|
836
|
+
#
|
837
|
+
# @option params [Array<String>] :fields_to_export
|
838
|
+
# The recommendations data to include in the export file. For more
|
839
|
+
# information about the fields that can be exported, see [Exported
|
840
|
+
# files][1] in the *Compute Optimizer User Guide*.
|
841
|
+
#
|
842
|
+
#
|
843
|
+
#
|
844
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files
|
845
|
+
#
|
846
|
+
# @option params [required, Types::S3DestinationConfig] :s3_destination_config
|
847
|
+
# Describes the destination Amazon Simple Storage Service (Amazon S3)
|
848
|
+
# bucket name and key prefix for a recommendations export job.
|
849
|
+
#
|
850
|
+
# You must create the destination Amazon S3 bucket for your
|
851
|
+
# recommendations export before you create the export job. Compute
|
852
|
+
# Optimizer does not create the S3 bucket for you. After you create the
|
853
|
+
# S3 bucket, ensure that it has the required permission policy to allow
|
854
|
+
# Compute Optimizer to write the export file to it. If you plan to
|
855
|
+
# specify an object prefix when you create the export job, you must
|
856
|
+
# include the object prefix in the policy that you add to the S3 bucket.
|
857
|
+
# For more information, see [Amazon S3 Bucket Policy for Compute
|
858
|
+
# Optimizer][1] in the *Compute Optimizer user guide*.
|
859
|
+
#
|
860
|
+
#
|
861
|
+
#
|
862
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/create-s3-bucket-policy-for-compute-optimizer.html
|
863
|
+
#
|
864
|
+
# @option params [String] :file_format
|
865
|
+
# The format of the export file.
|
866
|
+
#
|
867
|
+
# The only export file format currently supported is `Csv`.
|
868
|
+
#
|
869
|
+
# @option params [Boolean] :include_member_accounts
|
870
|
+
# Indicates whether to include recommendations for resources in all
|
871
|
+
# member accounts of the organization if your account is the management
|
872
|
+
# account of an organization.
|
873
|
+
#
|
874
|
+
# The member accounts must also be opted in to Compute Optimizer, and
|
875
|
+
# trusted access for Compute Optimizer must be enabled in the
|
876
|
+
# organization account. For more information, see [Compute Optimizer and
|
877
|
+
# AWS Organizations trusted access][1] in the *AWS Compute Optimizer
|
878
|
+
# User Guide*.
|
879
|
+
#
|
880
|
+
# Recommendations for member accounts of the organization are not
|
881
|
+
# included in the export file if this parameter is omitted.
|
882
|
+
#
|
883
|
+
# This parameter cannot be specified together with the account IDs
|
884
|
+
# parameter. The parameters are mutually exclusive.
|
885
|
+
#
|
886
|
+
# Recommendations for member accounts are not included in the export if
|
887
|
+
# this parameter, or the account IDs parameter, is omitted.
|
888
|
+
#
|
889
|
+
#
|
890
|
+
#
|
891
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access
|
892
|
+
#
|
893
|
+
# @return [Types::ExportLambdaFunctionRecommendationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
894
|
+
#
|
895
|
+
# * {Types::ExportLambdaFunctionRecommendationsResponse#job_id #job_id} => String
|
896
|
+
# * {Types::ExportLambdaFunctionRecommendationsResponse#s3_destination #s3_destination} => Types::S3Destination
|
897
|
+
#
|
898
|
+
# @example Request syntax with placeholder values
|
899
|
+
#
|
900
|
+
# resp = client.export_lambda_function_recommendations({
|
901
|
+
# account_ids: ["AccountId"],
|
902
|
+
# filters: [
|
903
|
+
# {
|
904
|
+
# name: "Finding", # accepts Finding, FindingReasonCode
|
905
|
+
# values: ["FilterValue"],
|
906
|
+
# },
|
907
|
+
# ],
|
908
|
+
# fields_to_export: ["AccountId"], # accepts AccountId, FunctionArn, FunctionVersion, Finding, FindingReasonCodes, NumberOfInvocations, UtilizationMetricsDurationMaximum, UtilizationMetricsDurationAverage, UtilizationMetricsMemoryMaximum, UtilizationMetricsMemoryAverage, LookbackPeriodInDays, CurrentConfigurationMemorySize, CurrentConfigurationTimeout, CurrentCostTotal, CurrentCostAverage, RecommendationOptionsConfigurationMemorySize, RecommendationOptionsCostLow, RecommendationOptionsCostHigh, RecommendationOptionsProjectedUtilizationMetricsDurationLowerBound, RecommendationOptionsProjectedUtilizationMetricsDurationUpperBound, RecommendationOptionsProjectedUtilizationMetricsDurationExpected, LastRefreshTimestamp
|
909
|
+
# s3_destination_config: { # required
|
910
|
+
# bucket: "DestinationBucket",
|
911
|
+
# key_prefix: "DestinationKeyPrefix",
|
912
|
+
# },
|
913
|
+
# file_format: "Csv", # accepts Csv
|
914
|
+
# include_member_accounts: false,
|
915
|
+
# })
|
916
|
+
#
|
917
|
+
# @example Response structure
|
918
|
+
#
|
919
|
+
# resp.job_id #=> String
|
920
|
+
# resp.s3_destination.bucket #=> String
|
921
|
+
# resp.s3_destination.key #=> String
|
922
|
+
# resp.s3_destination.metadata_key #=> String
|
923
|
+
#
|
924
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/ExportLambdaFunctionRecommendations AWS API Documentation
|
925
|
+
#
|
926
|
+
# @overload export_lambda_function_recommendations(params = {})
|
927
|
+
# @param [Hash] params ({})
|
928
|
+
def export_lambda_function_recommendations(params = {}, options = {})
|
929
|
+
req = build_request(:export_lambda_function_recommendations, params)
|
930
|
+
req.send_request(options)
|
931
|
+
end
|
932
|
+
|
655
933
|
# Returns Auto Scaling group recommendations.
|
656
934
|
#
|
657
935
|
# AWS Compute Optimizer generates recommendations for Amazon EC2 Auto
|
@@ -707,7 +985,7 @@ module Aws::ComputeOptimizer
|
|
707
985
|
# max_results: 1,
|
708
986
|
# filters: [
|
709
987
|
# {
|
710
|
-
# name: "Finding", # accepts Finding, RecommendationSourceType
|
988
|
+
# name: "Finding", # accepts Finding, FindingReasonCodes, RecommendationSourceType
|
711
989
|
# values: ["FilterValue"],
|
712
990
|
# },
|
713
991
|
# ],
|
@@ -722,7 +1000,7 @@ module Aws::ComputeOptimizer
|
|
722
1000
|
# resp.auto_scaling_group_recommendations[0].auto_scaling_group_name #=> String
|
723
1001
|
# resp.auto_scaling_group_recommendations[0].finding #=> String, one of "Underprovisioned", "Overprovisioned", "Optimized", "NotOptimized"
|
724
1002
|
# resp.auto_scaling_group_recommendations[0].utilization_metrics #=> Array
|
725
|
-
# resp.auto_scaling_group_recommendations[0].utilization_metrics[0].name #=> String, one of "Cpu", "Memory", "EBS_READ_OPS_PER_SECOND", "EBS_WRITE_OPS_PER_SECOND", "EBS_READ_BYTES_PER_SECOND", "EBS_WRITE_BYTES_PER_SECOND"
|
1003
|
+
# resp.auto_scaling_group_recommendations[0].utilization_metrics[0].name #=> String, one of "Cpu", "Memory", "EBS_READ_OPS_PER_SECOND", "EBS_WRITE_OPS_PER_SECOND", "EBS_READ_BYTES_PER_SECOND", "EBS_WRITE_BYTES_PER_SECOND", "DISK_READ_OPS_PER_SECOND", "DISK_WRITE_OPS_PER_SECOND", "DISK_READ_BYTES_PER_SECOND", "DISK_WRITE_BYTES_PER_SECOND", "NETWORK_IN_BYTES_PER_SECOND", "NETWORK_OUT_BYTES_PER_SECOND", "NETWORK_PACKETS_IN_PER_SECOND", "NETWORK_PACKETS_OUT_PER_SECOND"
|
726
1004
|
# resp.auto_scaling_group_recommendations[0].utilization_metrics[0].statistic #=> String, one of "Maximum", "Average"
|
727
1005
|
# resp.auto_scaling_group_recommendations[0].utilization_metrics[0].value #=> Float
|
728
1006
|
# resp.auto_scaling_group_recommendations[0].look_back_period_in_days #=> Float
|
@@ -736,7 +1014,7 @@ module Aws::ComputeOptimizer
|
|
736
1014
|
# resp.auto_scaling_group_recommendations[0].recommendation_options[0].configuration.max_size #=> Integer
|
737
1015
|
# resp.auto_scaling_group_recommendations[0].recommendation_options[0].configuration.instance_type #=> String
|
738
1016
|
# resp.auto_scaling_group_recommendations[0].recommendation_options[0].projected_utilization_metrics #=> Array
|
739
|
-
# resp.auto_scaling_group_recommendations[0].recommendation_options[0].projected_utilization_metrics[0].name #=> String, one of "Cpu", "Memory", "EBS_READ_OPS_PER_SECOND", "EBS_WRITE_OPS_PER_SECOND", "EBS_READ_BYTES_PER_SECOND", "EBS_WRITE_BYTES_PER_SECOND"
|
1017
|
+
# resp.auto_scaling_group_recommendations[0].recommendation_options[0].projected_utilization_metrics[0].name #=> String, one of "Cpu", "Memory", "EBS_READ_OPS_PER_SECOND", "EBS_WRITE_OPS_PER_SECOND", "EBS_READ_BYTES_PER_SECOND", "EBS_WRITE_BYTES_PER_SECOND", "DISK_READ_OPS_PER_SECOND", "DISK_WRITE_OPS_PER_SECOND", "DISK_READ_BYTES_PER_SECOND", "DISK_WRITE_BYTES_PER_SECOND", "NETWORK_IN_BYTES_PER_SECOND", "NETWORK_OUT_BYTES_PER_SECOND", "NETWORK_PACKETS_IN_PER_SECOND", "NETWORK_PACKETS_OUT_PER_SECOND"
|
740
1018
|
# resp.auto_scaling_group_recommendations[0].recommendation_options[0].projected_utilization_metrics[0].statistic #=> String, one of "Maximum", "Average"
|
741
1019
|
# resp.auto_scaling_group_recommendations[0].recommendation_options[0].projected_utilization_metrics[0].value #=> Float
|
742
1020
|
# resp.auto_scaling_group_recommendations[0].recommendation_options[0].performance_risk #=> Float
|
@@ -911,7 +1189,7 @@ module Aws::ComputeOptimizer
|
|
911
1189
|
# max_results: 1,
|
912
1190
|
# filters: [
|
913
1191
|
# {
|
914
|
-
# name: "Finding", # accepts Finding, RecommendationSourceType
|
1192
|
+
# name: "Finding", # accepts Finding, FindingReasonCodes, RecommendationSourceType
|
915
1193
|
# values: ["FilterValue"],
|
916
1194
|
# },
|
917
1195
|
# ],
|
@@ -927,17 +1205,21 @@ module Aws::ComputeOptimizer
|
|
927
1205
|
# resp.instance_recommendations[0].instance_name #=> String
|
928
1206
|
# resp.instance_recommendations[0].current_instance_type #=> String
|
929
1207
|
# resp.instance_recommendations[0].finding #=> String, one of "Underprovisioned", "Overprovisioned", "Optimized", "NotOptimized"
|
1208
|
+
# resp.instance_recommendations[0].finding_reason_codes #=> Array
|
1209
|
+
# resp.instance_recommendations[0].finding_reason_codes[0] #=> String, one of "CPUOverprovisioned", "CPUUnderprovisioned", "MemoryOverprovisioned", "MemoryUnderprovisioned", "EBSThroughputOverprovisioned", "EBSThroughputUnderprovisioned", "EBSIOPSOverprovisioned", "EBSIOPSUnderprovisioned", "NetworkBandwidthOverprovisioned", "NetworkBandwidthUnderprovisioned", "NetworkPPSOverprovisioned", "NetworkPPSUnderprovisioned", "DiskIOPSOverprovisioned", "DiskIOPSUnderprovisioned", "DiskThroughputOverprovisioned", "DiskThroughputUnderprovisioned"
|
930
1210
|
# resp.instance_recommendations[0].utilization_metrics #=> Array
|
931
|
-
# resp.instance_recommendations[0].utilization_metrics[0].name #=> String, one of "Cpu", "Memory", "EBS_READ_OPS_PER_SECOND", "EBS_WRITE_OPS_PER_SECOND", "EBS_READ_BYTES_PER_SECOND", "EBS_WRITE_BYTES_PER_SECOND"
|
1211
|
+
# resp.instance_recommendations[0].utilization_metrics[0].name #=> String, one of "Cpu", "Memory", "EBS_READ_OPS_PER_SECOND", "EBS_WRITE_OPS_PER_SECOND", "EBS_READ_BYTES_PER_SECOND", "EBS_WRITE_BYTES_PER_SECOND", "DISK_READ_OPS_PER_SECOND", "DISK_WRITE_OPS_PER_SECOND", "DISK_READ_BYTES_PER_SECOND", "DISK_WRITE_BYTES_PER_SECOND", "NETWORK_IN_BYTES_PER_SECOND", "NETWORK_OUT_BYTES_PER_SECOND", "NETWORK_PACKETS_IN_PER_SECOND", "NETWORK_PACKETS_OUT_PER_SECOND"
|
932
1212
|
# resp.instance_recommendations[0].utilization_metrics[0].statistic #=> String, one of "Maximum", "Average"
|
933
1213
|
# resp.instance_recommendations[0].utilization_metrics[0].value #=> Float
|
934
1214
|
# resp.instance_recommendations[0].look_back_period_in_days #=> Float
|
935
1215
|
# resp.instance_recommendations[0].recommendation_options #=> Array
|
936
1216
|
# resp.instance_recommendations[0].recommendation_options[0].instance_type #=> String
|
937
1217
|
# resp.instance_recommendations[0].recommendation_options[0].projected_utilization_metrics #=> Array
|
938
|
-
# resp.instance_recommendations[0].recommendation_options[0].projected_utilization_metrics[0].name #=> String, one of "Cpu", "Memory", "EBS_READ_OPS_PER_SECOND", "EBS_WRITE_OPS_PER_SECOND", "EBS_READ_BYTES_PER_SECOND", "EBS_WRITE_BYTES_PER_SECOND"
|
1218
|
+
# resp.instance_recommendations[0].recommendation_options[0].projected_utilization_metrics[0].name #=> String, one of "Cpu", "Memory", "EBS_READ_OPS_PER_SECOND", "EBS_WRITE_OPS_PER_SECOND", "EBS_READ_BYTES_PER_SECOND", "EBS_WRITE_BYTES_PER_SECOND", "DISK_READ_OPS_PER_SECOND", "DISK_WRITE_OPS_PER_SECOND", "DISK_READ_BYTES_PER_SECOND", "DISK_WRITE_BYTES_PER_SECOND", "NETWORK_IN_BYTES_PER_SECOND", "NETWORK_OUT_BYTES_PER_SECOND", "NETWORK_PACKETS_IN_PER_SECOND", "NETWORK_PACKETS_OUT_PER_SECOND"
|
939
1219
|
# resp.instance_recommendations[0].recommendation_options[0].projected_utilization_metrics[0].statistic #=> String, one of "Maximum", "Average"
|
940
1220
|
# resp.instance_recommendations[0].recommendation_options[0].projected_utilization_metrics[0].value #=> Float
|
1221
|
+
# resp.instance_recommendations[0].recommendation_options[0].platform_differences #=> Array
|
1222
|
+
# resp.instance_recommendations[0].recommendation_options[0].platform_differences[0] #=> String, one of "Hypervisor", "NetworkInterface", "StorageInterface", "InstanceStoreAvailability", "VirtualizationType"
|
941
1223
|
# resp.instance_recommendations[0].recommendation_options[0].performance_risk #=> Float
|
942
1224
|
# resp.instance_recommendations[0].recommendation_options[0].rank #=> Integer
|
943
1225
|
# resp.instance_recommendations[0].recommendation_sources #=> Array
|
@@ -1009,7 +1291,7 @@ module Aws::ComputeOptimizer
|
|
1009
1291
|
# resp.recommended_option_projected_metrics[0].recommended_instance_type #=> String
|
1010
1292
|
# resp.recommended_option_projected_metrics[0].rank #=> Integer
|
1011
1293
|
# resp.recommended_option_projected_metrics[0].projected_metrics #=> Array
|
1012
|
-
# resp.recommended_option_projected_metrics[0].projected_metrics[0].name #=> String, one of "Cpu", "Memory", "EBS_READ_OPS_PER_SECOND", "EBS_WRITE_OPS_PER_SECOND", "EBS_READ_BYTES_PER_SECOND", "EBS_WRITE_BYTES_PER_SECOND"
|
1294
|
+
# resp.recommended_option_projected_metrics[0].projected_metrics[0].name #=> String, one of "Cpu", "Memory", "EBS_READ_OPS_PER_SECOND", "EBS_WRITE_OPS_PER_SECOND", "EBS_READ_BYTES_PER_SECOND", "EBS_WRITE_BYTES_PER_SECOND", "DISK_READ_OPS_PER_SECOND", "DISK_WRITE_OPS_PER_SECOND", "DISK_READ_BYTES_PER_SECOND", "DISK_WRITE_BYTES_PER_SECOND", "NETWORK_IN_BYTES_PER_SECOND", "NETWORK_OUT_BYTES_PER_SECOND", "NETWORK_PACKETS_IN_PER_SECOND", "NETWORK_PACKETS_OUT_PER_SECOND"
|
1013
1295
|
# resp.recommended_option_projected_metrics[0].projected_metrics[0].timestamps #=> Array
|
1014
1296
|
# resp.recommended_option_projected_metrics[0].projected_metrics[0].timestamps[0] #=> Time
|
1015
1297
|
# resp.recommended_option_projected_metrics[0].projected_metrics[0].values #=> Array
|
@@ -1238,17 +1520,17 @@ module Aws::ComputeOptimizer
|
|
1238
1520
|
# You must have the appropriate permissions to opt in to Compute
|
1239
1521
|
# Optimizer, to view its recommendations, and to opt out. For more
|
1240
1522
|
# information, see [Controlling access with AWS Identity and Access
|
1241
|
-
# Management][1] in the *Compute Optimizer User Guide*.
|
1523
|
+
# Management][1] in the *AWS Compute Optimizer User Guide*.
|
1242
1524
|
#
|
1243
1525
|
# When you opt in, Compute Optimizer automatically creates a
|
1244
1526
|
# Service-Linked Role in your account to access its data. For more
|
1245
1527
|
# information, see [Using Service-Linked Roles for AWS Compute
|
1246
|
-
# Optimizer][2] in the *Compute Optimizer User Guide*.
|
1528
|
+
# Optimizer][2] in the *AWS Compute Optimizer User Guide*.
|
1247
1529
|
#
|
1248
1530
|
#
|
1249
1531
|
#
|
1250
|
-
# [1]: https://docs.aws.amazon.com/compute-optimizer/ug/security-iam.html
|
1251
|
-
# [2]: https://docs.aws.amazon.com/compute-optimizer/ug/using-service-linked-roles.html
|
1532
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html
|
1533
|
+
# [2]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/using-service-linked-roles.html
|
1252
1534
|
#
|
1253
1535
|
# @option params [required, String] :status
|
1254
1536
|
# The new enrollment status of the account.
|
@@ -1259,7 +1541,7 @@ module Aws::ComputeOptimizer
|
|
1259
1541
|
# Compute Optimizer begins analyzing the configuration and utilization
|
1260
1542
|
# metrics of your AWS resources after you opt in. For more
|
1261
1543
|
# information, see [Metrics analyzed by AWS Compute Optimizer][1] in
|
1262
|
-
# the *Compute Optimizer User Guide*.
|
1544
|
+
# the *AWS Compute Optimizer User Guide*.
|
1263
1545
|
#
|
1264
1546
|
# * `Inactive` - Opts out your account from the Compute Optimizer
|
1265
1547
|
# service. Your account's recommendations and related metrics data
|
@@ -1273,7 +1555,7 @@ module Aws::ComputeOptimizer
|
|
1273
1555
|
#
|
1274
1556
|
#
|
1275
1557
|
#
|
1276
|
-
# [1]: https://docs.aws.amazon.com/compute-optimizer/ug/metrics.html
|
1558
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html
|
1277
1559
|
#
|
1278
1560
|
# @option params [Boolean] :include_member_accounts
|
1279
1561
|
# Indicates whether to enroll member accounts of the organization if the
|
@@ -1318,7 +1600,7 @@ module Aws::ComputeOptimizer
|
|
1318
1600
|
params: params,
|
1319
1601
|
config: config)
|
1320
1602
|
context[:gem_name] = 'aws-sdk-computeoptimizer'
|
1321
|
-
context[:gem_version] = '1.
|
1603
|
+
context[:gem_version] = '1.20.0'
|
1322
1604
|
Seahorse::Client::Request.new(handlers, context)
|
1323
1605
|
end
|
1324
1606
|
|