aws-sdk-computeoptimizer 1.70.0 → 1.71.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/client.rb +257 -11
- data/lib/aws-sdk-computeoptimizer/client_api.rb +156 -0
- data/lib/aws-sdk-computeoptimizer/types.rb +563 -3
- data/lib/aws-sdk-computeoptimizer.rb +1 -1
- data/sig/client.rbs +53 -4
- data/sig/types.rbs +115 -9
- metadata +2 -2
@@ -2007,6 +2007,121 @@ module Aws::ComputeOptimizer
|
|
2007
2007
|
include Aws::Structure
|
2008
2008
|
end
|
2009
2009
|
|
2010
|
+
# @!attribute [rw] account_ids
|
2011
|
+
# The Amazon Web Services account IDs for the export idle resource
|
2012
|
+
# recommendations.
|
2013
|
+
#
|
2014
|
+
# If your account is the management account or the delegated
|
2015
|
+
# administrator of an organization, use this parameter to specify the
|
2016
|
+
# member account you want to export recommendations to.
|
2017
|
+
#
|
2018
|
+
# This parameter can't be specified together with the include member
|
2019
|
+
# accounts parameter. The parameters are mutually exclusive.
|
2020
|
+
#
|
2021
|
+
# If this parameter or the include member accounts parameter is
|
2022
|
+
# omitted, the recommendations for member accounts aren't included in
|
2023
|
+
# the export.
|
2024
|
+
#
|
2025
|
+
# You can specify multiple account IDs per request.
|
2026
|
+
# @return [Array<String>]
|
2027
|
+
#
|
2028
|
+
# @!attribute [rw] filters
|
2029
|
+
# An array of objects to specify a filter that exports a more specific
|
2030
|
+
# set of idle resource recommendations.
|
2031
|
+
# @return [Array<Types::IdleRecommendationFilter>]
|
2032
|
+
#
|
2033
|
+
# @!attribute [rw] fields_to_export
|
2034
|
+
# The recommendations data to include in the export file. For more
|
2035
|
+
# information about the fields that can be exported, see [Exported
|
2036
|
+
# files][1] in the *Compute Optimizer User Guide*.
|
2037
|
+
#
|
2038
|
+
#
|
2039
|
+
#
|
2040
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files
|
2041
|
+
# @return [Array<String>]
|
2042
|
+
#
|
2043
|
+
# @!attribute [rw] s3_destination_config
|
2044
|
+
# Describes the destination Amazon Simple Storage Service (Amazon S3)
|
2045
|
+
# bucket name and key prefix for a recommendations export job.
|
2046
|
+
#
|
2047
|
+
# You must create the destination Amazon S3 bucket for your
|
2048
|
+
# recommendations export before you create the export job. Compute
|
2049
|
+
# Optimizer does not create the S3 bucket for you. After you create
|
2050
|
+
# the S3 bucket, ensure that it has the required permission policy to
|
2051
|
+
# allow Compute Optimizer to write the export file to it. If you plan
|
2052
|
+
# to specify an object prefix when you create the export job, you must
|
2053
|
+
# include the object prefix in the policy that you add to the S3
|
2054
|
+
# bucket. For more information, see [Amazon S3 Bucket Policy for
|
2055
|
+
# Compute Optimizer][1] in the *Compute Optimizer User Guide*.
|
2056
|
+
#
|
2057
|
+
#
|
2058
|
+
#
|
2059
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/create-s3-bucket-policy-for-compute-optimizer.html
|
2060
|
+
# @return [Types::S3DestinationConfig]
|
2061
|
+
#
|
2062
|
+
# @!attribute [rw] file_format
|
2063
|
+
# The format of the export file. The CSV file is the only export file
|
2064
|
+
# format currently supported.
|
2065
|
+
# @return [String]
|
2066
|
+
#
|
2067
|
+
# @!attribute [rw] include_member_accounts
|
2068
|
+
# If your account is the management account or the delegated
|
2069
|
+
# administrator of an organization, this parameter indicates whether
|
2070
|
+
# to include recommendations for resources in all member accounts of
|
2071
|
+
# the organization.
|
2072
|
+
#
|
2073
|
+
# The member accounts must also be opted in to Compute Optimizer, and
|
2074
|
+
# trusted access for Compute Optimizer must be enabled in the
|
2075
|
+
# organization account. For more information, see [Compute Optimizer
|
2076
|
+
# and Amazon Web Services Organizations trusted access][1] in the
|
2077
|
+
# *Compute Optimizer User Guide*.
|
2078
|
+
#
|
2079
|
+
# If this parameter is omitted, recommendations for member accounts of
|
2080
|
+
# the organization aren't included in the export file.
|
2081
|
+
#
|
2082
|
+
# If this parameter or the account ID parameter is omitted,
|
2083
|
+
# recommendations for member accounts aren't included in the export.
|
2084
|
+
#
|
2085
|
+
#
|
2086
|
+
#
|
2087
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access
|
2088
|
+
# @return [Boolean]
|
2089
|
+
#
|
2090
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/ExportIdleRecommendationsRequest AWS API Documentation
|
2091
|
+
#
|
2092
|
+
class ExportIdleRecommendationsRequest < Struct.new(
|
2093
|
+
:account_ids,
|
2094
|
+
:filters,
|
2095
|
+
:fields_to_export,
|
2096
|
+
:s3_destination_config,
|
2097
|
+
:file_format,
|
2098
|
+
:include_member_accounts)
|
2099
|
+
SENSITIVE = []
|
2100
|
+
include Aws::Structure
|
2101
|
+
end
|
2102
|
+
|
2103
|
+
# @!attribute [rw] job_id
|
2104
|
+
# The identification number of the export job.
|
2105
|
+
#
|
2106
|
+
# To view the status of an export job, use the
|
2107
|
+
# DescribeRecommendationExportJobs action and specify the job ID.
|
2108
|
+
# @return [String]
|
2109
|
+
#
|
2110
|
+
# @!attribute [rw] s3_destination
|
2111
|
+
# Describes the destination Amazon Simple Storage Service (Amazon S3)
|
2112
|
+
# bucket name and object keys of a recommendations export file, and
|
2113
|
+
# its associated metadata file.
|
2114
|
+
# @return [Types::S3Destination]
|
2115
|
+
#
|
2116
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/ExportIdleRecommendationsResponse AWS API Documentation
|
2117
|
+
#
|
2118
|
+
class ExportIdleRecommendationsResponse < Struct.new(
|
2119
|
+
:job_id,
|
2120
|
+
:s3_destination)
|
2121
|
+
SENSITIVE = []
|
2122
|
+
include Aws::Structure
|
2123
|
+
end
|
2124
|
+
|
2010
2125
|
# @!attribute [rw] account_ids
|
2011
2126
|
# The IDs of the Amazon Web Services accounts for which to export
|
2012
2127
|
# Lambda function recommendations.
|
@@ -3168,6 +3283,79 @@ module Aws::ComputeOptimizer
|
|
3168
3283
|
include Aws::Structure
|
3169
3284
|
end
|
3170
3285
|
|
3286
|
+
# @!attribute [rw] resource_arns
|
3287
|
+
# The ARN that identifies the idle resource.
|
3288
|
+
# @return [Array<String>]
|
3289
|
+
#
|
3290
|
+
# @!attribute [rw] next_token
|
3291
|
+
# The token to advance to the next page of idle resource
|
3292
|
+
# recommendations.
|
3293
|
+
# @return [String]
|
3294
|
+
#
|
3295
|
+
# @!attribute [rw] max_results
|
3296
|
+
# The maximum number of idle resource recommendations to return with a
|
3297
|
+
# single request.
|
3298
|
+
#
|
3299
|
+
# To retrieve the remaining results, make another request with the
|
3300
|
+
# returned `nextToken` value.
|
3301
|
+
# @return [Integer]
|
3302
|
+
#
|
3303
|
+
# @!attribute [rw] filters
|
3304
|
+
# An array of objects to specify a filter that returns a more specific
|
3305
|
+
# list of idle resource recommendations.
|
3306
|
+
# @return [Array<Types::IdleRecommendationFilter>]
|
3307
|
+
#
|
3308
|
+
# @!attribute [rw] account_ids
|
3309
|
+
# Return the idle resource recommendations to the specified Amazon Web
|
3310
|
+
# Services account IDs.
|
3311
|
+
#
|
3312
|
+
# If your account is the management account or the delegated
|
3313
|
+
# administrator of an organization, use this parameter to return the
|
3314
|
+
# idle resource recommendations to specific member accounts.
|
3315
|
+
#
|
3316
|
+
# You can only specify one account ID per request.
|
3317
|
+
# @return [Array<String>]
|
3318
|
+
#
|
3319
|
+
# @!attribute [rw] order_by
|
3320
|
+
# The order to sort the idle resource recommendations.
|
3321
|
+
# @return [Types::OrderBy]
|
3322
|
+
#
|
3323
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/GetIdleRecommendationsRequest AWS API Documentation
|
3324
|
+
#
|
3325
|
+
class GetIdleRecommendationsRequest < Struct.new(
|
3326
|
+
:resource_arns,
|
3327
|
+
:next_token,
|
3328
|
+
:max_results,
|
3329
|
+
:filters,
|
3330
|
+
:account_ids,
|
3331
|
+
:order_by)
|
3332
|
+
SENSITIVE = []
|
3333
|
+
include Aws::Structure
|
3334
|
+
end
|
3335
|
+
|
3336
|
+
# @!attribute [rw] next_token
|
3337
|
+
# The token to advance to the next page of idle resource
|
3338
|
+
# recommendations.
|
3339
|
+
# @return [String]
|
3340
|
+
#
|
3341
|
+
# @!attribute [rw] idle_recommendations
|
3342
|
+
# An array of objects that describe the idle resource recommendations.
|
3343
|
+
# @return [Array<Types::IdleRecommendation>]
|
3344
|
+
#
|
3345
|
+
# @!attribute [rw] errors
|
3346
|
+
# An array of objects that describe errors of the request.
|
3347
|
+
# @return [Array<Types::IdleRecommendationError>]
|
3348
|
+
#
|
3349
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/GetIdleRecommendationsResponse AWS API Documentation
|
3350
|
+
#
|
3351
|
+
class GetIdleRecommendationsResponse < Struct.new(
|
3352
|
+
:next_token,
|
3353
|
+
:idle_recommendations,
|
3354
|
+
:errors)
|
3355
|
+
SENSITIVE = []
|
3356
|
+
include Aws::Structure
|
3357
|
+
end
|
3358
|
+
|
3171
3359
|
# @!attribute [rw] function_arns
|
3172
3360
|
# The Amazon Resource Name (ARN) of the functions for which to return
|
3173
3361
|
# recommendations.
|
@@ -3642,6 +3830,277 @@ module Aws::ComputeOptimizer
|
|
3642
3830
|
include Aws::Structure
|
3643
3831
|
end
|
3644
3832
|
|
3833
|
+
# Describes the estimated monthly savings possible for idle resources by
|
3834
|
+
# adopting Compute Optimizer recommendations.
|
3835
|
+
#
|
3836
|
+
# @!attribute [rw] currency
|
3837
|
+
# The currency of the estimated monthly savings.
|
3838
|
+
# @return [String]
|
3839
|
+
#
|
3840
|
+
# @!attribute [rw] value
|
3841
|
+
# The value of the estimated monthly savings for Idle resources.
|
3842
|
+
# @return [Float]
|
3843
|
+
#
|
3844
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/IdleEstimatedMonthlySavings AWS API Documentation
|
3845
|
+
#
|
3846
|
+
class IdleEstimatedMonthlySavings < Struct.new(
|
3847
|
+
:currency,
|
3848
|
+
:value)
|
3849
|
+
SENSITIVE = []
|
3850
|
+
include Aws::Structure
|
3851
|
+
end
|
3852
|
+
|
3853
|
+
# Describes an Idle resource recommendation.
|
3854
|
+
#
|
3855
|
+
# @!attribute [rw] resource_arn
|
3856
|
+
# The ARN of the current idle resource.
|
3857
|
+
# @return [String]
|
3858
|
+
#
|
3859
|
+
# @!attribute [rw] resource_id
|
3860
|
+
# The unique identifier for the resource.
|
3861
|
+
# @return [String]
|
3862
|
+
#
|
3863
|
+
# @!attribute [rw] resource_type
|
3864
|
+
# The type of resource that is idle.
|
3865
|
+
# @return [String]
|
3866
|
+
#
|
3867
|
+
# @!attribute [rw] account_id
|
3868
|
+
# The Amazon Web Services account ID of the idle resource.
|
3869
|
+
# @return [String]
|
3870
|
+
#
|
3871
|
+
# @!attribute [rw] finding
|
3872
|
+
# The finding classification of an idle resource.
|
3873
|
+
# @return [String]
|
3874
|
+
#
|
3875
|
+
# @!attribute [rw] finding_description
|
3876
|
+
# A summary of the findings for the resource.
|
3877
|
+
# @return [String]
|
3878
|
+
#
|
3879
|
+
# @!attribute [rw] savings_opportunity
|
3880
|
+
# The savings opportunity for the idle resource.
|
3881
|
+
# @return [Types::IdleSavingsOpportunity]
|
3882
|
+
#
|
3883
|
+
# @!attribute [rw] savings_opportunity_after_discounts
|
3884
|
+
# The savings opportunity for the idle resource after any applying
|
3885
|
+
# discounts.
|
3886
|
+
# @return [Types::IdleSavingsOpportunityAfterDiscounts]
|
3887
|
+
#
|
3888
|
+
# @!attribute [rw] utilization_metrics
|
3889
|
+
# An array of objects that describe the utilization metrics of the
|
3890
|
+
# idle resource.
|
3891
|
+
# @return [Array<Types::IdleUtilizationMetric>]
|
3892
|
+
#
|
3893
|
+
# @!attribute [rw] look_back_period_in_days
|
3894
|
+
# The number of days the idle resource utilization metrics were
|
3895
|
+
# analyzed.
|
3896
|
+
# @return [Float]
|
3897
|
+
#
|
3898
|
+
# @!attribute [rw] last_refresh_timestamp
|
3899
|
+
# The timestamp of when the idle resource recommendation was last
|
3900
|
+
# generated.
|
3901
|
+
# @return [Time]
|
3902
|
+
#
|
3903
|
+
# @!attribute [rw] tags
|
3904
|
+
# A list of tags assigned to your idle resource recommendations.
|
3905
|
+
# @return [Array<Types::Tag>]
|
3906
|
+
#
|
3907
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/IdleRecommendation AWS API Documentation
|
3908
|
+
#
|
3909
|
+
class IdleRecommendation < Struct.new(
|
3910
|
+
:resource_arn,
|
3911
|
+
:resource_id,
|
3912
|
+
:resource_type,
|
3913
|
+
:account_id,
|
3914
|
+
:finding,
|
3915
|
+
:finding_description,
|
3916
|
+
:savings_opportunity,
|
3917
|
+
:savings_opportunity_after_discounts,
|
3918
|
+
:utilization_metrics,
|
3919
|
+
:look_back_period_in_days,
|
3920
|
+
:last_refresh_timestamp,
|
3921
|
+
:tags)
|
3922
|
+
SENSITIVE = []
|
3923
|
+
include Aws::Structure
|
3924
|
+
end
|
3925
|
+
|
3926
|
+
# Returns of list of resources that doesn't have idle recommendations.
|
3927
|
+
#
|
3928
|
+
# @!attribute [rw] identifier
|
3929
|
+
# The ID of the error.
|
3930
|
+
# @return [String]
|
3931
|
+
#
|
3932
|
+
# @!attribute [rw] code
|
3933
|
+
# The error code.
|
3934
|
+
# @return [String]
|
3935
|
+
#
|
3936
|
+
# @!attribute [rw] message
|
3937
|
+
# The error message.
|
3938
|
+
# @return [String]
|
3939
|
+
#
|
3940
|
+
# @!attribute [rw] resource_type
|
3941
|
+
# The type of resource associated with the error.
|
3942
|
+
# @return [String]
|
3943
|
+
#
|
3944
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/IdleRecommendationError AWS API Documentation
|
3945
|
+
#
|
3946
|
+
class IdleRecommendationError < Struct.new(
|
3947
|
+
:identifier,
|
3948
|
+
:code,
|
3949
|
+
:message,
|
3950
|
+
:resource_type)
|
3951
|
+
SENSITIVE = []
|
3952
|
+
include Aws::Structure
|
3953
|
+
end
|
3954
|
+
|
3955
|
+
# Describes a filter that returns a more specific list of idle resource
|
3956
|
+
# recommendations.
|
3957
|
+
#
|
3958
|
+
# @!attribute [rw] name
|
3959
|
+
# The name of the filter.
|
3960
|
+
#
|
3961
|
+
# Specify `Finding` to return recommendations with a specific finding
|
3962
|
+
# classification.
|
3963
|
+
#
|
3964
|
+
# You can filter your idle resource recommendations by `tag:key` and
|
3965
|
+
# `tag-key` tags.
|
3966
|
+
#
|
3967
|
+
# A `tag:key` is a key and value combination of a tag assigned to your
|
3968
|
+
# idle resource recommendations. Use the tag key in the filter name
|
3969
|
+
# and the tag value as the filter value. For example, to find all idle
|
3970
|
+
# resource service recommendations that have a tag with the key of
|
3971
|
+
# `Owner` and the value of `TeamA`, specify `tag:Owner` for the filter
|
3972
|
+
# name and `TeamA` for the filter value.
|
3973
|
+
#
|
3974
|
+
# A `tag-key` is the key of a tag assigned to your idle resource
|
3975
|
+
# recommendations. Use this filter to find all of your idle resource
|
3976
|
+
# recommendations that have a tag with a specific key. This doesn’t
|
3977
|
+
# consider the tag value. For example, you can find your idle resource
|
3978
|
+
# service recommendations with a tag key value of `Owner` or without
|
3979
|
+
# any tag keys assigned.
|
3980
|
+
# @return [String]
|
3981
|
+
#
|
3982
|
+
# @!attribute [rw] values
|
3983
|
+
# The value of the filter.
|
3984
|
+
# @return [Array<String>]
|
3985
|
+
#
|
3986
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/IdleRecommendationFilter AWS API Documentation
|
3987
|
+
#
|
3988
|
+
class IdleRecommendationFilter < Struct.new(
|
3989
|
+
:name,
|
3990
|
+
:values)
|
3991
|
+
SENSITIVE = []
|
3992
|
+
include Aws::Structure
|
3993
|
+
end
|
3994
|
+
|
3995
|
+
# Describes the savings opportunity for idle resource recommendations.
|
3996
|
+
#
|
3997
|
+
# @!attribute [rw] savings_opportunity_percentage
|
3998
|
+
# The estimated monthly savings possible as a percentage of monthly
|
3999
|
+
# cost by adopting Compute Optimizer's idle resource recommendations.
|
4000
|
+
# @return [Float]
|
4001
|
+
#
|
4002
|
+
# @!attribute [rw] estimated_monthly_savings
|
4003
|
+
# The estimated monthly savings possible by adopting Compute
|
4004
|
+
# Optimizer's idle resource recommendations.
|
4005
|
+
# @return [Types::IdleEstimatedMonthlySavings]
|
4006
|
+
#
|
4007
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/IdleSavingsOpportunity AWS API Documentation
|
4008
|
+
#
|
4009
|
+
class IdleSavingsOpportunity < Struct.new(
|
4010
|
+
:savings_opportunity_percentage,
|
4011
|
+
:estimated_monthly_savings)
|
4012
|
+
SENSITIVE = []
|
4013
|
+
include Aws::Structure
|
4014
|
+
end
|
4015
|
+
|
4016
|
+
# Describes the savings opportunity for idle resource recommendations
|
4017
|
+
# after applying discounts.
|
4018
|
+
#
|
4019
|
+
# Savings opportunity represents the estimated monthly savings after
|
4020
|
+
# applying discounts. You can achieve this by implementing a given
|
4021
|
+
# Compute Optimizer recommendation.
|
4022
|
+
#
|
4023
|
+
# @!attribute [rw] savings_opportunity_percentage
|
4024
|
+
# The estimated monthly savings possible as a percentage of monthly
|
4025
|
+
# cost by adopting Compute Optimizer's idle resource recommendations.
|
4026
|
+
# This includes any applicable discounts.
|
4027
|
+
# @return [Float]
|
4028
|
+
#
|
4029
|
+
# @!attribute [rw] estimated_monthly_savings
|
4030
|
+
# The estimated monthly savings possible by adopting Compute
|
4031
|
+
# Optimizer's idle resource recommendations. This includes any
|
4032
|
+
# applicable discounts.
|
4033
|
+
# @return [Types::IdleEstimatedMonthlySavings]
|
4034
|
+
#
|
4035
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/IdleSavingsOpportunityAfterDiscounts AWS API Documentation
|
4036
|
+
#
|
4037
|
+
class IdleSavingsOpportunityAfterDiscounts < Struct.new(
|
4038
|
+
:savings_opportunity_percentage,
|
4039
|
+
:estimated_monthly_savings)
|
4040
|
+
SENSITIVE = []
|
4041
|
+
include Aws::Structure
|
4042
|
+
end
|
4043
|
+
|
4044
|
+
# Describes the findings summary of the idle resources.
|
4045
|
+
#
|
4046
|
+
# @!attribute [rw] name
|
4047
|
+
# The name of the finding group for the idle resources.
|
4048
|
+
# @return [String]
|
4049
|
+
#
|
4050
|
+
# @!attribute [rw] value
|
4051
|
+
# The count of idle resources in the finding group.
|
4052
|
+
# @return [Float]
|
4053
|
+
#
|
4054
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/IdleSummary AWS API Documentation
|
4055
|
+
#
|
4056
|
+
class IdleSummary < Struct.new(
|
4057
|
+
:name,
|
4058
|
+
:value)
|
4059
|
+
SENSITIVE = []
|
4060
|
+
include Aws::Structure
|
4061
|
+
end
|
4062
|
+
|
4063
|
+
# Describes the utilization metric of an idle resource.
|
4064
|
+
#
|
4065
|
+
# @!attribute [rw] name
|
4066
|
+
# The name of the utilization metric.
|
4067
|
+
# @return [String]
|
4068
|
+
#
|
4069
|
+
# @!attribute [rw] statistic
|
4070
|
+
# The statistic of the utilization metric.
|
4071
|
+
#
|
4072
|
+
# The Compute Optimizer API, Command Line Interface (CLI), and SDKs
|
4073
|
+
# return utilization metrics using only the `Maximum` statistic, which
|
4074
|
+
# is the highest value observed during the specified period.
|
4075
|
+
#
|
4076
|
+
# The Compute Optimizer console displays graphs for some utilization
|
4077
|
+
# metrics using the `Average` statistic, which is the value of `Sum` /
|
4078
|
+
# `SampleCount` during the specified period. For more information, see
|
4079
|
+
# [Viewing resource recommendations][1] in the *Compute Optimizer User
|
4080
|
+
# Guide*. You can also get averaged utilization metric data for your
|
4081
|
+
# resources using Amazon CloudWatch. For more information, see the
|
4082
|
+
# [Amazon CloudWatch User Guide][2].
|
4083
|
+
#
|
4084
|
+
#
|
4085
|
+
#
|
4086
|
+
# [1]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html
|
4087
|
+
# [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html
|
4088
|
+
# @return [String]
|
4089
|
+
#
|
4090
|
+
# @!attribute [rw] value
|
4091
|
+
# The value of the utilization metric.
|
4092
|
+
# @return [Float]
|
4093
|
+
#
|
4094
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/IdleUtilizationMetric AWS API Documentation
|
4095
|
+
#
|
4096
|
+
class IdleUtilizationMetric < Struct.new(
|
4097
|
+
:name,
|
4098
|
+
:statistic,
|
4099
|
+
:value)
|
4100
|
+
SENSITIVE = []
|
4101
|
+
include Aws::Structure
|
4102
|
+
end
|
4103
|
+
|
3645
4104
|
# The estimated monthly savings after you adjust the configurations of
|
3646
4105
|
# your instances running on the inferred workload types to the
|
3647
4106
|
# recommended configurations. If the `inferredWorkloadTypes` list
|
@@ -5082,6 +5541,25 @@ module Aws::ComputeOptimizer
|
|
5082
5541
|
include Aws::Structure
|
5083
5542
|
end
|
5084
5543
|
|
5544
|
+
# Describes how the recommendations are ordered.
|
5545
|
+
#
|
5546
|
+
# @!attribute [rw] dimension
|
5547
|
+
# The dimension values to sort the recommendations.
|
5548
|
+
# @return [String]
|
5549
|
+
#
|
5550
|
+
# @!attribute [rw] order
|
5551
|
+
# The order to sort the recommendations.
|
5552
|
+
# @return [String]
|
5553
|
+
#
|
5554
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/OrderBy AWS API Documentation
|
5555
|
+
#
|
5556
|
+
class OrderBy < Struct.new(
|
5557
|
+
:dimension,
|
5558
|
+
:order)
|
5559
|
+
SENSITIVE = []
|
5560
|
+
include Aws::Structure
|
5561
|
+
end
|
5562
|
+
|
5085
5563
|
# The preference to control which resource type values are considered
|
5086
5564
|
# when generating rightsizing recommendations. You can specify this
|
5087
5565
|
# preference as a combination of include and exclude lists. You must
|
@@ -5498,6 +5976,10 @@ module Aws::ComputeOptimizer
|
|
5498
5976
|
# The database engine version.
|
5499
5977
|
# @return [String]
|
5500
5978
|
#
|
5979
|
+
# @!attribute [rw] promotion_tier
|
5980
|
+
# The promotion tier for the Aurora instance.
|
5981
|
+
# @return [Integer]
|
5982
|
+
#
|
5501
5983
|
# @!attribute [rw] current_db_instance_class
|
5502
5984
|
# The DB instance class of the current RDS instance.
|
5503
5985
|
# @return [String]
|
@@ -5506,6 +5988,10 @@ module Aws::ComputeOptimizer
|
|
5506
5988
|
# The configuration of the current RDS storage.
|
5507
5989
|
# @return [Types::DBStorageConfiguration]
|
5508
5990
|
#
|
5991
|
+
# @!attribute [rw] db_cluster_identifier
|
5992
|
+
# The identifier for DB cluster.
|
5993
|
+
# @return [String]
|
5994
|
+
#
|
5509
5995
|
# @!attribute [rw] idle
|
5510
5996
|
# This indicates if the RDS instance is idle or not.
|
5511
5997
|
# @return [String]
|
@@ -5550,6 +6036,10 @@ module Aws::ComputeOptimizer
|
|
5550
6036
|
# The reason for the finding classification of an Amazon RDS instance.
|
5551
6037
|
# @return [Array<String>]
|
5552
6038
|
#
|
6039
|
+
# @!attribute [rw] current_instance_performance_risk
|
6040
|
+
# The performance risk for the current DB instance.
|
6041
|
+
# @return [String]
|
6042
|
+
#
|
5553
6043
|
# @!attribute [rw] storage_finding_reason_codes
|
5554
6044
|
# The reason for the finding classification of Amazon RDS storage.
|
5555
6045
|
# @return [Array<String>]
|
@@ -5593,12 +6083,15 @@ module Aws::ComputeOptimizer
|
|
5593
6083
|
:account_id,
|
5594
6084
|
:engine,
|
5595
6085
|
:engine_version,
|
6086
|
+
:promotion_tier,
|
5596
6087
|
:current_db_instance_class,
|
5597
6088
|
:current_storage_configuration,
|
6089
|
+
:db_cluster_identifier,
|
5598
6090
|
:idle,
|
5599
6091
|
:instance_finding,
|
5600
6092
|
:storage_finding,
|
5601
6093
|
:instance_finding_reason_codes,
|
6094
|
+
:current_instance_performance_risk,
|
5602
6095
|
:storage_finding_reason_codes,
|
5603
6096
|
:instance_recommendation_options,
|
5604
6097
|
:storage_recommendation_options,
|
@@ -6210,6 +6703,10 @@ module Aws::ComputeOptimizer
|
|
6210
6703
|
# An array of objects that describe a recommendation summary.
|
6211
6704
|
# @return [Array<Types::Summary>]
|
6212
6705
|
#
|
6706
|
+
# @!attribute [rw] idle_summaries
|
6707
|
+
# Describes the findings summary of the idle resources.
|
6708
|
+
# @return [Array<Types::IdleSummary>]
|
6709
|
+
#
|
6213
6710
|
# @!attribute [rw] recommendation_resource_type
|
6214
6711
|
# The resource type that the recommendation summary applies to.
|
6215
6712
|
# @return [String]
|
@@ -6224,6 +6721,58 @@ module Aws::ComputeOptimizer
|
|
6224
6721
|
# savings amount and percentage.
|
6225
6722
|
# @return [Types::SavingsOpportunity]
|
6226
6723
|
#
|
6724
|
+
# @!attribute [rw] idle_savings_opportunity
|
6725
|
+
# Describes the savings opportunity for recommendations of a given
|
6726
|
+
# resource type or for the recommendation option of an individual
|
6727
|
+
# resource.
|
6728
|
+
#
|
6729
|
+
# Savings opportunity represents the estimated monthly savings you can
|
6730
|
+
# achieve by implementing a given Compute Optimizer recommendation.
|
6731
|
+
#
|
6732
|
+
# Savings opportunity data requires that you opt in to Cost Explorer,
|
6733
|
+
# as well as activate **Receive Amazon EC2 resource recommendations**
|
6734
|
+
# in the Cost Explorer preferences page. That creates a connection
|
6735
|
+
# between Cost Explorer and Compute Optimizer. With this connection,
|
6736
|
+
# Cost Explorer generates savings estimates considering the price of
|
6737
|
+
# existing resources, the price of recommended resources, and
|
6738
|
+
# historical usage data. Estimated monthly savings reflects the
|
6739
|
+
# projected dollar savings associated with each of the recommendations
|
6740
|
+
# generated. For more information, see [Enabling Cost Explorer][1] and
|
6741
|
+
# [Optimizing your cost with Rightsizing Recommendations][2] in the
|
6742
|
+
# *Cost Management User Guide*.
|
6743
|
+
#
|
6744
|
+
#
|
6745
|
+
#
|
6746
|
+
# [1]: https://docs.aws.amazon.com/cost-management/latest/userguide/ce-enable.html
|
6747
|
+
# [2]: https://docs.aws.amazon.com/cost-management/latest/userguide/ce-rightsizing.html
|
6748
|
+
# @return [Types::SavingsOpportunity]
|
6749
|
+
#
|
6750
|
+
# @!attribute [rw] aggregated_savings_opportunity
|
6751
|
+
# Describes the savings opportunity for recommendations of a given
|
6752
|
+
# resource type or for the recommendation option of an individual
|
6753
|
+
# resource.
|
6754
|
+
#
|
6755
|
+
# Savings opportunity represents the estimated monthly savings you can
|
6756
|
+
# achieve by implementing a given Compute Optimizer recommendation.
|
6757
|
+
#
|
6758
|
+
# Savings opportunity data requires that you opt in to Cost Explorer,
|
6759
|
+
# as well as activate **Receive Amazon EC2 resource recommendations**
|
6760
|
+
# in the Cost Explorer preferences page. That creates a connection
|
6761
|
+
# between Cost Explorer and Compute Optimizer. With this connection,
|
6762
|
+
# Cost Explorer generates savings estimates considering the price of
|
6763
|
+
# existing resources, the price of recommended resources, and
|
6764
|
+
# historical usage data. Estimated monthly savings reflects the
|
6765
|
+
# projected dollar savings associated with each of the recommendations
|
6766
|
+
# generated. For more information, see [Enabling Cost Explorer][1] and
|
6767
|
+
# [Optimizing your cost with Rightsizing Recommendations][2] in the
|
6768
|
+
# *Cost Management User Guide*.
|
6769
|
+
#
|
6770
|
+
#
|
6771
|
+
#
|
6772
|
+
# [1]: https://docs.aws.amazon.com/cost-management/latest/userguide/ce-enable.html
|
6773
|
+
# [2]: https://docs.aws.amazon.com/cost-management/latest/userguide/ce-rightsizing.html
|
6774
|
+
# @return [Types::SavingsOpportunity]
|
6775
|
+
#
|
6227
6776
|
# @!attribute [rw] current_performance_risk_ratings
|
6228
6777
|
# An object that describes the performance risk ratings for a given
|
6229
6778
|
# resource type.
|
@@ -6240,9 +6789,12 @@ module Aws::ComputeOptimizer
|
|
6240
6789
|
#
|
6241
6790
|
class RecommendationSummary < Struct.new(
|
6242
6791
|
:summaries,
|
6792
|
+
:idle_summaries,
|
6243
6793
|
:recommendation_resource_type,
|
6244
6794
|
:account_id,
|
6245
6795
|
:savings_opportunity,
|
6796
|
+
:idle_savings_opportunity,
|
6797
|
+
:aggregated_savings_opportunity,
|
6246
6798
|
:current_performance_risk_ratings,
|
6247
6799
|
:inferred_workload_savings)
|
6248
6800
|
SENSITIVE = []
|
@@ -6866,9 +7418,17 @@ module Aws::ComputeOptimizer
|
|
6866
7418
|
# @!attribute [rw] volume_type
|
6867
7419
|
# The volume type.
|
6868
7420
|
#
|
6869
|
-
#
|
6870
|
-
#
|
6871
|
-
#
|
7421
|
+
# The volume types can be the following:
|
7422
|
+
#
|
7423
|
+
# * General Purpose SSD `gp2` and `gp3`
|
7424
|
+
#
|
7425
|
+
# * Provisioned IOPS SSD `io1`, `io2`, and `io2 Block Express`
|
7426
|
+
#
|
7427
|
+
# * Throughput Optimized HDD `st1`
|
7428
|
+
#
|
7429
|
+
# * Cold HDD `sc1`
|
7430
|
+
#
|
7431
|
+
# * Magnetic volumes `standard`
|
6872
7432
|
# @return [String]
|
6873
7433
|
#
|
6874
7434
|
# @!attribute [rw] volume_size
|