aws-sdk-costoptimizationhub 1.10.0 → 1.12.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-costoptimizationhub/client.rb +31 -7
- data/lib/aws-sdk-costoptimizationhub/client_api.rb +10 -0
- data/lib/aws-sdk-costoptimizationhub/types.rb +37 -4
- data/lib/aws-sdk-costoptimizationhub.rb +1 -1
- data/sig/client.rbs +3 -0
- data/sig/resource.rbs +1 -0
- data/sig/types.rbs +7 -0
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9d00522d6b282b63a8aa5fd0f41aed04899eea807e5a1263e5391fe36d0528b0
|
4
|
+
data.tar.gz: f7240bfadc3555ea17174da9e70c27e9987fe656e6d926c444385f566149b255
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: dc8c70e7f855f0b2868450d9cadae27968fb294ccab409b192a09aaa639ab813a6e62debce6c2e68e156715bded254a3762b60278f74eb1c793746754c91a7eb
|
7
|
+
data.tar.gz: 9e52393f5cf087d66e805a1eb8623430aba73c0a4a86b2de7cdfdc3f6f19951d20efbeb4cd0834a3c8111528bb5317cbe3f52776afe09087eaf45ba23903aede
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.12.0 (2024-09-03)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.11.0 (2024-08-06)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - This release adds savings percentage support to the ListRecommendationSummaries API.
|
13
|
+
|
4
14
|
1.10.0 (2024-07-02)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.12.0
|
@@ -32,6 +32,7 @@ require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
|
32
32
|
require 'aws-sdk-core/plugins/request_compression.rb'
|
33
33
|
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
34
34
|
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
35
|
+
require 'aws-sdk-core/plugins/telemetry.rb'
|
35
36
|
require 'aws-sdk-core/plugins/sign.rb'
|
36
37
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
37
38
|
|
@@ -83,6 +84,7 @@ module Aws::CostOptimizationHub
|
|
83
84
|
add_plugin(Aws::Plugins::RequestCompression)
|
84
85
|
add_plugin(Aws::Plugins::DefaultsMode)
|
85
86
|
add_plugin(Aws::Plugins::RecursionDetection)
|
87
|
+
add_plugin(Aws::Plugins::Telemetry)
|
86
88
|
add_plugin(Aws::Plugins::Sign)
|
87
89
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
88
90
|
add_plugin(Aws::CostOptimizationHub::Plugins::Endpoints)
|
@@ -337,6 +339,16 @@ module Aws::CostOptimizationHub
|
|
337
339
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
338
340
|
# requests are made, and retries are disabled.
|
339
341
|
#
|
342
|
+
# @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (Aws::Telemetry::NoOpTelemetryProvider)
|
343
|
+
# Allows you to provide a telemetry provider, which is used to
|
344
|
+
# emit telemetry data. By default, uses `NoOpTelemetryProvider` which
|
345
|
+
# will not record or emit any telemetry data. The SDK supports the
|
346
|
+
# following telemetry providers:
|
347
|
+
#
|
348
|
+
# * OpenTelemetry (OTel) - To use the OTel provider, install and require the
|
349
|
+
# `opentelemetry-sdk` gem and then, pass in an instance of a
|
350
|
+
# `Aws::Telemetry::OTelProvider` for telemetry provider.
|
351
|
+
#
|
340
352
|
# @option options [Aws::TokenProvider] :token_provider
|
341
353
|
# A Bearer Token Provider. This can be an instance of any one of the
|
342
354
|
# following classes:
|
@@ -1045,8 +1057,11 @@ module Aws::CostOptimizationHub
|
|
1045
1057
|
# The grouping of recommendations by a dimension.
|
1046
1058
|
#
|
1047
1059
|
# @option params [Integer] :max_results
|
1048
|
-
# The maximum number of recommendations
|
1049
|
-
#
|
1060
|
+
# The maximum number of recommendations to be returned for the request.
|
1061
|
+
#
|
1062
|
+
# @option params [Array<String>] :metrics
|
1063
|
+
# Additional metrics to be returned for the request. The only valid
|
1064
|
+
# value is `savingsPercentage`.
|
1050
1065
|
#
|
1051
1066
|
# @option params [String] :next_token
|
1052
1067
|
# The token to retrieve the next set of results.
|
@@ -1057,6 +1072,7 @@ module Aws::CostOptimizationHub
|
|
1057
1072
|
# * {Types::ListRecommendationSummariesResponse#items #items} => Array<Types::RecommendationSummary>
|
1058
1073
|
# * {Types::ListRecommendationSummariesResponse#group_by #data.group_by} => String (This method conflicts with a method on Response, call it through the data member)
|
1059
1074
|
# * {Types::ListRecommendationSummariesResponse#currency_code #currency_code} => String
|
1075
|
+
# * {Types::ListRecommendationSummariesResponse#metrics #metrics} => Types::SummaryMetricsResult
|
1060
1076
|
# * {Types::ListRecommendationSummariesResponse#next_token #next_token} => String
|
1061
1077
|
#
|
1062
1078
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
@@ -1084,6 +1100,7 @@ module Aws::CostOptimizationHub
|
|
1084
1100
|
# },
|
1085
1101
|
# group_by: "String", # required
|
1086
1102
|
# max_results: 1,
|
1103
|
+
# metrics: ["SavingsPercentage"], # accepts SavingsPercentage
|
1087
1104
|
# next_token: "String",
|
1088
1105
|
# })
|
1089
1106
|
#
|
@@ -1096,6 +1113,7 @@ module Aws::CostOptimizationHub
|
|
1096
1113
|
# resp.items[0].recommendation_count #=> Integer
|
1097
1114
|
# resp.data.group_by #=> String
|
1098
1115
|
# resp.currency_code #=> String
|
1116
|
+
# resp.metrics.savings_percentage #=> String
|
1099
1117
|
# resp.next_token #=> String
|
1100
1118
|
#
|
1101
1119
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cost-optimization-hub-2022-07-26/ListRecommendationSummaries AWS API Documentation
|
@@ -1203,8 +1221,9 @@ module Aws::CostOptimizationHub
|
|
1203
1221
|
# Updates the enrollment (opt in and opt out) status of an account to
|
1204
1222
|
# the Cost Optimization Hub service.
|
1205
1223
|
#
|
1206
|
-
# If the account is a management account
|
1207
|
-
# can also be used to enroll member
|
1224
|
+
# If the account is a management account or delegated administrator of
|
1225
|
+
# an organization, this action can also be used to enroll member
|
1226
|
+
# accounts of the organization.
|
1208
1227
|
#
|
1209
1228
|
# You must have the appropriate permissions to opt in to Cost
|
1210
1229
|
# Optimization Hub and to view its recommendations. When you opt in,
|
@@ -1216,7 +1235,7 @@ module Aws::CostOptimizationHub
|
|
1216
1235
|
#
|
1217
1236
|
# @option params [Boolean] :include_member_accounts
|
1218
1237
|
# Indicates whether to enroll member accounts of the organization if the
|
1219
|
-
# account is the management account.
|
1238
|
+
# account is the management account or delegated administrator.
|
1220
1239
|
#
|
1221
1240
|
# @return [Types::UpdateEnrollmentStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1222
1241
|
#
|
@@ -1284,14 +1303,19 @@ module Aws::CostOptimizationHub
|
|
1284
1303
|
# @api private
|
1285
1304
|
def build_request(operation_name, params = {})
|
1286
1305
|
handlers = @handlers.for(operation_name)
|
1306
|
+
tracer = config.telemetry_provider.tracer_provider.tracer(
|
1307
|
+
Aws::Telemetry.module_to_tracer_name('Aws::CostOptimizationHub')
|
1308
|
+
)
|
1287
1309
|
context = Seahorse::Client::RequestContext.new(
|
1288
1310
|
operation_name: operation_name,
|
1289
1311
|
operation: config.api.operation(operation_name),
|
1290
1312
|
client: self,
|
1291
1313
|
params: params,
|
1292
|
-
config: config
|
1314
|
+
config: config,
|
1315
|
+
tracer: tracer
|
1316
|
+
)
|
1293
1317
|
context[:gem_name] = 'aws-sdk-costoptimizationhub'
|
1294
|
-
context[:gem_version] = '1.
|
1318
|
+
context[:gem_version] = '1.12.0'
|
1295
1319
|
Seahorse::Client::Request.new(handlers, context)
|
1296
1320
|
end
|
1297
1321
|
|
@@ -103,6 +103,9 @@ module Aws::CostOptimizationHub
|
|
103
103
|
Source = Shapes::StringShape.new(name: 'Source')
|
104
104
|
StorageConfiguration = Shapes::StructureShape.new(name: 'StorageConfiguration')
|
105
105
|
String = Shapes::StringShape.new(name: 'String')
|
106
|
+
SummaryMetrics = Shapes::StringShape.new(name: 'SummaryMetrics')
|
107
|
+
SummaryMetricsList = Shapes::ListShape.new(name: 'SummaryMetricsList')
|
108
|
+
SummaryMetricsResult = Shapes::StructureShape.new(name: 'SummaryMetricsResult')
|
106
109
|
Tag = Shapes::StructureShape.new(name: 'Tag')
|
107
110
|
TagList = Shapes::ListShape.new(name: 'TagList')
|
108
111
|
ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
|
@@ -320,6 +323,7 @@ module Aws::CostOptimizationHub
|
|
320
323
|
ListRecommendationSummariesRequest.add_member(:filter, Shapes::ShapeRef.new(shape: Filter, location_name: "filter"))
|
321
324
|
ListRecommendationSummariesRequest.add_member(:group_by, Shapes::ShapeRef.new(shape: String, required: true, location_name: "groupBy"))
|
322
325
|
ListRecommendationSummariesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: ListRecommendationSummariesRequestMaxResultsInteger, location_name: "maxResults"))
|
326
|
+
ListRecommendationSummariesRequest.add_member(:metrics, Shapes::ShapeRef.new(shape: SummaryMetricsList, location_name: "metrics"))
|
323
327
|
ListRecommendationSummariesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "nextToken"))
|
324
328
|
ListRecommendationSummariesRequest.struct_class = Types::ListRecommendationSummariesRequest
|
325
329
|
|
@@ -327,6 +331,7 @@ module Aws::CostOptimizationHub
|
|
327
331
|
ListRecommendationSummariesResponse.add_member(:items, Shapes::ShapeRef.new(shape: RecommendationSummariesList, location_name: "items"))
|
328
332
|
ListRecommendationSummariesResponse.add_member(:group_by, Shapes::ShapeRef.new(shape: String, location_name: "groupBy"))
|
329
333
|
ListRecommendationSummariesResponse.add_member(:currency_code, Shapes::ShapeRef.new(shape: String, location_name: "currencyCode"))
|
334
|
+
ListRecommendationSummariesResponse.add_member(:metrics, Shapes::ShapeRef.new(shape: SummaryMetricsResult, location_name: "metrics"))
|
330
335
|
ListRecommendationSummariesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "nextToken"))
|
331
336
|
ListRecommendationSummariesResponse.struct_class = Types::ListRecommendationSummariesResponse
|
332
337
|
|
@@ -544,6 +549,11 @@ module Aws::CostOptimizationHub
|
|
544
549
|
StorageConfiguration.add_member(:size_in_gb, Shapes::ShapeRef.new(shape: Double, location_name: "sizeInGb"))
|
545
550
|
StorageConfiguration.struct_class = Types::StorageConfiguration
|
546
551
|
|
552
|
+
SummaryMetricsList.member = Shapes::ShapeRef.new(shape: SummaryMetrics)
|
553
|
+
|
554
|
+
SummaryMetricsResult.add_member(:savings_percentage, Shapes::ShapeRef.new(shape: String, location_name: "savingsPercentage"))
|
555
|
+
SummaryMetricsResult.struct_class = Types::SummaryMetricsResult
|
556
|
+
|
547
557
|
Tag.add_member(:key, Shapes::ShapeRef.new(shape: String, location_name: "key"))
|
548
558
|
Tag.add_member(:value, Shapes::ShapeRef.new(shape: String, location_name: "value"))
|
549
559
|
Tag.struct_class = Types::Tag
|
@@ -944,7 +944,7 @@ module Aws::CostOptimizationHub
|
|
944
944
|
#
|
945
945
|
# @!attribute [rw] include_member_accounts
|
946
946
|
# The enrollment status of all member accounts in the organization if
|
947
|
-
# the account is the management account.
|
947
|
+
# the account is the management account or delegated administrator.
|
948
948
|
# @return [Boolean]
|
949
949
|
#
|
950
950
|
# @!attribute [rw] next_token
|
@@ -971,10 +971,15 @@ module Aws::CostOptimizationHub
|
|
971
971
|
# @return [String]
|
972
972
|
#
|
973
973
|
# @!attribute [rw] max_results
|
974
|
-
# The maximum number of recommendations
|
974
|
+
# The maximum number of recommendations to be returned for the
|
975
975
|
# request.
|
976
976
|
# @return [Integer]
|
977
977
|
#
|
978
|
+
# @!attribute [rw] metrics
|
979
|
+
# Additional metrics to be returned for the request. The only valid
|
980
|
+
# value is `savingsPercentage`.
|
981
|
+
# @return [Array<String>]
|
982
|
+
#
|
978
983
|
# @!attribute [rw] next_token
|
979
984
|
# The token to retrieve the next set of results.
|
980
985
|
# @return [String]
|
@@ -985,6 +990,7 @@ module Aws::CostOptimizationHub
|
|
985
990
|
:filter,
|
986
991
|
:group_by,
|
987
992
|
:max_results,
|
993
|
+
:metrics,
|
988
994
|
:next_token)
|
989
995
|
SENSITIVE = []
|
990
996
|
include Aws::Structure
|
@@ -995,7 +1001,7 @@ module Aws::CostOptimizationHub
|
|
995
1001
|
# @return [Float]
|
996
1002
|
#
|
997
1003
|
# @!attribute [rw] items
|
998
|
-
#
|
1004
|
+
# A list of all savings recommendations.
|
999
1005
|
# @return [Array<Types::RecommendationSummary>]
|
1000
1006
|
#
|
1001
1007
|
# @!attribute [rw] group_by
|
@@ -1006,6 +1012,11 @@ module Aws::CostOptimizationHub
|
|
1006
1012
|
# The currency code used for the recommendation.
|
1007
1013
|
# @return [String]
|
1008
1014
|
#
|
1015
|
+
# @!attribute [rw] metrics
|
1016
|
+
# The results or descriptions for the additional metrics, based on
|
1017
|
+
# whether the metrics were or were not requested.
|
1018
|
+
# @return [Types::SummaryMetricsResult]
|
1019
|
+
#
|
1009
1020
|
# @!attribute [rw] next_token
|
1010
1021
|
# The token to retrieve the next set of results.
|
1011
1022
|
# @return [String]
|
@@ -1017,6 +1028,7 @@ module Aws::CostOptimizationHub
|
|
1017
1028
|
:items,
|
1018
1029
|
:group_by,
|
1019
1030
|
:currency_code,
|
1031
|
+
:metrics,
|
1020
1032
|
:next_token)
|
1021
1033
|
SENSITIVE = []
|
1022
1034
|
include Aws::Structure
|
@@ -1961,6 +1973,27 @@ module Aws::CostOptimizationHub
|
|
1961
1973
|
include Aws::Structure
|
1962
1974
|
end
|
1963
1975
|
|
1976
|
+
# The results or descriptions for the additional metrics, based on
|
1977
|
+
# whether the metrics were or were not requested.
|
1978
|
+
#
|
1979
|
+
# @!attribute [rw] savings_percentage
|
1980
|
+
# The savings percentage based on your Amazon Web Services spend over
|
1981
|
+
# the past 30 days.
|
1982
|
+
#
|
1983
|
+
# <note markdown="1"> Savings percentage is only supported when filtering by Region,
|
1984
|
+
# account ID, or tags.
|
1985
|
+
#
|
1986
|
+
# </note>
|
1987
|
+
# @return [String]
|
1988
|
+
#
|
1989
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cost-optimization-hub-2022-07-26/SummaryMetricsResult AWS API Documentation
|
1990
|
+
#
|
1991
|
+
class SummaryMetricsResult < Struct.new(
|
1992
|
+
:savings_percentage)
|
1993
|
+
SENSITIVE = []
|
1994
|
+
include Aws::Structure
|
1995
|
+
end
|
1996
|
+
|
1964
1997
|
# The tag structure that contains a tag key and value.
|
1965
1998
|
#
|
1966
1999
|
# @!attribute [rw] key
|
@@ -1999,7 +2032,7 @@ module Aws::CostOptimizationHub
|
|
1999
2032
|
#
|
2000
2033
|
# @!attribute [rw] include_member_accounts
|
2001
2034
|
# Indicates whether to enroll member accounts of the organization if
|
2002
|
-
# the account is the management account.
|
2035
|
+
# the account is the management account or delegated administrator.
|
2003
2036
|
# @return [Boolean]
|
2004
2037
|
#
|
2005
2038
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cost-optimization-hub-2022-07-26/UpdateEnrollmentStatusRequest AWS API Documentation
|
data/sig/client.rbs
CHANGED
@@ -51,6 +51,7 @@ module Aws
|
|
51
51
|
?sigv4a_signing_region_set: Array[String],
|
52
52
|
?simple_json: bool,
|
53
53
|
?stub_responses: untyped,
|
54
|
+
?telemetry_provider: Aws::Telemetry::TelemetryProviderBase,
|
54
55
|
?token_provider: untyped,
|
55
56
|
?use_dualstack_endpoint: bool,
|
56
57
|
?use_fips_endpoint: bool,
|
@@ -137,6 +138,7 @@ module Aws
|
|
137
138
|
def items: () -> ::Array[Types::RecommendationSummary]
|
138
139
|
def group_by: () -> ::String
|
139
140
|
def currency_code: () -> ::String
|
141
|
+
def metrics: () -> Types::SummaryMetricsResult
|
140
142
|
def next_token: () -> ::String
|
141
143
|
end
|
142
144
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CostOptimizationHub/Client.html#list_recommendation_summaries-instance_method
|
@@ -161,6 +163,7 @@ module Aws
|
|
161
163
|
},
|
162
164
|
group_by: ::String,
|
163
165
|
?max_results: ::Integer,
|
166
|
+
?metrics: Array[("SavingsPercentage")],
|
164
167
|
?next_token: ::String
|
165
168
|
) -> _ListRecommendationSummariesResponseSuccess
|
166
169
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListRecommendationSummariesResponseSuccess
|
data/sig/resource.rbs
CHANGED
@@ -51,6 +51,7 @@ module Aws
|
|
51
51
|
?sigv4a_signing_region_set: Array[String],
|
52
52
|
?simple_json: bool,
|
53
53
|
?stub_responses: untyped,
|
54
|
+
?telemetry_provider: Aws::Telemetry::TelemetryProviderBase,
|
54
55
|
?token_provider: untyped,
|
55
56
|
?use_dualstack_endpoint: bool,
|
56
57
|
?use_fips_endpoint: bool,
|
data/sig/types.rbs
CHANGED
@@ -268,6 +268,7 @@ module Aws::CostOptimizationHub
|
|
268
268
|
attr_accessor filter: Types::Filter
|
269
269
|
attr_accessor group_by: ::String
|
270
270
|
attr_accessor max_results: ::Integer
|
271
|
+
attr_accessor metrics: ::Array[("SavingsPercentage")]
|
271
272
|
attr_accessor next_token: ::String
|
272
273
|
SENSITIVE: []
|
273
274
|
end
|
@@ -277,6 +278,7 @@ module Aws::CostOptimizationHub
|
|
277
278
|
attr_accessor items: ::Array[Types::RecommendationSummary]
|
278
279
|
attr_accessor group_by: ::String
|
279
280
|
attr_accessor currency_code: ::String
|
281
|
+
attr_accessor metrics: Types::SummaryMetricsResult
|
280
282
|
attr_accessor next_token: ::String
|
281
283
|
SENSITIVE: []
|
282
284
|
end
|
@@ -550,6 +552,11 @@ module Aws::CostOptimizationHub
|
|
550
552
|
SENSITIVE: []
|
551
553
|
end
|
552
554
|
|
555
|
+
class SummaryMetricsResult
|
556
|
+
attr_accessor savings_percentage: ::String
|
557
|
+
SENSITIVE: []
|
558
|
+
end
|
559
|
+
|
553
560
|
class Tag
|
554
561
|
attr_accessor key: ::String
|
555
562
|
attr_accessor value: ::String
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-costoptimizationhub
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.12.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: 2024-
|
11
|
+
date: 2024-09-03 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.203.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.203.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|