CostExplorer / Client / get_savings_plan_purchase_recommendation_details

get_savings_plan_purchase_recommendation_details#

CostExplorer.Client.get_savings_plan_purchase_recommendation_details(**kwargs)#

Retrieves the details for a Savings Plan recommendation. These details include the hourly data-points that construct the cost, coverage, and utilization charts.

Request Syntax

response = client.get_savings_plan_purchase_recommendation_details(
    RecommendationDetailId='string'
)

Parameters:

RecommendationDetailId (string) –

[REQUIRED]

The ID that is associated with the Savings Plan recommendation.

Return type:

dict

Returns:

Response Syntax

{
    'RecommendationDetailId': 'string',
    'RecommendationDetailData': {
        'AccountScope': 'PAYER'|'LINKED',
        'LookbackPeriodInDays': 'SEVEN_DAYS'|'THIRTY_DAYS'|'SIXTY_DAYS',
        'SavingsPlansType': 'COMPUTE_SP'|'EC2_INSTANCE_SP'|'SAGEMAKER_SP',
        'TermInYears': 'ONE_YEAR'|'THREE_YEARS',
        'PaymentOption': 'NO_UPFRONT'|'PARTIAL_UPFRONT'|'ALL_UPFRONT'|'LIGHT_UTILIZATION'|'MEDIUM_UTILIZATION'|'HEAVY_UTILIZATION',
        'AccountId': 'string',
        'CurrencyCode': 'string',
        'InstanceFamily': 'string',
        'Region': 'string',
        'OfferingId': 'string',
        'GenerationTimestamp': 'string',
        'LatestUsageTimestamp': 'string',
        'CurrentAverageHourlyOnDemandSpend': 'string',
        'CurrentMaximumHourlyOnDemandSpend': 'string',
        'CurrentMinimumHourlyOnDemandSpend': 'string',
        'EstimatedAverageUtilization': 'string',
        'EstimatedMonthlySavingsAmount': 'string',
        'EstimatedOnDemandCost': 'string',
        'EstimatedOnDemandCostWithCurrentCommitment': 'string',
        'EstimatedROI': 'string',
        'EstimatedSPCost': 'string',
        'EstimatedSavingsAmount': 'string',
        'EstimatedSavingsPercentage': 'string',
        'ExistingHourlyCommitment': 'string',
        'HourlyCommitmentToPurchase': 'string',
        'UpfrontCost': 'string',
        'CurrentAverageCoverage': 'string',
        'EstimatedAverageCoverage': 'string',
        'MetricsOverLookbackPeriod': [
            {
                'StartTime': 'string',
                'EstimatedOnDemandCost': 'string',
                'CurrentCoverage': 'string',
                'EstimatedCoverage': 'string',
                'EstimatedNewCommitmentUtilization': 'string'
            },
        ]
    }
}

Response Structure

(dict) –
- RecommendationDetailId (string) –
  
  The ID that is associated with the Savings Plan recommendation.
- RecommendationDetailData (dict) –
  
  Contains detailed information about a specific Savings Plan recommendation.
  - AccountScope (string) –
    
    The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the management account and member accounts if the value is set to PAYER. If the value is LINKED, recommendations are calculated for individual member accounts only.
  - LookbackPeriodInDays (string) –
    
    How many days of previous usage that Amazon Web Services considers when making this recommendation.
  - SavingsPlansType (string) –
    
    The requested Savings Plan recommendation type.
  - TermInYears (string) –
    
    The term of the commitment in years.
  - PaymentOption (string) –
    
    The payment option for the commitment (for example, All Upfront or No Upfront).
  - AccountId (string) –
    
    The AccountID that the recommendation is generated for.
  - CurrencyCode (string) –
    
    The currency code that Amazon Web Services used to generate the recommendation and present potential savings.
  - InstanceFamily (string) –
    
    The instance family of the recommended Savings Plan.
  - Region (string) –
    
    The region the recommendation is generated for.
  - OfferingId (string) –
    
    The unique ID that’s used to distinguish Savings Plans from one another.
  - GenerationTimestamp (string) –
    
    The period of time that you want the usage and costs for.
  - LatestUsageTimestamp (string) –
    
    The period of time that you want the usage and costs for.
  - CurrentAverageHourlyOnDemandSpend (string) –
    
    The average value of hourly On-Demand spend over the lookback period of the applicable usage type.
  - CurrentMaximumHourlyOnDemandSpend (string) –
    
    The highest value of hourly On-Demand spend over the lookback period of the applicable usage type.
  - CurrentMinimumHourlyOnDemandSpend (string) –
    
    The lowest value of hourly On-Demand spend over the lookback period of the applicable usage type.
  - EstimatedAverageUtilization (string) –
    
    The estimated utilization of the recommended Savings Plan.
  - EstimatedMonthlySavingsAmount (string) –
    
    The estimated monthly savings amount based on the recommended Savings Plan.
  - EstimatedOnDemandCost (string) –
    
    The remaining On-Demand cost estimated to not be covered by the recommended Savings Plan, over the length of the lookback period.
  - EstimatedOnDemandCostWithCurrentCommitment (string) –
    
    The estimated On-Demand costs you expect with no additional commitment, based on your usage of the selected time period and the Savings Plan you own.
  - EstimatedROI (string) –
    
    The estimated return on investment that’s based on the recommended Savings Plan that you purchased. This is calculated as estimatedSavingsAmount/estimatedSPCost*100.
  - EstimatedSPCost (string) –
    
    The cost of the recommended Savings Plan over the length of the lookback period.
  - EstimatedSavingsAmount (string) –
    
    The estimated savings amount that’s based on the recommended Savings Plan over the length of the lookback period.
  - EstimatedSavingsPercentage (string) –
    
    The estimated savings percentage relative to the total cost of applicable On-Demand usage over the lookback period.
  - ExistingHourlyCommitment (string) –
    
    The existing hourly commitment for the Savings Plan type.
  - HourlyCommitmentToPurchase (string) –
    
    The recommended hourly commitment level for the Savings Plan type and the configuration that’s based on the usage during the lookback period.
  - UpfrontCost (string) –
    
    The upfront cost of the recommended Savings Plan, based on the selected payment option.
  - CurrentAverageCoverage (string) –
    
    The average value of hourly coverage over the lookback period.
  - EstimatedAverageCoverage (string) –
    
    The estimated coverage of the recommended Savings Plan.
  - MetricsOverLookbackPeriod (list) –
    
    The related hourly cost, coverage, and utilization metrics over the lookback period.
    - (dict) –
      
      Contains the hourly metrics for the given recommendation over the lookback period.
      - StartTime (string) –
        
        The period of time that you want the usage and costs for.
      - EstimatedOnDemandCost (string) –
        
        The remaining On-Demand cost estimated to not be covered by the recommended Savings Plan, over the length of the lookback period.
      - CurrentCoverage (string) –
        
        The current amount of Savings Plans eligible usage that the Savings Plan covered.
      - EstimatedCoverage (string) –
        
        The estimated coverage amount based on the recommended Savings Plan.
      - EstimatedNewCommitmentUtilization (string) –
        
        The estimated utilization for the recommended Savings Plan.

Exceptions

CostExplorer.Client.exceptions.LimitExceededException
CostExplorer.Client.exceptions.DataUnavailableException