aws-sdk-costoptimizationhub 1.10.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 135bc70edca4d75fec3f621683af73056fd455d5780f397bab90987e5adbe29e
-  data.tar.gz: 3ee10849af44381bc06de39a3dd76ef3a3e7b79d788bb34d92126ade58111fb1
+  metadata.gz: 32e5ed167b979230b9c9aa6ac376982480f3987ab60d4c934d07a20e513c28f5
+  data.tar.gz: 130e1fef533831d292f5cbebc73bcbddb0e7f319ea2d3642bce1e1e5226709fe
 SHA512:
-  metadata.gz: 01aea64cdae37a12b4951c921a7b92eec21ad65782eb70cb1e6d2a6ab56f4c6c358c009d45d53ba4b0f6a3929ccde35b2d2798df288ddcb460b7c98afe169d19
-  data.tar.gz: cf727f89e2588caa45f99a8e9e1bcf9fc99f084feaef5b1cb00320f5771de35b89886a8db2976e3f73770d51ddbc47b3c5b988d6e8bee97b8cf647e918b2abe5
+  metadata.gz: 418b88825ce2accab7807643fd9f7b55080025ccb84a014bb111746e9ddb93b68211d333256ed6cbe8fcc6c0d71ead87f7209d879e81d5cf90e7c7b4ed4c2ec6
+  data.tar.gz: 7a9c7dbfa837f43a9e02cfe3dd152c19cf7db03c5f671cb39b002f564325e90fac5e4e11be5d452407e16e71d09f66c5ec704623669d8b2297ad723859363096

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.11.0 (2024-08-06)
+------------------
+
+* Feature - This release adds savings percentage support to the ListRecommendationSummaries API.
+
 1.10.0 (2024-07-02)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.10.0
+1.11.0

data/lib/aws-sdk-costoptimizationhub/client.rb

@@ -1045,8 +1045,11 @@ module Aws::CostOptimizationHub
     #   The grouping of recommendations by a dimension.
     #
     # @option params [Integer] :max_results
-    #   The maximum number of recommendations that are returned for the
-    #   request.
+    #   The maximum number of recommendations to be returned for the request.
+    #
+    # @option params [Array<String>] :metrics
+    #   Additional metrics to be returned for the request. The only valid
+    #   value is `savingsPercentage`.
     #
     # @option params [String] :next_token
     #   The token to retrieve the next set of results.
@@ -1057,6 +1060,7 @@ module Aws::CostOptimizationHub
     #   * {Types::ListRecommendationSummariesResponse#items #items} => Array&lt;Types::RecommendationSummary&gt;
     #   * {Types::ListRecommendationSummariesResponse#group_by #data.group_by} => String (This method conflicts with a method on Response, call it through the data member)
     #   * {Types::ListRecommendationSummariesResponse#currency_code #currency_code} => String
+    #   * {Types::ListRecommendationSummariesResponse#metrics #metrics} => Types::SummaryMetricsResult
     #   * {Types::ListRecommendationSummariesResponse#next_token #next_token} => String
     #
     # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@@ -1084,6 +1088,7 @@ module Aws::CostOptimizationHub
     #     },
     #     group_by: "String", # required
     #     max_results: 1,
+    #     metrics: ["SavingsPercentage"], # accepts SavingsPercentage
     #     next_token: "String",
     #   })
     #
@@ -1096,6 +1101,7 @@ module Aws::CostOptimizationHub
     #   resp.items[0].recommendation_count #=> Integer
     #   resp.data.group_by #=> String
     #   resp.currency_code #=> String
+    #   resp.metrics.savings_percentage #=> String
     #   resp.next_token #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/cost-optimization-hub-2022-07-26/ListRecommendationSummaries AWS API Documentation
@@ -1203,8 +1209,9 @@ module Aws::CostOptimizationHub
     # Updates the enrollment (opt in and opt out) status of an account to
     # the Cost Optimization Hub service.
     #
-    # If the account is a management account of an organization, this action
-    # can also be used to enroll member accounts of the organization.
+    # If the account is a management account or delegated administrator of
+    # an organization, this action can also be used to enroll member
+    # accounts of the organization.
     #
     # You must have the appropriate permissions to opt in to Cost
     # Optimization Hub and to view its recommendations. When you opt in,
@@ -1216,7 +1223,7 @@ module Aws::CostOptimizationHub
     #
     # @option params [Boolean] :include_member_accounts
     #   Indicates whether to enroll member accounts of the organization if the
-    #   account is the management account.
+    #   account is the management account or delegated administrator.
     #
     # @return [Types::UpdateEnrollmentStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -1291,7 +1298,7 @@ module Aws::CostOptimizationHub
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-costoptimizationhub'
-      context[:gem_version] = '1.10.0'
+      context[:gem_version] = '1.11.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-costoptimizationhub/client_api.rb

@@ -103,6 +103,9 @@ module Aws::CostOptimizationHub
     Source = Shapes::StringShape.new(name: 'Source')
     StorageConfiguration = Shapes::StructureShape.new(name: 'StorageConfiguration')
     String = Shapes::StringShape.new(name: 'String')
+    SummaryMetrics = Shapes::StringShape.new(name: 'SummaryMetrics')
+    SummaryMetricsList = Shapes::ListShape.new(name: 'SummaryMetricsList')
+    SummaryMetricsResult = Shapes::StructureShape.new(name: 'SummaryMetricsResult')
     Tag = Shapes::StructureShape.new(name: 'Tag')
     TagList = Shapes::ListShape.new(name: 'TagList')
     ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
@@ -320,6 +323,7 @@ module Aws::CostOptimizationHub
     ListRecommendationSummariesRequest.add_member(:filter, Shapes::ShapeRef.new(shape: Filter, location_name: "filter"))
     ListRecommendationSummariesRequest.add_member(:group_by, Shapes::ShapeRef.new(shape: String, required: true, location_name: "groupBy"))
     ListRecommendationSummariesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: ListRecommendationSummariesRequestMaxResultsInteger, location_name: "maxResults"))
+    ListRecommendationSummariesRequest.add_member(:metrics, Shapes::ShapeRef.new(shape: SummaryMetricsList, location_name: "metrics"))
     ListRecommendationSummariesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "nextToken"))
     ListRecommendationSummariesRequest.struct_class = Types::ListRecommendationSummariesRequest
 
@@ -327,6 +331,7 @@ module Aws::CostOptimizationHub
     ListRecommendationSummariesResponse.add_member(:items, Shapes::ShapeRef.new(shape: RecommendationSummariesList, location_name: "items"))
     ListRecommendationSummariesResponse.add_member(:group_by, Shapes::ShapeRef.new(shape: String, location_name: "groupBy"))
     ListRecommendationSummariesResponse.add_member(:currency_code, Shapes::ShapeRef.new(shape: String, location_name: "currencyCode"))
+    ListRecommendationSummariesResponse.add_member(:metrics, Shapes::ShapeRef.new(shape: SummaryMetricsResult, location_name: "metrics"))
     ListRecommendationSummariesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "nextToken"))
     ListRecommendationSummariesResponse.struct_class = Types::ListRecommendationSummariesResponse
 
@@ -544,6 +549,11 @@ module Aws::CostOptimizationHub
     StorageConfiguration.add_member(:size_in_gb, Shapes::ShapeRef.new(shape: Double, location_name: "sizeInGb"))
     StorageConfiguration.struct_class = Types::StorageConfiguration
 
+    SummaryMetricsList.member = Shapes::ShapeRef.new(shape: SummaryMetrics)
+
+    SummaryMetricsResult.add_member(:savings_percentage, Shapes::ShapeRef.new(shape: String, location_name: "savingsPercentage"))
+    SummaryMetricsResult.struct_class = Types::SummaryMetricsResult
+
     Tag.add_member(:key, Shapes::ShapeRef.new(shape: String, location_name: "key"))
     Tag.add_member(:value, Shapes::ShapeRef.new(shape: String, location_name: "value"))
     Tag.struct_class = Types::Tag

data/lib/aws-sdk-costoptimizationhub/types.rb

@@ -944,7 +944,7 @@ module Aws::CostOptimizationHub
     #
     # @!attribute [rw] include_member_accounts
     #   The enrollment status of all member accounts in the organization if
-    #   the account is the management account.
+    #   the account is the management account or delegated administrator.
     #   @return [Boolean]
     #
     # @!attribute [rw] next_token
@@ -971,10 +971,15 @@ module Aws::CostOptimizationHub
     #   @return [String]
     #
     # @!attribute [rw] max_results
-    #   The maximum number of recommendations that are returned for the
+    #   The maximum number of recommendations to be returned for the
     #   request.
     #   @return [Integer]
     #
+    # @!attribute [rw] metrics
+    #   Additional metrics to be returned for the request. The only valid
+    #   value is `savingsPercentage`.
+    #   @return [Array<String>]
+    #
     # @!attribute [rw] next_token
     #   The token to retrieve the next set of results.
     #   @return [String]
@@ -985,6 +990,7 @@ module Aws::CostOptimizationHub
       :filter,
       :group_by,
       :max_results,
+      :metrics,
       :next_token)
       SENSITIVE = []
       include Aws::Structure
@@ -995,7 +1001,7 @@ module Aws::CostOptimizationHub
     #   @return [Float]
     #
     # @!attribute [rw] items
-    #   List of all savings recommendations.
+    #   A list of all savings recommendations.
     #   @return [Array<Types::RecommendationSummary>]
     #
     # @!attribute [rw] group_by
@@ -1006,6 +1012,11 @@ module Aws::CostOptimizationHub
     #   The currency code used for the recommendation.
     #   @return [String]
     #
+    # @!attribute [rw] metrics
+    #   The results or descriptions for the additional metrics, based on
+    #   whether the metrics were or were not requested.
+    #   @return [Types::SummaryMetricsResult]
+    #
     # @!attribute [rw] next_token
     #   The token to retrieve the next set of results.
     #   @return [String]
@@ -1017,6 +1028,7 @@ module Aws::CostOptimizationHub
       :items,
       :group_by,
       :currency_code,
+      :metrics,
       :next_token)
       SENSITIVE = []
       include Aws::Structure
@@ -1961,6 +1973,27 @@ module Aws::CostOptimizationHub
       include Aws::Structure
     end
 
+    # The results or descriptions for the additional metrics, based on
+    # whether the metrics were or were not requested.
+    #
+    # @!attribute [rw] savings_percentage
+    #   The savings percentage based on your Amazon Web Services spend over
+    #   the past 30 days.
+    #
+    #   <note markdown="1"> Savings percentage is only supported when filtering by Region,
+    #   account ID, or tags.
+    #
+    #    </note>
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/cost-optimization-hub-2022-07-26/SummaryMetricsResult AWS API Documentation
+    #
+    class SummaryMetricsResult < Struct.new(
+      :savings_percentage)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The tag structure that contains a tag key and value.
     #
     # @!attribute [rw] key
@@ -1999,7 +2032,7 @@ module Aws::CostOptimizationHub
     #
     # @!attribute [rw] include_member_accounts
     #   Indicates whether to enroll member accounts of the organization if
-    #   the account is the management account.
+    #   the account is the management account or delegated administrator.
     #   @return [Boolean]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/cost-optimization-hub-2022-07-26/UpdateEnrollmentStatusRequest AWS API Documentation

data/lib/aws-sdk-costoptimizationhub.rb

@@ -53,6 +53,6 @@ require_relative 'aws-sdk-costoptimizationhub/customizations'
 # @!group service
 module Aws::CostOptimizationHub
 
-  GEM_VERSION = '1.10.0'
+  GEM_VERSION = '1.11.0'
 
 end

data/sig/client.rbs

@@ -137,6 +137,7 @@ module Aws
         def items: () -> ::Array[Types::RecommendationSummary]
         def group_by: () -> ::String
         def currency_code: () -> ::String
+        def metrics: () -> Types::SummaryMetricsResult
         def next_token: () -> ::String
       end
       # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CostOptimizationHub/Client.html#list_recommendation_summaries-instance_method
@@ -161,6 +162,7 @@ module Aws
                                            },
                                            group_by: ::String,
                                            ?max_results: ::Integer,
+                                           ?metrics: Array[("SavingsPercentage")],
                                            ?next_token: ::String
                                          ) -> _ListRecommendationSummariesResponseSuccess
                                        | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListRecommendationSummariesResponseSuccess

data/sig/types.rbs

@@ -268,6 +268,7 @@ module Aws::CostOptimizationHub
       attr_accessor filter: Types::Filter
       attr_accessor group_by: ::String
       attr_accessor max_results: ::Integer
+      attr_accessor metrics: ::Array[("SavingsPercentage")]
       attr_accessor next_token: ::String
       SENSITIVE: []
     end
@@ -277,6 +278,7 @@ module Aws::CostOptimizationHub
       attr_accessor items: ::Array[Types::RecommendationSummary]
       attr_accessor group_by: ::String
       attr_accessor currency_code: ::String
+      attr_accessor metrics: Types::SummaryMetricsResult
       attr_accessor next_token: ::String
       SENSITIVE: []
     end
@@ -550,6 +552,11 @@ module Aws::CostOptimizationHub
       SENSITIVE: []
     end
 
+    class SummaryMetricsResult
+      attr_accessor savings_percentage: ::String
+      SENSITIVE: []
+    end
+
     class Tag
       attr_accessor key: ::String
       attr_accessor value: ::String

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-costoptimizationhub
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.11.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-02 00:00:00.000000000 Z
+date: 2024-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core