aws-sdk-costoptimizationhub 1.34.0 → 1.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9f1ba121aff31ca60fc366210f6c4c208e7e6a1b9bc204bb2598e61d2bad4d2
-  data.tar.gz: cc9c43f77e856bb4c0672331fcdf191ecffc4b165d512f2a64c90e89e5529f84
+  metadata.gz: ede5c1c6502491a0b9ce395faff4c101b135083f20607368a1425520b54b0e90
+  data.tar.gz: 6939651877ccb6815920b923e298159cb82e8c05c2ee529b51c4f9b93950c2ae
 SHA512:
-  metadata.gz: 0efb66163607d7dae2441893b0c38baded794d47d24ce6c95daf44d499d3d2ebe146676473fad8d6fb41ce7337ade3835c347e4d197c1b7dd1ed477a810a4546
-  data.tar.gz: 1ca262da802cda2a98a9d7b265bd39624d09bee9899f3c7db6a1cfe5471eb74149e9965b3ccff91d7a2e3a72fb38651fced73d37cabb1bcfe6f4649a1a801453
+  metadata.gz: 721696b6e0b199e5a38a94e327053b71f9e550833b26a17430ac693e6de92dd7cd435da61dbae3414da4902482b09ee39cfe02ca77cff4dd5d1e17e863b1432c
+  data.tar.gz: 51f97a055d51f30d3e9a65c5a517477d977e89d1b35e14d6483b80bb7dba956b0585888e801f871e2f0916bb429e43b33f0256b93c6240e9128cfe32f3f39ddd

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.35.0 (2025-11-19)
+------------------
+
+* Feature - Release ListEfficiencyMetrics API
+
 1.34.0 (2025-10-27)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.34.0
+1.35.0

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

@@ -1124,6 +1124,94 @@ module Aws::CostOptimizationHub
       req.send_request(options)
     end
 
+    # Returns cost efficiency metrics aggregated over time and optionally
+    # grouped by a specified dimension. The metrics provide insights into
+    # your cost optimization progress by tracking estimated savings,
+    # spending, and measures how effectively you're optimizing your Cloud
+    # resources.
+    #
+    # The operation supports both daily and monthly time granularities and
+    # allows grouping results by account ID, Amazon Web Services Region.
+    # Results are returned as time-series data, enabling you to analyze
+    # trends in your cost optimization performance over the specified time
+    # period.
+    #
+    # @option params [String] :group_by
+    #   The dimension by which to group the cost efficiency metrics. Valid
+    #   values include account ID, Amazon Web Services Region. When no
+    #   grouping is specified, metrics are aggregated across all resources in
+    #   the specified time period.
+    #
+    # @option params [required, String] :granularity
+    #   The time granularity for the cost efficiency metrics. Specify `Daily`
+    #   for metrics aggregated by day, or `Monthly` for metrics aggregated by
+    #   month.
+    #
+    # @option params [required, Types::TimePeriod] :time_period
+    #   The time period for which to retrieve the cost efficiency metrics. The
+    #   start date is inclusive and the end date is exclusive. Dates can be
+    #   specified in either YYYY-MM-DD format or YYYY-MM format depending on
+    #   the desired granularity.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of groups to return in the response. Valid values
+    #   range from 0 to 1000. Use in conjunction with `nextToken` to paginate
+    #   through results when the total number of groups exceeds this limit.
+    #
+    # @option params [Types::OrderBy] :order_by
+    #   The ordering specification for the results. Defines which dimension to
+    #   sort by and whether to sort in ascending or descending order.
+    #
+    # @option params [String] :next_token
+    #   The token to retrieve the next page of results. This value is returned
+    #   in the response when the number of groups exceeds the specified
+    #   `maxResults` value.
+    #
+    # @return [Types::ListEfficiencyMetricsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListEfficiencyMetricsResponse#efficiency_metrics_by_group #efficiency_metrics_by_group} => Array<Types::EfficiencyMetricsByGroup>
+    #   * {Types::ListEfficiencyMetricsResponse#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}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_efficiency_metrics({
+    #     group_by: "String",
+    #     granularity: "Daily", # required, accepts Daily, Monthly
+    #     time_period: { # required
+    #       start: "String", # required
+    #       end: "String", # required
+    #     },
+    #     max_results: 1,
+    #     order_by: {
+    #       dimension: "String",
+    #       order: "Asc", # accepts Asc, Desc
+    #     },
+    #     next_token: "String",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.efficiency_metrics_by_group #=> Array
+    #   resp.efficiency_metrics_by_group[0].metrics_by_time #=> Array
+    #   resp.efficiency_metrics_by_group[0].metrics_by_time[0].score #=> Float
+    #   resp.efficiency_metrics_by_group[0].metrics_by_time[0].savings #=> Float
+    #   resp.efficiency_metrics_by_group[0].metrics_by_time[0].spend #=> Float
+    #   resp.efficiency_metrics_by_group[0].metrics_by_time[0].timestamp #=> String
+    #   resp.efficiency_metrics_by_group[0].group #=> String
+    #   resp.efficiency_metrics_by_group[0].message #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/cost-optimization-hub-2022-07-26/ListEfficiencyMetrics AWS API Documentation
+    #
+    # @overload list_efficiency_metrics(params = {})
+    # @param [Hash] params ({})
+    def list_efficiency_metrics(params = {}, options = {})
+      req = build_request(:list_efficiency_metrics, params)
+      req.send_request(options)
+    end
+
     # Retrieves the enrollment status for an account. It can also return the
     # list of accounts that are enrolled under the organization.
     #
@@ -1357,9 +1445,8 @@ 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 or delegated administrator of
-    # an organization, this action can also be used to enroll member
-    # accounts of the organization.
+    # If the account is a management account 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,
@@ -1463,7 +1550,7 @@ module Aws::CostOptimizationHub
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-costoptimizationhub'
-      context[:gem_version] = '1.34.0'
+      context[:gem_version] = '1.35.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -47,6 +47,8 @@ module Aws::CostOptimizationHub
     Ec2ReservedInstancesConfiguration = Shapes::StructureShape.new(name: 'Ec2ReservedInstancesConfiguration')
     EcsService = Shapes::StructureShape.new(name: 'EcsService')
     EcsServiceConfiguration = Shapes::StructureShape.new(name: 'EcsServiceConfiguration')
+    EfficiencyMetricsByGroup = Shapes::StructureShape.new(name: 'EfficiencyMetricsByGroup')
+    EfficiencyMetricsByGroupList = Shapes::ListShape.new(name: 'EfficiencyMetricsByGroupList')
     ElastiCacheReservedInstances = Shapes::StructureShape.new(name: 'ElastiCacheReservedInstances')
     ElastiCacheReservedInstancesConfiguration = Shapes::StructureShape.new(name: 'ElastiCacheReservedInstancesConfiguration')
     EnrollmentStatus = Shapes::StringShape.new(name: 'EnrollmentStatus')
@@ -56,6 +58,7 @@ module Aws::CostOptimizationHub
     GetPreferencesResponse = Shapes::StructureShape.new(name: 'GetPreferencesResponse')
     GetRecommendationRequest = Shapes::StructureShape.new(name: 'GetRecommendationRequest')
     GetRecommendationResponse = Shapes::StructureShape.new(name: 'GetRecommendationResponse')
+    GranularityType = Shapes::StringShape.new(name: 'GranularityType')
     ImplementationEffort = Shapes::StringShape.new(name: 'ImplementationEffort')
     ImplementationEffortList = Shapes::ListShape.new(name: 'ImplementationEffortList')
     InstanceConfiguration = Shapes::StructureShape.new(name: 'InstanceConfiguration')
@@ -63,6 +66,9 @@ module Aws::CostOptimizationHub
     InternalServerException = Shapes::StructureShape.new(name: 'InternalServerException')
     LambdaFunction = Shapes::StructureShape.new(name: 'LambdaFunction')
     LambdaFunctionConfiguration = Shapes::StructureShape.new(name: 'LambdaFunctionConfiguration')
+    ListEfficiencyMetricsRequest = Shapes::StructureShape.new(name: 'ListEfficiencyMetricsRequest')
+    ListEfficiencyMetricsRequestMaxResultsInteger = Shapes::IntegerShape.new(name: 'ListEfficiencyMetricsRequestMaxResultsInteger')
+    ListEfficiencyMetricsResponse = Shapes::StructureShape.new(name: 'ListEfficiencyMetricsResponse')
     ListEnrollmentStatusesRequest = Shapes::StructureShape.new(name: 'ListEnrollmentStatusesRequest')
     ListEnrollmentStatusesResponse = Shapes::StructureShape.new(name: 'ListEnrollmentStatusesResponse')
     ListRecommendationSummariesRequest = Shapes::StructureShape.new(name: 'ListRecommendationSummariesRequest')
@@ -75,6 +81,8 @@ module Aws::CostOptimizationHub
     MemberAccountDiscountVisibility = Shapes::StringShape.new(name: 'MemberAccountDiscountVisibility')
     MemoryDbReservedInstances = Shapes::StructureShape.new(name: 'MemoryDbReservedInstances')
     MemoryDbReservedInstancesConfiguration = Shapes::StructureShape.new(name: 'MemoryDbReservedInstancesConfiguration')
+    MetricsByTime = Shapes::StructureShape.new(name: 'MetricsByTime')
+    MetricsByTimeList = Shapes::ListShape.new(name: 'MetricsByTimeList')
     MixedInstanceConfiguration = Shapes::StructureShape.new(name: 'MixedInstanceConfiguration')
     MixedInstanceConfigurationList = Shapes::ListShape.new(name: 'MixedInstanceConfigurationList')
     OpenSearchReservedInstances = Shapes::StructureShape.new(name: 'OpenSearchReservedInstances')
@@ -123,6 +131,7 @@ module Aws::CostOptimizationHub
     TagList = Shapes::ListShape.new(name: 'TagList')
     Term = Shapes::StringShape.new(name: 'Term')
     ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
+    TimePeriod = Shapes::StructureShape.new(name: 'TimePeriod')
     Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
     UpdateEnrollmentStatusRequest = Shapes::StructureShape.new(name: 'UpdateEnrollmentStatusRequest')
     UpdateEnrollmentStatusResponse = Shapes::StructureShape.new(name: 'UpdateEnrollmentStatusResponse')
@@ -262,6 +271,13 @@ module Aws::CostOptimizationHub
     EcsServiceConfiguration.add_member(:compute, Shapes::ShapeRef.new(shape: ComputeConfiguration, location_name: "compute"))
     EcsServiceConfiguration.struct_class = Types::EcsServiceConfiguration
 
+    EfficiencyMetricsByGroup.add_member(:metrics_by_time, Shapes::ShapeRef.new(shape: MetricsByTimeList, location_name: "metricsByTime"))
+    EfficiencyMetricsByGroup.add_member(:group, Shapes::ShapeRef.new(shape: String, location_name: "group"))
+    EfficiencyMetricsByGroup.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "message"))
+    EfficiencyMetricsByGroup.struct_class = Types::EfficiencyMetricsByGroup
+
+    EfficiencyMetricsByGroupList.member = Shapes::ShapeRef.new(shape: EfficiencyMetricsByGroup)
+
     ElastiCacheReservedInstances.add_member(:configuration, Shapes::ShapeRef.new(shape: ElastiCacheReservedInstancesConfiguration, location_name: "configuration"))
     ElastiCacheReservedInstances.add_member(:cost_calculation, Shapes::ShapeRef.new(shape: ReservedInstancesCostCalculation, location_name: "costCalculation"))
     ElastiCacheReservedInstances.struct_class = Types::ElastiCacheReservedInstances
@@ -349,6 +365,18 @@ module Aws::CostOptimizationHub
     LambdaFunctionConfiguration.add_member(:compute, Shapes::ShapeRef.new(shape: ComputeConfiguration, location_name: "compute"))
     LambdaFunctionConfiguration.struct_class = Types::LambdaFunctionConfiguration
 
+    ListEfficiencyMetricsRequest.add_member(:group_by, Shapes::ShapeRef.new(shape: String, location_name: "groupBy"))
+    ListEfficiencyMetricsRequest.add_member(:granularity, Shapes::ShapeRef.new(shape: GranularityType, required: true, location_name: "granularity"))
+    ListEfficiencyMetricsRequest.add_member(:time_period, Shapes::ShapeRef.new(shape: TimePeriod, required: true, location_name: "timePeriod"))
+    ListEfficiencyMetricsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: ListEfficiencyMetricsRequestMaxResultsInteger, location_name: "maxResults"))
+    ListEfficiencyMetricsRequest.add_member(:order_by, Shapes::ShapeRef.new(shape: OrderBy, location_name: "orderBy"))
+    ListEfficiencyMetricsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "nextToken"))
+    ListEfficiencyMetricsRequest.struct_class = Types::ListEfficiencyMetricsRequest
+
+    ListEfficiencyMetricsResponse.add_member(:efficiency_metrics_by_group, Shapes::ShapeRef.new(shape: EfficiencyMetricsByGroupList, location_name: "efficiencyMetricsByGroup"))
+    ListEfficiencyMetricsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "nextToken"))
+    ListEfficiencyMetricsResponse.struct_class = Types::ListEfficiencyMetricsResponse
+
     ListEnrollmentStatusesRequest.add_member(:include_organization_info, Shapes::ShapeRef.new(shape: PrimitiveBoolean, location_name: "includeOrganizationInfo"))
     ListEnrollmentStatusesRequest.add_member(:account_id, Shapes::ShapeRef.new(shape: AccountId, location_name: "accountId"))
     ListEnrollmentStatusesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "nextToken"))
@@ -405,6 +433,14 @@ module Aws::CostOptimizationHub
     MemoryDbReservedInstancesConfiguration.add_member(:current_generation, Shapes::ShapeRef.new(shape: String, location_name: "currentGeneration"))
     MemoryDbReservedInstancesConfiguration.struct_class = Types::MemoryDbReservedInstancesConfiguration
 
+    MetricsByTime.add_member(:score, Shapes::ShapeRef.new(shape: Double, location_name: "score"))
+    MetricsByTime.add_member(:savings, Shapes::ShapeRef.new(shape: Double, location_name: "savings"))
+    MetricsByTime.add_member(:spend, Shapes::ShapeRef.new(shape: Double, location_name: "spend"))
+    MetricsByTime.add_member(:timestamp, Shapes::ShapeRef.new(shape: String, location_name: "timestamp"))
+    MetricsByTime.struct_class = Types::MetricsByTime
+
+    MetricsByTimeList.member = Shapes::ShapeRef.new(shape: MetricsByTime)
+
     MixedInstanceConfiguration.add_member(:type, Shapes::ShapeRef.new(shape: String, location_name: "type"))
     MixedInstanceConfiguration.struct_class = Types::MixedInstanceConfiguration
 
@@ -637,6 +673,10 @@ module Aws::CostOptimizationHub
     ThrottlingException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "message"))
     ThrottlingException.struct_class = Types::ThrottlingException
 
+    TimePeriod.add_member(:start, Shapes::ShapeRef.new(shape: String, required: true, location_name: "start"))
+    TimePeriod.add_member(:end, Shapes::ShapeRef.new(shape: String, required: true, location_name: "end"))
+    TimePeriod.struct_class = Types::TimePeriod
+
     UpdateEnrollmentStatusRequest.add_member(:status, Shapes::ShapeRef.new(shape: EnrollmentStatus, required: true, location_name: "status"))
     UpdateEnrollmentStatusRequest.add_member(:include_member_accounts, Shapes::ShapeRef.new(shape: Boolean, location_name: "includeMemberAccounts"))
     UpdateEnrollmentStatusRequest.struct_class = Types::UpdateEnrollmentStatusRequest
@@ -720,6 +760,24 @@ module Aws::CostOptimizationHub
         o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
       end)
 
+      api.add_operation(:list_efficiency_metrics, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "ListEfficiencyMetrics"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: ListEfficiencyMetricsRequest)
+        o.output = Shapes::ShapeRef.new(shape: ListEfficiencyMetricsResponse)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o[:pager] = Aws::Pager.new(
+          limit_key: "max_results",
+          tokens: {
+            "next_token" => "next_token"
+          }
+        )
+      end)
+
       api.add_operation(:list_enrollment_statuses, Seahorse::Model::Operation.new.tap do |o|
         o.name = "ListEnrollmentStatuses"
         o.http_method = "POST"

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

@@ -454,7 +454,7 @@ module Aws::CostOptimizationHub
     #   @return [String]
     #
     # @!attribute [rw] instance_family
-    #   The instance family of the recommended Savings Plan.
+    #   The instance family of the recommended Savings Plans.
     #   @return [String]
     #
     # @!attribute [rw] savings_plans_region
@@ -623,6 +623,43 @@ module Aws::CostOptimizationHub
       include Aws::Structure
     end
 
+    # Contains cost efficiency metrics for a specific group over time. The
+    # group is defined by the grouping dimension specified in the request,
+    # such as account ID, Amazon Web Services Region.
+    #
+    # @!attribute [rw] metrics_by_time
+    #   A list of time-series data points containing efficiency metrics for
+    #   this group. Each data point includes an efficiency score, estimated
+    #   savings, spending, and a timestamp corresponding to the specified
+    #   granularity. This field is null when efficiency metrics cannot be
+    #   calculated for the group, in which case the message field provides
+    #   an explanation.
+    #   @return [Array<Types::MetricsByTime>]
+    #
+    # @!attribute [rw] group
+    #   The value of the grouping dimension for this set of metrics. For
+    #   example, if grouped by account ID, this field contains the account
+    #   ID. If no grouping is specified, this field is empty.
+    #   @return [String]
+    #
+    # @!attribute [rw] message
+    #   An explanation of why efficiency metrics could not be calculated for
+    #   this group when the metricsByTime field is null. Common reasons
+    #   include insufficient or inconclusive cost and usage data during the
+    #   specified time period. This field is null or empty when metrics are
+    #   successfully calculated.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/cost-optimization-hub-2022-07-26/EfficiencyMetricsByGroup AWS API Documentation
+    #
+    class EfficiencyMetricsByGroup < Struct.new(
+      :metrics_by_time,
+      :group,
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The ElastiCache reserved instances recommendation details.
     #
     # @!attribute [rw] configuration
@@ -1047,6 +1084,80 @@ module Aws::CostOptimizationHub
       include Aws::Structure
     end
 
+    # @!attribute [rw] group_by
+    #   The dimension by which to group the cost efficiency metrics. Valid
+    #   values include account ID, Amazon Web Services Region. When no
+    #   grouping is specified, metrics are aggregated across all resources
+    #   in the specified time period.
+    #   @return [String]
+    #
+    # @!attribute [rw] granularity
+    #   The time granularity for the cost efficiency metrics. Specify
+    #   `Daily` for metrics aggregated by day, or `Monthly` for metrics
+    #   aggregated by month.
+    #   @return [String]
+    #
+    # @!attribute [rw] time_period
+    #   The time period for which to retrieve the cost efficiency metrics.
+    #   The start date is inclusive and the end date is exclusive. Dates can
+    #   be specified in either YYYY-MM-DD format or YYYY-MM format depending
+    #   on the desired granularity.
+    #   @return [Types::TimePeriod]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of groups to return in the response. Valid values
+    #   range from 0 to 1000. Use in conjunction with `nextToken` to
+    #   paginate through results when the total number of groups exceeds
+    #   this limit.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] order_by
+    #   The ordering specification for the results. Defines which dimension
+    #   to sort by and whether to sort in ascending or descending order.
+    #   @return [Types::OrderBy]
+    #
+    # @!attribute [rw] next_token
+    #   The token to retrieve the next page of results. This value is
+    #   returned in the response when the number of groups exceeds the
+    #   specified `maxResults` value.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/cost-optimization-hub-2022-07-26/ListEfficiencyMetricsRequest AWS API Documentation
+    #
+    class ListEfficiencyMetricsRequest < Struct.new(
+      :group_by,
+      :granularity,
+      :time_period,
+      :max_results,
+      :order_by,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] efficiency_metrics_by_group
+    #   A list of cost efficiency metrics grouped by the specified
+    #   dimension. Each group contains time-series data points with cost
+    #   efficiency, potential savings, and optimzable spend for the
+    #   specified time period.
+    #   @return [Array<Types::EfficiencyMetricsByGroup>]
+    #
+    # @!attribute [rw] next_token
+    #   The token to retrieve the next page of results. When this value is
+    #   present in the response, additional groups are available. Pass this
+    #   token in the `nextToken` parameter of a subsequent request to
+    #   retrieve the next page.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/cost-optimization-hub-2022-07-26/ListEfficiencyMetricsResponse AWS API Documentation
+    #
+    class ListEfficiencyMetricsResponse < Struct.new(
+      :efficiency_metrics_by_group,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] include_organization_info
     #   Indicates whether to return the enrollment status for the
     #   organization.
@@ -1334,6 +1445,42 @@ module Aws::CostOptimizationHub
       include Aws::Structure
     end
 
+    # Contains efficiency metrics for a specific point in time, including an
+    # efficiency score, potential savings, optimizable spend, and timestamp.
+    #
+    # @!attribute [rw] score
+    #   The efficiency score for this time period. The score represents a
+    #   measure of how effectively the cloud resources are being optimized,
+    #   with higher scores indicating better optimization performance.
+    #   @return [Float]
+    #
+    # @!attribute [rw] savings
+    #   The estimated savings amount for this time period, representing the
+    #   potential cost reduction achieved through optimization
+    #   recommendations.
+    #   @return [Float]
+    #
+    # @!attribute [rw] spend
+    #   The total spending amount for this time period.
+    #   @return [Float]
+    #
+    # @!attribute [rw] timestamp
+    #   The timestamp for this data point. The format depends on the
+    #   granularity: YYYY-MM-DD for daily metrics, or YYYY-MM for monthly
+    #   metrics.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/cost-optimization-hub-2022-07-26/MetricsByTime AWS API Documentation
+    #
+    class MetricsByTime < Struct.new(
+      :score,
+      :savings,
+      :spend,
+      :timestamp)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The configuration for the EC2 Auto Scaling group with mixed instance
     # types.
     #
@@ -2232,23 +2379,24 @@ module Aws::CostOptimizationHub
       include Aws::Structure
     end
 
-    # Pricing information about a Savings Plan.
+    # Pricing information about a Savings Plans.
     #
     # @!attribute [rw] monthly_savings_plans_eligible_cost
-    #   The cost of paying for the recommended Savings Plan monthly.
+    #   The cost of paying for the recommended Savings Plans monthly.
     #   @return [Float]
     #
     # @!attribute [rw] estimated_monthly_commitment
-    #   Estimated monthly commitment for the Savings Plan.
+    #   Estimated monthly commitment for the Savings Plans.
     #   @return [Float]
     #
     # @!attribute [rw] savings_percentage
     #   Estimated savings as a percentage of your overall costs after buying
-    #   the Savings Plan.
+    #   the Savings Plans.
     #   @return [Float]
     #
     # @!attribute [rw] estimated_on_demand_cost
-    #   Estimated On-Demand cost you will pay after buying the Savings Plan.
+    #   Estimated On-Demand cost you will pay after buying the Savings
+    #   Plans.
     #   @return [Float]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/cost-optimization-hub-2022-07-26/SavingsPlansPricing AWS API Documentation
@@ -2334,6 +2482,28 @@ module Aws::CostOptimizationHub
       include Aws::Structure
     end
 
+    # Specifies a date range for retrieving efficiency metrics. The start
+    # date is inclusive and the end date is exclusive.
+    #
+    # @!attribute [rw] start
+    #   The beginning of the time period (inclusive). Specify the date in
+    #   ISO 8601 format, such as 2024-01-01.
+    #   @return [String]
+    #
+    # @!attribute [rw] end
+    #   The end of the time period (exclusive). Specify the date in ISO 8601
+    #   format, such as 2024-12-31.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/cost-optimization-hub-2022-07-26/TimePeriod AWS API Documentation
+    #
+    class TimePeriod < Struct.new(
+      :start,
+      :end)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] status
     #   Sets the account status.
     #   @return [String]

data/lib/aws-sdk-costoptimizationhub.rb

@@ -55,7 +55,7 @@ module Aws::CostOptimizationHub
   autoload :EndpointProvider, 'aws-sdk-costoptimizationhub/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-costoptimizationhub/endpoints'
 
-  GEM_VERSION = '1.34.0'
+  GEM_VERSION = '1.35.0'
 
 end
 

data/sig/client.rbs

@@ -122,6 +122,28 @@ module Aws
                               ) -> _GetRecommendationResponseSuccess
                             | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetRecommendationResponseSuccess
 
+      interface _ListEfficiencyMetricsResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::ListEfficiencyMetricsResponse]
+        def efficiency_metrics_by_group: () -> ::Array[Types::EfficiencyMetricsByGroup]
+        def next_token: () -> ::String
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CostOptimizationHub/Client.html#list_efficiency_metrics-instance_method
+      def list_efficiency_metrics: (
+                                     ?group_by: ::String,
+                                     granularity: ("Daily" | "Monthly"),
+                                     time_period: {
+                                       start: ::String,
+                                       end: ::String
+                                     },
+                                     ?max_results: ::Integer,
+                                     ?order_by: {
+                                       dimension: ::String?,
+                                       order: ("Asc" | "Desc")?
+                                     },
+                                     ?next_token: ::String
+                                   ) -> _ListEfficiencyMetricsResponseSuccess
+                                 | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListEfficiencyMetricsResponseSuccess
+
       interface _ListEnrollmentStatusesResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::ListEnrollmentStatusesResponse]
         def items: () -> ::Array[Types::AccountEnrollmentStatus]

data/sig/types.rbs

@@ -175,6 +175,13 @@ module Aws::CostOptimizationHub
       SENSITIVE: []
     end
 
+    class EfficiencyMetricsByGroup
+      attr_accessor metrics_by_time: ::Array[Types::MetricsByTime]
+      attr_accessor group: ::String
+      attr_accessor message: ::String
+      SENSITIVE: []
+    end
+
     class ElastiCacheReservedInstances
       attr_accessor configuration: Types::ElastiCacheReservedInstancesConfiguration
       attr_accessor cost_calculation: Types::ReservedInstancesCostCalculation
@@ -283,6 +290,22 @@ module Aws::CostOptimizationHub
       SENSITIVE: []
     end
 
+    class ListEfficiencyMetricsRequest
+      attr_accessor group_by: ::String
+      attr_accessor granularity: ("Daily" | "Monthly")
+      attr_accessor time_period: Types::TimePeriod
+      attr_accessor max_results: ::Integer
+      attr_accessor order_by: Types::OrderBy
+      attr_accessor next_token: ::String
+      SENSITIVE: []
+    end
+
+    class ListEfficiencyMetricsResponse
+      attr_accessor efficiency_metrics_by_group: ::Array[Types::EfficiencyMetricsByGroup]
+      attr_accessor next_token: ::String
+      SENSITIVE: []
+    end
+
     class ListEnrollmentStatusesRequest
       attr_accessor include_organization_info: bool
       attr_accessor account_id: ::String
@@ -355,6 +378,14 @@ module Aws::CostOptimizationHub
       SENSITIVE: []
     end
 
+    class MetricsByTime
+      attr_accessor score: ::Float
+      attr_accessor savings: ::Float
+      attr_accessor spend: ::Float
+      attr_accessor timestamp: ::String
+      SENSITIVE: []
+    end
+
     class MixedInstanceConfiguration
       attr_accessor type: ::String
       SENSITIVE: []
@@ -645,6 +676,12 @@ module Aws::CostOptimizationHub
       SENSITIVE: []
     end
 
+    class TimePeriod
+      attr_accessor start: ::String
+      attr_accessor end: ::String
+      SENSITIVE: []
+    end
+
     class UpdateEnrollmentStatusRequest
       attr_accessor status: ("Active" | "Inactive")
       attr_accessor include_member_accounts: bool

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-costoptimizationhub
 version: !ruby/object:Gem::Version
-  version: 1.34.0
+  version: 1.35.0
 platform: ruby
 authors:
 - Amazon Web Services