aws-sdk-costexplorer 1.115.0 → 1.117.0

data/sig/client.rbs

@@ -350,6 +350,23 @@ module Aws
                                          ) -> _GetApproximateUsageRecordsResponseSuccess
                                        | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetApproximateUsageRecordsResponseSuccess
 
+      interface _GetCommitmentPurchaseAnalysisResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::GetCommitmentPurchaseAnalysisResponse]
+        def estimated_completion_time: () -> ::String
+        def analysis_completion_time: () -> ::String
+        def analysis_started_time: () -> ::String
+        def analysis_id: () -> ::String
+        def analysis_status: () -> ("SUCCEEDED" | "PROCESSING" | "FAILED")
+        def error_code: () -> ("NO_USAGE_FOUND" | "INTERNAL_FAILURE" | "INVALID_SAVINGS_PLANS_TO_ADD" | "INVALID_SAVINGS_PLANS_TO_EXCLUDE" | "INVALID_ACCOUNT_ID")
+        def analysis_details: () -> Types::AnalysisDetails
+        def commitment_purchase_analysis_configuration: () -> Types::CommitmentPurchaseAnalysisConfiguration
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CostExplorer/Client.html#get_commitment_purchase_analysis-instance_method
+      def get_commitment_purchase_analysis: (
+                                              analysis_id: ::String
+                                            ) -> _GetCommitmentPurchaseAnalysisResponseSuccess
+                                          | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetCommitmentPurchaseAnalysisResponseSuccess
+
       interface _GetCostAndUsageResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::GetCostAndUsageResponse]
         def next_page_token: () -> ::String
@@ -1074,6 +1091,20 @@ module Aws
                               ) -> _GetUsageForecastResponseSuccess
                             | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetUsageForecastResponseSuccess
 
+      interface _ListCommitmentPurchaseAnalysesResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::ListCommitmentPurchaseAnalysesResponse]
+        def analysis_summary_list: () -> ::Array[Types::AnalysisSummary]
+        def next_page_token: () -> ::String
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CostExplorer/Client.html#list_commitment_purchase_analyses-instance_method
+      def list_commitment_purchase_analyses: (
+                                               ?analysis_status: ("SUCCEEDED" | "PROCESSING" | "FAILED"),
+                                               ?next_page_token: ::String,
+                                               ?page_size: ::Integer,
+                                               ?analysis_ids: Array[::String]
+                                             ) -> _ListCommitmentPurchaseAnalysesResponseSuccess
+                                           | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListCommitmentPurchaseAnalysesResponseSuccess
+
       interface _ListCostAllocationTagBackfillHistoryResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::ListCostAllocationTagBackfillHistoryResponse]
         def backfill_requests: () -> ::Array[Types::CostAllocationTagBackfillRequest]
@@ -1149,6 +1180,40 @@ module Aws
                                     ) -> _ProvideAnomalyFeedbackResponseSuccess
                                   | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ProvideAnomalyFeedbackResponseSuccess
 
+      interface _StartCommitmentPurchaseAnalysisResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::StartCommitmentPurchaseAnalysisResponse]
+        def analysis_id: () -> ::String
+        def analysis_started_time: () -> ::String
+        def estimated_completion_time: () -> ::String
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CostExplorer/Client.html#start_commitment_purchase_analysis-instance_method
+      def start_commitment_purchase_analysis: (
+                                                commitment_purchase_analysis_configuration: {
+                                                  savings_plans_purchase_analysis_configuration: {
+                                                    account_scope: ("PAYER" | "LINKED")?,
+                                                    account_id: ::String?,
+                                                    analysis_type: ("MAX_SAVINGS" | "CUSTOM_COMMITMENT"),
+                                                    savings_plans_to_add: Array[
+                                                      {
+                                                        payment_option: ("NO_UPFRONT" | "PARTIAL_UPFRONT" | "ALL_UPFRONT" | "LIGHT_UTILIZATION" | "MEDIUM_UTILIZATION" | "HEAVY_UTILIZATION")?,
+                                                        savings_plans_type: ("COMPUTE_SP" | "EC2_INSTANCE_SP" | "SAGEMAKER_SP")?,
+                                                        region: ::String?,
+                                                        instance_family: ::String?,
+                                                        term_in_years: ("ONE_YEAR" | "THREE_YEARS")?,
+                                                        savings_plans_commitment: ::Float?,
+                                                        offering_id: ::String?
+                                                      },
+                                                    ],
+                                                    savings_plans_to_exclude: Array[::String]?,
+                                                    look_back_time_period: {
+                                                      start: ::String,
+                                                      end: ::String
+                                                    }
+                                                  }?
+                                                }
+                                              ) -> _StartCommitmentPurchaseAnalysisResponseSuccess
+                                            | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartCommitmentPurchaseAnalysisResponseSuccess
+
       interface _StartCostAllocationTagBackfillResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::StartCostAllocationTagBackfillResponse]
         def backfill_request: () -> Types::CostAllocationTagBackfillRequest

data/sig/errors.rbs

@@ -11,6 +11,9 @@ module Aws
       class ServiceError < ::Aws::Errors::ServiceError
       end
 
+      class AnalysisNotFoundException < ::Aws::Errors::ServiceError
+        def message: () -> ::String
+      end
       class BackfillLimitExceededException < ::Aws::Errors::ServiceError
         def message: () -> ::String
       end

data/sig/types.rbs

@@ -8,6 +8,27 @@
 module Aws::CostExplorer
   module Types
 
+    class AnalysisDetails
+      attr_accessor savings_plans_purchase_analysis_details: Types::SavingsPlansPurchaseAnalysisDetails
+      SENSITIVE: []
+    end
+
+    class AnalysisNotFoundException
+      attr_accessor message: ::String
+      SENSITIVE: []
+    end
+
+    class AnalysisSummary
+      attr_accessor estimated_completion_time: ::String
+      attr_accessor analysis_completion_time: ::String
+      attr_accessor analysis_started_time: ::String
+      attr_accessor analysis_status: ("SUCCEEDED" | "PROCESSING" | "FAILED")
+      attr_accessor error_code: ("NO_USAGE_FOUND" | "INTERNAL_FAILURE" | "INVALID_SAVINGS_PLANS_TO_ADD" | "INVALID_SAVINGS_PLANS_TO_EXCLUDE" | "INVALID_ACCOUNT_ID")
+      attr_accessor analysis_id: ::String
+      attr_accessor commitment_purchase_analysis_configuration: Types::CommitmentPurchaseAnalysisConfiguration
+      SENSITIVE: []
+    end
+
     class Anomaly
       attr_accessor anomaly_id: ::String
       attr_accessor anomaly_start_date: ::String
@@ -68,6 +89,11 @@ module Aws::CostExplorer
       SENSITIVE: []
     end
 
+    class CommitmentPurchaseAnalysisConfiguration
+      attr_accessor savings_plans_purchase_analysis_configuration: Types::SavingsPlansPurchaseAnalysisConfiguration
+      SENSITIVE: []
+    end
+
     class CostAllocationTag
       attr_accessor tag_key: ::String
       attr_accessor type: ("AWSGenerated" | "UserDefined")
@@ -479,6 +505,23 @@ module Aws::CostExplorer
       SENSITIVE: []
     end
 
+    class GetCommitmentPurchaseAnalysisRequest
+      attr_accessor analysis_id: ::String
+      SENSITIVE: []
+    end
+
+    class GetCommitmentPurchaseAnalysisResponse
+      attr_accessor estimated_completion_time: ::String
+      attr_accessor analysis_completion_time: ::String
+      attr_accessor analysis_started_time: ::String
+      attr_accessor analysis_id: ::String
+      attr_accessor analysis_status: ("SUCCEEDED" | "PROCESSING" | "FAILED")
+      attr_accessor error_code: ("NO_USAGE_FOUND" | "INTERNAL_FAILURE" | "INVALID_SAVINGS_PLANS_TO_ADD" | "INVALID_SAVINGS_PLANS_TO_EXCLUDE" | "INVALID_ACCOUNT_ID")
+      attr_accessor analysis_details: Types::AnalysisDetails
+      attr_accessor commitment_purchase_analysis_configuration: Types::CommitmentPurchaseAnalysisConfiguration
+      SENSITIVE: []
+    end
+
     class GetCostAndUsageRequest
       attr_accessor time_period: Types::DateInterval
       attr_accessor granularity: ("DAILY" | "MONTHLY" | "HOURLY")
@@ -801,6 +844,20 @@ module Aws::CostExplorer
       SENSITIVE: []
     end
 
+    class ListCommitmentPurchaseAnalysesRequest
+      attr_accessor analysis_status: ("SUCCEEDED" | "PROCESSING" | "FAILED")
+      attr_accessor next_page_token: ::String
+      attr_accessor page_size: ::Integer
+      attr_accessor analysis_ids: ::Array[::String]
+      SENSITIVE: []
+    end
+
+    class ListCommitmentPurchaseAnalysesResponse
+      attr_accessor analysis_summary_list: ::Array[Types::AnalysisSummary]
+      attr_accessor next_page_token: ::String
+      SENSITIVE: []
+    end
+
     class ListCostAllocationTagBackfillHistoryRequest
       attr_accessor next_token: ::String
       attr_accessor max_results: ::Integer
@@ -1132,8 +1189,25 @@ module Aws::CostExplorer
       attr_accessor service: ::String
       attr_accessor region: ::String
       attr_accessor linked_account: ::String
-      attr_accessor usage_type: ::String
       attr_accessor linked_account_name: ::String
+      attr_accessor usage_type: ::String
+      attr_accessor impact: Types::RootCauseImpact
+      SENSITIVE: []
+    end
+
+    class RootCauseImpact
+      attr_accessor contribution: ::Float
+      SENSITIVE: []
+    end
+
+    class SavingsPlans
+      attr_accessor payment_option: ("NO_UPFRONT" | "PARTIAL_UPFRONT" | "ALL_UPFRONT" | "LIGHT_UTILIZATION" | "MEDIUM_UTILIZATION" | "HEAVY_UTILIZATION")
+      attr_accessor savings_plans_type: ("COMPUTE_SP" | "EC2_INSTANCE_SP" | "SAGEMAKER_SP")
+      attr_accessor region: ::String
+      attr_accessor instance_family: ::String
+      attr_accessor term_in_years: ("ONE_YEAR" | "THREE_YEARS")
+      attr_accessor savings_plans_commitment: ::Float
+      attr_accessor offering_id: ::String
       SENSITIVE: []
     end
 
@@ -1166,6 +1240,42 @@ module Aws::CostExplorer
       SENSITIVE: []
     end
 
+    class SavingsPlansPurchaseAnalysisConfiguration
+      attr_accessor account_scope: ("PAYER" | "LINKED")
+      attr_accessor account_id: ::String
+      attr_accessor analysis_type: ("MAX_SAVINGS" | "CUSTOM_COMMITMENT")
+      attr_accessor savings_plans_to_add: ::Array[Types::SavingsPlans]
+      attr_accessor savings_plans_to_exclude: ::Array[::String]
+      attr_accessor look_back_time_period: Types::DateInterval
+      SENSITIVE: []
+    end
+
+    class SavingsPlansPurchaseAnalysisDetails
+      attr_accessor currency_code: ::String
+      attr_accessor lookback_period_in_hours: ::String
+      attr_accessor current_average_coverage: ::String
+      attr_accessor current_average_hourly_on_demand_spend: ::String
+      attr_accessor current_maximum_hourly_on_demand_spend: ::String
+      attr_accessor current_minimum_hourly_on_demand_spend: ::String
+      attr_accessor current_on_demand_spend: ::String
+      attr_accessor existing_hourly_commitment: ::String
+      attr_accessor hourly_commitment_to_purchase: ::String
+      attr_accessor estimated_average_coverage: ::String
+      attr_accessor estimated_average_utilization: ::String
+      attr_accessor estimated_monthly_savings_amount: ::String
+      attr_accessor estimated_on_demand_cost: ::String
+      attr_accessor estimated_on_demand_cost_with_current_commitment: ::String
+      attr_accessor estimated_roi: ::String
+      attr_accessor estimated_savings_amount: ::String
+      attr_accessor estimated_savings_percentage: ::String
+      attr_accessor estimated_commitment_cost: ::String
+      attr_accessor latest_usage_timestamp: ::String
+      attr_accessor upfront_cost: ::String
+      attr_accessor additional_metadata: ::String
+      attr_accessor metrics_over_lookback_period: ::Array[Types::RecommendationDetailHourlyMetrics]
+      SENSITIVE: []
+    end
+
     class SavingsPlansPurchaseRecommendation
       attr_accessor account_scope: ("PAYER" | "LINKED")
       attr_accessor savings_plans_type: ("COMPUTE_SP" | "EC2_INSTANCE_SP" | "SAGEMAKER_SP")
@@ -1274,6 +1384,18 @@ module Aws::CostExplorer
       SENSITIVE: []
     end
 
+    class StartCommitmentPurchaseAnalysisRequest
+      attr_accessor commitment_purchase_analysis_configuration: Types::CommitmentPurchaseAnalysisConfiguration
+      SENSITIVE: []
+    end
+
+    class StartCommitmentPurchaseAnalysisResponse
+      attr_accessor analysis_id: ::String
+      attr_accessor analysis_started_time: ::String
+      attr_accessor estimated_completion_time: ::String
+      SENSITIVE: []
+    end
+
     class StartCostAllocationTagBackfillRequest
       attr_accessor backfill_from: ::String
       SENSITIVE: []

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-costexplorer
 version: !ruby/object:Gem::Version
-  version: 1.115.0
+  version: 1.117.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-18 00:00:00.000000000 Z
+date: 2024-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core