aws-sdk-computeoptimizer 1.16.0 → 1.17.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-computeoptimizer.rb +1 -1
- data/lib/aws-sdk-computeoptimizer/client.rb +288 -10
- data/lib/aws-sdk-computeoptimizer/client_api.rb +68 -0
- data/lib/aws-sdk-computeoptimizer/types.rb +296 -4
- metadata +5 -6
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 8e2ae0e5b6a86979f6e6198d6ec6aacdda648640028f47efd297920c89b5d337
|
4
|
+
data.tar.gz: a3106d82962e78924dd3bc66d1a5d677e350bfdfcd548b61157f608e2b98f080
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7e59fbbb9a9e06f6c68fa884dfce3ac26cebc3de4c4f080d1d831f7444da2116b872a09944850cb17a511cb38b15aebe15b0a335f6f15242a8a9b61a202d71ea
|
7
|
+
data.tar.gz: e4a133f78fcdac0d6e1dbe8d2aea703fe35003aaecd3511a44879e268905b3995aeedd2b7f875ce56ebb755e7c9914dccfdd6f3c750a9774384fb6114958a902
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.17.0 (2021-05-18)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release enables compute optimizer to support exporting recommendations to Amazon S3 for EBS volumes and Lambda Functions.
|
8
|
+
|
4
9
|
1.16.0 (2021-03-10)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.17.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
|
@@ -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
|
@@ -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
|
@@ -1238,17 +1516,17 @@ module Aws::ComputeOptimizer
|
|
1238
1516
|
# You must have the appropriate permissions to opt in to Compute
|
1239
1517
|
# Optimizer, to view its recommendations, and to opt out. For more
|
1240
1518
|
# information, see [Controlling access with AWS Identity and Access
|
1241
|
-
# Management][1] in the *Compute Optimizer User Guide*.
|
1519
|
+
# Management][1] in the *AWS Compute Optimizer User Guide*.
|
1242
1520
|
#
|
1243
1521
|
# When you opt in, Compute Optimizer automatically creates a
|
1244
1522
|
# Service-Linked Role in your account to access its data. For more
|
1245
1523
|
# information, see [Using Service-Linked Roles for AWS Compute
|
1246
|
-
# Optimizer][2] in the *Compute Optimizer User Guide*.
|
1524
|
+
# Optimizer][2] in the *AWS Compute Optimizer User Guide*.
|
1247
1525
|
#
|
1248
1526
|
#
|
1249
1527
|
#
|
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
|
1528
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html
|
1529
|
+
# [2]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/using-service-linked-roles.html
|
1252
1530
|
#
|
1253
1531
|
# @option params [required, String] :status
|
1254
1532
|
# The new enrollment status of the account.
|
@@ -1259,7 +1537,7 @@ module Aws::ComputeOptimizer
|
|
1259
1537
|
# Compute Optimizer begins analyzing the configuration and utilization
|
1260
1538
|
# metrics of your AWS resources after you opt in. For more
|
1261
1539
|
# information, see [Metrics analyzed by AWS Compute Optimizer][1] in
|
1262
|
-
# the *Compute Optimizer User Guide*.
|
1540
|
+
# the *AWS Compute Optimizer User Guide*.
|
1263
1541
|
#
|
1264
1542
|
# * `Inactive` - Opts out your account from the Compute Optimizer
|
1265
1543
|
# service. Your account's recommendations and related metrics data
|
@@ -1273,7 +1551,7 @@ module Aws::ComputeOptimizer
|
|
1273
1551
|
#
|
1274
1552
|
#
|
1275
1553
|
#
|
1276
|
-
# [1]: https://docs.aws.amazon.com/compute-optimizer/ug/metrics.html
|
1554
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html
|
1277
1555
|
#
|
1278
1556
|
# @option params [Boolean] :include_member_accounts
|
1279
1557
|
# Indicates whether to enroll member accounts of the organization if the
|
@@ -1318,7 +1596,7 @@ module Aws::ComputeOptimizer
|
|
1318
1596
|
params: params,
|
1319
1597
|
config: config)
|
1320
1598
|
context[:gem_name] = 'aws-sdk-computeoptimizer'
|
1321
|
-
context[:gem_version] = '1.
|
1599
|
+
context[:gem_version] = '1.17.0'
|
1322
1600
|
Seahorse::Client::Request.new(handlers, context)
|
1323
1601
|
end
|
1324
1602
|
|
@@ -44,12 +44,20 @@ module Aws::ComputeOptimizer
|
|
44
44
|
ExportAutoScalingGroupRecommendationsRequest = Shapes::StructureShape.new(name: 'ExportAutoScalingGroupRecommendationsRequest')
|
45
45
|
ExportAutoScalingGroupRecommendationsResponse = Shapes::StructureShape.new(name: 'ExportAutoScalingGroupRecommendationsResponse')
|
46
46
|
ExportDestination = Shapes::StructureShape.new(name: 'ExportDestination')
|
47
|
+
ExportEBSVolumeRecommendationsRequest = Shapes::StructureShape.new(name: 'ExportEBSVolumeRecommendationsRequest')
|
48
|
+
ExportEBSVolumeRecommendationsResponse = Shapes::StructureShape.new(name: 'ExportEBSVolumeRecommendationsResponse')
|
47
49
|
ExportEC2InstanceRecommendationsRequest = Shapes::StructureShape.new(name: 'ExportEC2InstanceRecommendationsRequest')
|
48
50
|
ExportEC2InstanceRecommendationsResponse = Shapes::StructureShape.new(name: 'ExportEC2InstanceRecommendationsResponse')
|
51
|
+
ExportLambdaFunctionRecommendationsRequest = Shapes::StructureShape.new(name: 'ExportLambdaFunctionRecommendationsRequest')
|
52
|
+
ExportLambdaFunctionRecommendationsResponse = Shapes::StructureShape.new(name: 'ExportLambdaFunctionRecommendationsResponse')
|
49
53
|
ExportableAutoScalingGroupField = Shapes::StringShape.new(name: 'ExportableAutoScalingGroupField')
|
50
54
|
ExportableAutoScalingGroupFields = Shapes::ListShape.new(name: 'ExportableAutoScalingGroupFields')
|
51
55
|
ExportableInstanceField = Shapes::StringShape.new(name: 'ExportableInstanceField')
|
52
56
|
ExportableInstanceFields = Shapes::ListShape.new(name: 'ExportableInstanceFields')
|
57
|
+
ExportableLambdaFunctionField = Shapes::StringShape.new(name: 'ExportableLambdaFunctionField')
|
58
|
+
ExportableLambdaFunctionFields = Shapes::ListShape.new(name: 'ExportableLambdaFunctionFields')
|
59
|
+
ExportableVolumeField = Shapes::StringShape.new(name: 'ExportableVolumeField')
|
60
|
+
ExportableVolumeFields = Shapes::ListShape.new(name: 'ExportableVolumeFields')
|
53
61
|
FailureReason = Shapes::StringShape.new(name: 'FailureReason')
|
54
62
|
FileFormat = Shapes::StringShape.new(name: 'FileFormat')
|
55
63
|
Filter = Shapes::StructureShape.new(name: 'Filter')
|
@@ -255,6 +263,18 @@ module Aws::ComputeOptimizer
|
|
255
263
|
ExportDestination.add_member(:s3, Shapes::ShapeRef.new(shape: S3Destination, location_name: "s3"))
|
256
264
|
ExportDestination.struct_class = Types::ExportDestination
|
257
265
|
|
266
|
+
ExportEBSVolumeRecommendationsRequest.add_member(:account_ids, Shapes::ShapeRef.new(shape: AccountIds, location_name: "accountIds"))
|
267
|
+
ExportEBSVolumeRecommendationsRequest.add_member(:filters, Shapes::ShapeRef.new(shape: EBSFilters, location_name: "filters"))
|
268
|
+
ExportEBSVolumeRecommendationsRequest.add_member(:fields_to_export, Shapes::ShapeRef.new(shape: ExportableVolumeFields, location_name: "fieldsToExport"))
|
269
|
+
ExportEBSVolumeRecommendationsRequest.add_member(:s3_destination_config, Shapes::ShapeRef.new(shape: S3DestinationConfig, required: true, location_name: "s3DestinationConfig"))
|
270
|
+
ExportEBSVolumeRecommendationsRequest.add_member(:file_format, Shapes::ShapeRef.new(shape: FileFormat, location_name: "fileFormat"))
|
271
|
+
ExportEBSVolumeRecommendationsRequest.add_member(:include_member_accounts, Shapes::ShapeRef.new(shape: IncludeMemberAccounts, location_name: "includeMemberAccounts"))
|
272
|
+
ExportEBSVolumeRecommendationsRequest.struct_class = Types::ExportEBSVolumeRecommendationsRequest
|
273
|
+
|
274
|
+
ExportEBSVolumeRecommendationsResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "jobId"))
|
275
|
+
ExportEBSVolumeRecommendationsResponse.add_member(:s3_destination, Shapes::ShapeRef.new(shape: S3Destination, location_name: "s3Destination"))
|
276
|
+
ExportEBSVolumeRecommendationsResponse.struct_class = Types::ExportEBSVolumeRecommendationsResponse
|
277
|
+
|
258
278
|
ExportEC2InstanceRecommendationsRequest.add_member(:account_ids, Shapes::ShapeRef.new(shape: AccountIds, location_name: "accountIds"))
|
259
279
|
ExportEC2InstanceRecommendationsRequest.add_member(:filters, Shapes::ShapeRef.new(shape: Filters, location_name: "filters"))
|
260
280
|
ExportEC2InstanceRecommendationsRequest.add_member(:fields_to_export, Shapes::ShapeRef.new(shape: ExportableInstanceFields, location_name: "fieldsToExport"))
|
@@ -267,10 +287,26 @@ module Aws::ComputeOptimizer
|
|
267
287
|
ExportEC2InstanceRecommendationsResponse.add_member(:s3_destination, Shapes::ShapeRef.new(shape: S3Destination, location_name: "s3Destination"))
|
268
288
|
ExportEC2InstanceRecommendationsResponse.struct_class = Types::ExportEC2InstanceRecommendationsResponse
|
269
289
|
|
290
|
+
ExportLambdaFunctionRecommendationsRequest.add_member(:account_ids, Shapes::ShapeRef.new(shape: AccountIds, location_name: "accountIds"))
|
291
|
+
ExportLambdaFunctionRecommendationsRequest.add_member(:filters, Shapes::ShapeRef.new(shape: LambdaFunctionRecommendationFilters, location_name: "filters"))
|
292
|
+
ExportLambdaFunctionRecommendationsRequest.add_member(:fields_to_export, Shapes::ShapeRef.new(shape: ExportableLambdaFunctionFields, location_name: "fieldsToExport"))
|
293
|
+
ExportLambdaFunctionRecommendationsRequest.add_member(:s3_destination_config, Shapes::ShapeRef.new(shape: S3DestinationConfig, required: true, location_name: "s3DestinationConfig"))
|
294
|
+
ExportLambdaFunctionRecommendationsRequest.add_member(:file_format, Shapes::ShapeRef.new(shape: FileFormat, location_name: "fileFormat"))
|
295
|
+
ExportLambdaFunctionRecommendationsRequest.add_member(:include_member_accounts, Shapes::ShapeRef.new(shape: IncludeMemberAccounts, location_name: "includeMemberAccounts"))
|
296
|
+
ExportLambdaFunctionRecommendationsRequest.struct_class = Types::ExportLambdaFunctionRecommendationsRequest
|
297
|
+
|
298
|
+
ExportLambdaFunctionRecommendationsResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "jobId"))
|
299
|
+
ExportLambdaFunctionRecommendationsResponse.add_member(:s3_destination, Shapes::ShapeRef.new(shape: S3Destination, location_name: "s3Destination"))
|
300
|
+
ExportLambdaFunctionRecommendationsResponse.struct_class = Types::ExportLambdaFunctionRecommendationsResponse
|
301
|
+
|
270
302
|
ExportableAutoScalingGroupFields.member = Shapes::ShapeRef.new(shape: ExportableAutoScalingGroupField)
|
271
303
|
|
272
304
|
ExportableInstanceFields.member = Shapes::ShapeRef.new(shape: ExportableInstanceField)
|
273
305
|
|
306
|
+
ExportableLambdaFunctionFields.member = Shapes::ShapeRef.new(shape: ExportableLambdaFunctionField)
|
307
|
+
|
308
|
+
ExportableVolumeFields.member = Shapes::ShapeRef.new(shape: ExportableVolumeField)
|
309
|
+
|
274
310
|
Filter.add_member(:name, Shapes::ShapeRef.new(shape: FilterName, location_name: "name"))
|
275
311
|
Filter.add_member(:values, Shapes::ShapeRef.new(shape: FilterValues, location_name: "values"))
|
276
312
|
Filter.struct_class = Types::Filter
|
@@ -622,6 +658,22 @@ module Aws::ComputeOptimizer
|
|
622
658
|
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
623
659
|
end)
|
624
660
|
|
661
|
+
api.add_operation(:export_ebs_volume_recommendations, Seahorse::Model::Operation.new.tap do |o|
|
662
|
+
o.name = "ExportEBSVolumeRecommendations"
|
663
|
+
o.http_method = "POST"
|
664
|
+
o.http_request_uri = "/"
|
665
|
+
o.input = Shapes::ShapeRef.new(shape: ExportEBSVolumeRecommendationsRequest)
|
666
|
+
o.output = Shapes::ShapeRef.new(shape: ExportEBSVolumeRecommendationsResponse)
|
667
|
+
o.errors << Shapes::ShapeRef.new(shape: OptInRequiredException)
|
668
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
669
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
670
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
671
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterValueException)
|
672
|
+
o.errors << Shapes::ShapeRef.new(shape: MissingAuthenticationToken)
|
673
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
674
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
675
|
+
end)
|
676
|
+
|
625
677
|
api.add_operation(:export_ec2_instance_recommendations, Seahorse::Model::Operation.new.tap do |o|
|
626
678
|
o.name = "ExportEC2InstanceRecommendations"
|
627
679
|
o.http_method = "POST"
|
@@ -638,6 +690,22 @@ module Aws::ComputeOptimizer
|
|
638
690
|
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
639
691
|
end)
|
640
692
|
|
693
|
+
api.add_operation(:export_lambda_function_recommendations, Seahorse::Model::Operation.new.tap do |o|
|
694
|
+
o.name = "ExportLambdaFunctionRecommendations"
|
695
|
+
o.http_method = "POST"
|
696
|
+
o.http_request_uri = "/"
|
697
|
+
o.input = Shapes::ShapeRef.new(shape: ExportLambdaFunctionRecommendationsRequest)
|
698
|
+
o.output = Shapes::ShapeRef.new(shape: ExportLambdaFunctionRecommendationsResponse)
|
699
|
+
o.errors << Shapes::ShapeRef.new(shape: OptInRequiredException)
|
700
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
701
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
702
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
703
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterValueException)
|
704
|
+
o.errors << Shapes::ShapeRef.new(shape: MissingAuthenticationToken)
|
705
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
706
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
707
|
+
end)
|
708
|
+
|
641
709
|
api.add_operation(:get_auto_scaling_group_recommendations, Seahorse::Model::Operation.new.tap do |o|
|
642
710
|
o.name = "GetAutoScalingGroupRecommendations"
|
643
711
|
o.http_method = "POST"
|
@@ -438,7 +438,11 @@ module Aws::ComputeOptimizer
|
|
438
438
|
# member accounts of the organization if your account is the
|
439
439
|
# management account of an organization.
|
440
440
|
#
|
441
|
-
# The member accounts must also be opted in to Compute Optimizer
|
441
|
+
# The member accounts must also be opted in to Compute Optimizer, and
|
442
|
+
# trusted access for Compute Optimizer must be enabled in the
|
443
|
+
# organization account. For more information, see [Compute Optimizer
|
444
|
+
# and AWS Organizations trusted access][1] in the *AWS Compute
|
445
|
+
# Optimizer User Guide*.
|
442
446
|
#
|
443
447
|
# Recommendations for member accounts of the organization are not
|
444
448
|
# included in the export file if this parameter is omitted.
|
@@ -448,6 +452,10 @@ module Aws::ComputeOptimizer
|
|
448
452
|
#
|
449
453
|
# Recommendations for member accounts are not included in the export
|
450
454
|
# if this parameter, or the account IDs parameter, is omitted.
|
455
|
+
#
|
456
|
+
#
|
457
|
+
#
|
458
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access
|
451
459
|
# @return [Boolean]
|
452
460
|
#
|
453
461
|
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/ExportAutoScalingGroupRecommendationsRequest AWS API Documentation
|
@@ -501,6 +509,144 @@ module Aws::ComputeOptimizer
|
|
501
509
|
include Aws::Structure
|
502
510
|
end
|
503
511
|
|
512
|
+
# @note When making an API call, you may pass ExportEBSVolumeRecommendationsRequest
|
513
|
+
# data as a hash:
|
514
|
+
#
|
515
|
+
# {
|
516
|
+
# account_ids: ["AccountId"],
|
517
|
+
# filters: [
|
518
|
+
# {
|
519
|
+
# name: "Finding", # accepts Finding
|
520
|
+
# values: ["FilterValue"],
|
521
|
+
# },
|
522
|
+
# ],
|
523
|
+
# 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
|
524
|
+
# s3_destination_config: { # required
|
525
|
+
# bucket: "DestinationBucket",
|
526
|
+
# key_prefix: "DestinationKeyPrefix",
|
527
|
+
# },
|
528
|
+
# file_format: "Csv", # accepts Csv
|
529
|
+
# include_member_accounts: false,
|
530
|
+
# }
|
531
|
+
#
|
532
|
+
# @!attribute [rw] account_ids
|
533
|
+
# The IDs of the AWS accounts for which to export Amazon EBS volume
|
534
|
+
# recommendations.
|
535
|
+
#
|
536
|
+
# If your account is the management account of an organization, use
|
537
|
+
# this parameter to specify the member account for which you want to
|
538
|
+
# export recommendations.
|
539
|
+
#
|
540
|
+
# This parameter cannot be specified together with the include member
|
541
|
+
# accounts parameter. The parameters are mutually exclusive.
|
542
|
+
#
|
543
|
+
# Recommendations for member accounts are not included in the export
|
544
|
+
# if this parameter, or the include member accounts parameter, is
|
545
|
+
# omitted.
|
546
|
+
#
|
547
|
+
# You can specify multiple account IDs per request.
|
548
|
+
# @return [Array<String>]
|
549
|
+
#
|
550
|
+
# @!attribute [rw] filters
|
551
|
+
# An array of objects that describe a filter to export a more specific
|
552
|
+
# set of Amazon EBS volume recommendations.
|
553
|
+
# @return [Array<Types::EBSFilter>]
|
554
|
+
#
|
555
|
+
# @!attribute [rw] fields_to_export
|
556
|
+
# The recommendations data to include in the export file. For more
|
557
|
+
# information about the fields that can be exported, see [Exported
|
558
|
+
# files][1] in the *Compute Optimizer User Guide*.
|
559
|
+
#
|
560
|
+
#
|
561
|
+
#
|
562
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files
|
563
|
+
# @return [Array<String>]
|
564
|
+
#
|
565
|
+
# @!attribute [rw] s3_destination_config
|
566
|
+
# Describes the destination Amazon Simple Storage Service (Amazon S3)
|
567
|
+
# bucket name and key prefix for a recommendations export job.
|
568
|
+
#
|
569
|
+
# You must create the destination Amazon S3 bucket for your
|
570
|
+
# recommendations export before you create the export job. Compute
|
571
|
+
# Optimizer does not create the S3 bucket for you. After you create
|
572
|
+
# the S3 bucket, ensure that it has the required permission policy to
|
573
|
+
# allow Compute Optimizer to write the export file to it. If you plan
|
574
|
+
# to specify an object prefix when you create the export job, you must
|
575
|
+
# include the object prefix in the policy that you add to the S3
|
576
|
+
# bucket. For more information, see [Amazon S3 Bucket Policy for
|
577
|
+
# Compute Optimizer][1] in the *Compute Optimizer user guide*.
|
578
|
+
#
|
579
|
+
#
|
580
|
+
#
|
581
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/create-s3-bucket-policy-for-compute-optimizer.html
|
582
|
+
# @return [Types::S3DestinationConfig]
|
583
|
+
#
|
584
|
+
# @!attribute [rw] file_format
|
585
|
+
# The format of the export file.
|
586
|
+
#
|
587
|
+
# The only export file format currently supported is `Csv`.
|
588
|
+
# @return [String]
|
589
|
+
#
|
590
|
+
# @!attribute [rw] include_member_accounts
|
591
|
+
# Indicates whether to include recommendations for resources in all
|
592
|
+
# member accounts of the organization if your account is the
|
593
|
+
# management account of an organization.
|
594
|
+
#
|
595
|
+
# The member accounts must also be opted in to Compute Optimizer, and
|
596
|
+
# trusted access for Compute Optimizer must be enabled in the
|
597
|
+
# organization account. For more information, see [Compute Optimizer
|
598
|
+
# and AWS Organizations trusted access][1] in the *AWS Compute
|
599
|
+
# Optimizer User Guide*.
|
600
|
+
#
|
601
|
+
# Recommendations for member accounts of the organization are not
|
602
|
+
# included in the export file if this parameter is omitted.
|
603
|
+
#
|
604
|
+
# This parameter cannot be specified together with the account IDs
|
605
|
+
# parameter. The parameters are mutually exclusive.
|
606
|
+
#
|
607
|
+
# Recommendations for member accounts are not included in the export
|
608
|
+
# if this parameter, or the account IDs parameter, is omitted.
|
609
|
+
#
|
610
|
+
#
|
611
|
+
#
|
612
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access
|
613
|
+
# @return [Boolean]
|
614
|
+
#
|
615
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/ExportEBSVolumeRecommendationsRequest AWS API Documentation
|
616
|
+
#
|
617
|
+
class ExportEBSVolumeRecommendationsRequest < Struct.new(
|
618
|
+
:account_ids,
|
619
|
+
:filters,
|
620
|
+
:fields_to_export,
|
621
|
+
:s3_destination_config,
|
622
|
+
:file_format,
|
623
|
+
:include_member_accounts)
|
624
|
+
SENSITIVE = []
|
625
|
+
include Aws::Structure
|
626
|
+
end
|
627
|
+
|
628
|
+
# @!attribute [rw] job_id
|
629
|
+
# The identification number of the export job.
|
630
|
+
#
|
631
|
+
# Use the `DescribeRecommendationExportJobs` action, and specify the
|
632
|
+
# job ID to view the status of an export job.
|
633
|
+
# @return [String]
|
634
|
+
#
|
635
|
+
# @!attribute [rw] s3_destination
|
636
|
+
# Describes the destination Amazon Simple Storage Service (Amazon S3)
|
637
|
+
# bucket name and object keys of a recommendations export file, and
|
638
|
+
# its associated metadata file.
|
639
|
+
# @return [Types::S3Destination]
|
640
|
+
#
|
641
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/ExportEBSVolumeRecommendationsResponse AWS API Documentation
|
642
|
+
#
|
643
|
+
class ExportEBSVolumeRecommendationsResponse < Struct.new(
|
644
|
+
:job_id,
|
645
|
+
:s3_destination)
|
646
|
+
SENSITIVE = []
|
647
|
+
include Aws::Structure
|
648
|
+
end
|
649
|
+
|
504
650
|
# @note When making an API call, you may pass ExportEC2InstanceRecommendationsRequest
|
505
651
|
# data as a hash:
|
506
652
|
#
|
@@ -584,13 +730,21 @@ module Aws::ComputeOptimizer
|
|
584
730
|
# member accounts of the organization if your account is the
|
585
731
|
# management account of an organization.
|
586
732
|
#
|
587
|
-
# The member accounts must also be opted in to Compute Optimizer
|
733
|
+
# The member accounts must also be opted in to Compute Optimizer, and
|
734
|
+
# trusted access for Compute Optimizer must be enabled in the
|
735
|
+
# organization account. For more information, see [Compute Optimizer
|
736
|
+
# and AWS Organizations trusted access][1] in the *AWS Compute
|
737
|
+
# Optimizer User Guide*.
|
588
738
|
#
|
589
739
|
# Recommendations for member accounts of the organization are not
|
590
740
|
# included in the export file if this parameter is omitted.
|
591
741
|
#
|
592
742
|
# Recommendations for member accounts are not included in the export
|
593
743
|
# if this parameter, or the account IDs parameter, is omitted.
|
744
|
+
#
|
745
|
+
#
|
746
|
+
#
|
747
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access
|
594
748
|
# @return [Boolean]
|
595
749
|
#
|
596
750
|
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/ExportEC2InstanceRecommendationsRequest AWS API Documentation
|
@@ -627,6 +781,144 @@ module Aws::ComputeOptimizer
|
|
627
781
|
include Aws::Structure
|
628
782
|
end
|
629
783
|
|
784
|
+
# @note When making an API call, you may pass ExportLambdaFunctionRecommendationsRequest
|
785
|
+
# data as a hash:
|
786
|
+
#
|
787
|
+
# {
|
788
|
+
# account_ids: ["AccountId"],
|
789
|
+
# filters: [
|
790
|
+
# {
|
791
|
+
# name: "Finding", # accepts Finding, FindingReasonCode
|
792
|
+
# values: ["FilterValue"],
|
793
|
+
# },
|
794
|
+
# ],
|
795
|
+
# 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
|
796
|
+
# s3_destination_config: { # required
|
797
|
+
# bucket: "DestinationBucket",
|
798
|
+
# key_prefix: "DestinationKeyPrefix",
|
799
|
+
# },
|
800
|
+
# file_format: "Csv", # accepts Csv
|
801
|
+
# include_member_accounts: false,
|
802
|
+
# }
|
803
|
+
#
|
804
|
+
# @!attribute [rw] account_ids
|
805
|
+
# The IDs of the AWS accounts for which to export Lambda function
|
806
|
+
# recommendations.
|
807
|
+
#
|
808
|
+
# If your account is the management account of an organization, use
|
809
|
+
# this parameter to specify the member account for which you want to
|
810
|
+
# export recommendations.
|
811
|
+
#
|
812
|
+
# This parameter cannot be specified together with the include member
|
813
|
+
# accounts parameter. The parameters are mutually exclusive.
|
814
|
+
#
|
815
|
+
# Recommendations for member accounts are not included in the export
|
816
|
+
# if this parameter, or the include member accounts parameter, is
|
817
|
+
# omitted.
|
818
|
+
#
|
819
|
+
# You can specify multiple account IDs per request.
|
820
|
+
# @return [Array<String>]
|
821
|
+
#
|
822
|
+
# @!attribute [rw] filters
|
823
|
+
# An array of objects that describe a filter to export a more specific
|
824
|
+
# set of Lambda function recommendations.
|
825
|
+
# @return [Array<Types::LambdaFunctionRecommendationFilter>]
|
826
|
+
#
|
827
|
+
# @!attribute [rw] fields_to_export
|
828
|
+
# The recommendations data to include in the export file. For more
|
829
|
+
# information about the fields that can be exported, see [Exported
|
830
|
+
# files][1] in the *Compute Optimizer User Guide*.
|
831
|
+
#
|
832
|
+
#
|
833
|
+
#
|
834
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files
|
835
|
+
# @return [Array<String>]
|
836
|
+
#
|
837
|
+
# @!attribute [rw] s3_destination_config
|
838
|
+
# Describes the destination Amazon Simple Storage Service (Amazon S3)
|
839
|
+
# bucket name and key prefix for a recommendations export job.
|
840
|
+
#
|
841
|
+
# You must create the destination Amazon S3 bucket for your
|
842
|
+
# recommendations export before you create the export job. Compute
|
843
|
+
# Optimizer does not create the S3 bucket for you. After you create
|
844
|
+
# the S3 bucket, ensure that it has the required permission policy to
|
845
|
+
# allow Compute Optimizer to write the export file to it. If you plan
|
846
|
+
# to specify an object prefix when you create the export job, you must
|
847
|
+
# include the object prefix in the policy that you add to the S3
|
848
|
+
# bucket. For more information, see [Amazon S3 Bucket Policy for
|
849
|
+
# Compute Optimizer][1] in the *Compute Optimizer user guide*.
|
850
|
+
#
|
851
|
+
#
|
852
|
+
#
|
853
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/create-s3-bucket-policy-for-compute-optimizer.html
|
854
|
+
# @return [Types::S3DestinationConfig]
|
855
|
+
#
|
856
|
+
# @!attribute [rw] file_format
|
857
|
+
# The format of the export file.
|
858
|
+
#
|
859
|
+
# The only export file format currently supported is `Csv`.
|
860
|
+
# @return [String]
|
861
|
+
#
|
862
|
+
# @!attribute [rw] include_member_accounts
|
863
|
+
# Indicates whether to include recommendations for resources in all
|
864
|
+
# member accounts of the organization if your account is the
|
865
|
+
# management account of an organization.
|
866
|
+
#
|
867
|
+
# The member accounts must also be opted in to Compute Optimizer, and
|
868
|
+
# trusted access for Compute Optimizer must be enabled in the
|
869
|
+
# organization account. For more information, see [Compute Optimizer
|
870
|
+
# and AWS Organizations trusted access][1] in the *AWS Compute
|
871
|
+
# Optimizer User Guide*.
|
872
|
+
#
|
873
|
+
# Recommendations for member accounts of the organization are not
|
874
|
+
# included in the export file if this parameter is omitted.
|
875
|
+
#
|
876
|
+
# This parameter cannot be specified together with the account IDs
|
877
|
+
# parameter. The parameters are mutually exclusive.
|
878
|
+
#
|
879
|
+
# Recommendations for member accounts are not included in the export
|
880
|
+
# if this parameter, or the account IDs parameter, is omitted.
|
881
|
+
#
|
882
|
+
#
|
883
|
+
#
|
884
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access
|
885
|
+
# @return [Boolean]
|
886
|
+
#
|
887
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/ExportLambdaFunctionRecommendationsRequest AWS API Documentation
|
888
|
+
#
|
889
|
+
class ExportLambdaFunctionRecommendationsRequest < Struct.new(
|
890
|
+
:account_ids,
|
891
|
+
:filters,
|
892
|
+
:fields_to_export,
|
893
|
+
:s3_destination_config,
|
894
|
+
:file_format,
|
895
|
+
:include_member_accounts)
|
896
|
+
SENSITIVE = []
|
897
|
+
include Aws::Structure
|
898
|
+
end
|
899
|
+
|
900
|
+
# @!attribute [rw] job_id
|
901
|
+
# The identification number of the export job.
|
902
|
+
#
|
903
|
+
# Use the `DescribeRecommendationExportJobs` action, and specify the
|
904
|
+
# job ID to view the status of an export job.
|
905
|
+
# @return [String]
|
906
|
+
#
|
907
|
+
# @!attribute [rw] s3_destination
|
908
|
+
# Describes the destination Amazon Simple Storage Service (Amazon S3)
|
909
|
+
# bucket name and object keys of a recommendations export file, and
|
910
|
+
# its associated metadata file.
|
911
|
+
# @return [Types::S3Destination]
|
912
|
+
#
|
913
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/ExportLambdaFunctionRecommendationsResponse AWS API Documentation
|
914
|
+
#
|
915
|
+
class ExportLambdaFunctionRecommendationsResponse < Struct.new(
|
916
|
+
:job_id,
|
917
|
+
:s3_destination)
|
918
|
+
SENSITIVE = []
|
919
|
+
include Aws::Structure
|
920
|
+
end
|
921
|
+
|
630
922
|
# Describes a filter that returns a more specific list of
|
631
923
|
# recommendations.
|
632
924
|
#
|
@@ -2147,7 +2439,7 @@ module Aws::ComputeOptimizer
|
|
2147
2439
|
# Compute Optimizer begins analyzing the configuration and
|
2148
2440
|
# utilization metrics of your AWS resources after you opt in. For
|
2149
2441
|
# more information, see [Metrics analyzed by AWS Compute
|
2150
|
-
# Optimizer][1] in the *Compute Optimizer User Guide*.
|
2442
|
+
# Optimizer][1] in the *AWS Compute Optimizer User Guide*.
|
2151
2443
|
#
|
2152
2444
|
# * `Inactive` - Opts out your account from the Compute Optimizer
|
2153
2445
|
# service. Your account's recommendations and related metrics data
|
@@ -2161,7 +2453,7 @@ module Aws::ComputeOptimizer
|
|
2161
2453
|
#
|
2162
2454
|
#
|
2163
2455
|
#
|
2164
|
-
# [1]: https://docs.aws.amazon.com/compute-optimizer/ug/metrics.html
|
2456
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html
|
2165
2457
|
# @return [String]
|
2166
2458
|
#
|
2167
2459
|
# @!attribute [rw] include_member_accounts
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-computeoptimizer
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.17.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2021-
|
11
|
+
date: 2021-05-18 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -66,8 +66,8 @@ homepage: https://github.com/aws/aws-sdk-ruby
|
|
66
66
|
licenses:
|
67
67
|
- Apache-2.0
|
68
68
|
metadata:
|
69
|
-
source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/
|
70
|
-
changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/
|
69
|
+
source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-computeoptimizer
|
70
|
+
changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-computeoptimizer/CHANGELOG.md
|
71
71
|
post_install_message:
|
72
72
|
rdoc_options: []
|
73
73
|
require_paths:
|
@@ -83,8 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
83
83
|
- !ruby/object:Gem::Version
|
84
84
|
version: '0'
|
85
85
|
requirements: []
|
86
|
-
|
87
|
-
rubygems_version: 2.7.6.2
|
86
|
+
rubygems_version: 3.1.6
|
88
87
|
signing_key:
|
89
88
|
specification_version: 4
|
90
89
|
summary: AWS SDK for Ruby - AWS Compute Optimizer
|