CostExplorer / Client / get_savings_plans_purchase_recommendation

get_savings_plans_purchase_recommendation#

CostExplorer.Client.get_savings_plans_purchase_recommendation(**kwargs)#

Retrieves the Savings Plans recommendations for your account. First use StartSavingsPlansPurchaseRecommendationGeneration to generate a new set of recommendations, and then use GetSavingsPlansPurchaseRecommendation to retrieve them.

Request Syntax

response = client.get_savings_plans_purchase_recommendation(
    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',
    AccountScope='PAYER'|'LINKED',
    NextPageToken='string',
    PageSize=123,
    LookbackPeriodInDays='SEVEN_DAYS'|'THIRTY_DAYS'|'SIXTY_DAYS',
    Filter={
        'Or': [
            {'... recursive ...'},
        ],
        'And': [
            {'... recursive ...'},
        ],
        'Not': {'... recursive ...'},
        'Dimensions': {
            'Key': 'AZ'|'INSTANCE_TYPE'|'LINKED_ACCOUNT'|'LINKED_ACCOUNT_NAME'|'OPERATION'|'PURCHASE_TYPE'|'REGION'|'SERVICE'|'SERVICE_CODE'|'USAGE_TYPE'|'USAGE_TYPE_GROUP'|'RECORD_TYPE'|'OPERATING_SYSTEM'|'TENANCY'|'SCOPE'|'PLATFORM'|'SUBSCRIPTION_ID'|'LEGAL_ENTITY_NAME'|'DEPLOYMENT_OPTION'|'DATABASE_ENGINE'|'CACHE_ENGINE'|'INSTANCE_TYPE_FAMILY'|'BILLING_ENTITY'|'RESERVATION_ID'|'RESOURCE_ID'|'RIGHTSIZING_TYPE'|'SAVINGS_PLANS_TYPE'|'SAVINGS_PLAN_ARN'|'PAYMENT_OPTION'|'AGREEMENT_END_DATE_TIME_AFTER'|'AGREEMENT_END_DATE_TIME_BEFORE'|'INVOICING_ENTITY'|'ANOMALY_TOTAL_IMPACT_ABSOLUTE'|'ANOMALY_TOTAL_IMPACT_PERCENTAGE',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE'|'GREATER_THAN_OR_EQUAL',
            ]
        },
        'Tags': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE'|'GREATER_THAN_OR_EQUAL',
            ]
        },
        'CostCategories': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE'|'GREATER_THAN_OR_EQUAL',
            ]
        }
    }
)

Parameters:

SavingsPlansType (string) –
[REQUIRED]

The Savings Plans recommendation type that’s requested.
TermInYears (string) –
[REQUIRED]

The savings plan recommendation term that’s used to generate these recommendations.
PaymentOption (string) –
[REQUIRED]

The payment option that’s used to generate these recommendations.
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.
NextPageToken (string) – The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
PageSize (integer) – The number of recommendations that you want returned in a single response object.
LookbackPeriodInDays (string) –
[REQUIRED]

The lookback period that’s used to generate the recommendation.
Filter (dict) –
You can filter your recommendations by Account ID with the LINKED_ACCOUNT dimension. To filter your recommendations by Account ID, specify Key as LINKED_ACCOUNT and Value as the comma-separated Acount ID(s) that you want to see Savings Plans purchase recommendations for.

For GetSavingsPlansPurchaseRecommendation, the Filter doesn’t include CostCategories or Tags. It only includes Dimensions. With Dimensions, Key must be LINKED_ACCOUNT and Value can be a single Account ID or multiple comma-separated Account IDs that you want to see Savings Plans Purchase Recommendations for. AND and OR operators are not supported.
- Or (list) –
  
  Return results that match either Dimension object.
  - (dict) –
    
    Use Expression to filter in various Cost Explorer APIs.
    
    Not all Expression types are supported in each API. Refer to the documentation for each specific API to see what is supported.
    
    There are two patterns:
    - Simple dimension values.
      - There are three types of simple dimension values: CostCategories, Tags, and Dimensions.
        
        Specify the CostCategories field to define a filter that acts on Cost Categories.
        
        Specify the Tags field to define a filter that acts on Cost Allocation Tags.
        
        Specify the Dimensions field to define a filter that acts on the DimensionValues.
      - For each filter type, you can set the dimension name and values for the filters that you plan to use.
        
        For example, you can filter for REGION==us-east-1 OR REGION==us-west-1. For GetRightsizingRecommendation, the Region is a full name (for example, REGION==US East (N. Virginia).
        
        The corresponding Expression for this example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] } }
        
        As shown in the previous example, lists of dimension values are combined with OR when applying the filter.
      - You can also set different match options to further control how the filter behaves. Not all APIs support match options. Refer to the documentation for each specific API to see what is supported.
        
        For example, you can filter for linked account names that start with “a”.
        
        The corresponding Expression for this example is as follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ "STARTS_WITH" ], "Values": [ "a" ] } }
    - Compound Expression types with logical operations.
      - You can use multiple Expression types and the logical operators AND/OR/NOT to create a list of one or more Expression objects. By doing this, you can filter by more advanced options.
      - For example, you can filter by ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer).
      - The corresponding Expression for this example is as follows: { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] }
    Note
    Because each Expression can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that creates an error: { "And": [ ... ], "Dimensions": { "Key": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }
    
    The following is an example of the corresponding error message: "Expression has more than one roots. Only one root operator is allowed for each expression: And, Or, Not, Dimensions, Tags, CostCategories"
    
    Note
    For the GetRightsizingRecommendation action, a combination of OR and NOT isn’t supported. OR isn’t supported between different dimensions, or dimensions and tags. NOT operators aren’t supported. Dimensions are also limited to LINKED_ACCOUNT, REGION, or RIGHTSIZING_TYPE.
    
    For the GetReservationPurchaseRecommendation action, only NOT is supported. AND and OR aren’t supported. Dimensions are limited to LINKED_ACCOUNT.
- And (list) –
  
  Return results that match both Dimension objects.
  - (dict) –
    
    Use Expression to filter in various Cost Explorer APIs.
    
    Not all Expression types are supported in each API. Refer to the documentation for each specific API to see what is supported.
    
    There are two patterns:
    - Simple dimension values.
      - There are three types of simple dimension values: CostCategories, Tags, and Dimensions.
        
        Specify the CostCategories field to define a filter that acts on Cost Categories.
        
        Specify the Tags field to define a filter that acts on Cost Allocation Tags.
        
        Specify the Dimensions field to define a filter that acts on the DimensionValues.
      - For each filter type, you can set the dimension name and values for the filters that you plan to use.
        
        For example, you can filter for REGION==us-east-1 OR REGION==us-west-1. For GetRightsizingRecommendation, the Region is a full name (for example, REGION==US East (N. Virginia).
        
        The corresponding Expression for this example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] } }
        
        As shown in the previous example, lists of dimension values are combined with OR when applying the filter.
      - You can also set different match options to further control how the filter behaves. Not all APIs support match options. Refer to the documentation for each specific API to see what is supported.
        
        For example, you can filter for linked account names that start with “a”.
        
        The corresponding Expression for this example is as follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ "STARTS_WITH" ], "Values": [ "a" ] } }
    - Compound Expression types with logical operations.
      - You can use multiple Expression types and the logical operators AND/OR/NOT to create a list of one or more Expression objects. By doing this, you can filter by more advanced options.
      - For example, you can filter by ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer).
      - The corresponding Expression for this example is as follows: { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] }
    Note
    Because each Expression can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that creates an error: { "And": [ ... ], "Dimensions": { "Key": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }
    
    The following is an example of the corresponding error message: "Expression has more than one roots. Only one root operator is allowed for each expression: And, Or, Not, Dimensions, Tags, CostCategories"
    
    Note
    For the GetRightsizingRecommendation action, a combination of OR and NOT isn’t supported. OR isn’t supported between different dimensions, or dimensions and tags. NOT operators aren’t supported. Dimensions are also limited to LINKED_ACCOUNT, REGION, or RIGHTSIZING_TYPE.
    
    For the GetReservationPurchaseRecommendation action, only NOT is supported. AND and OR aren’t supported. Dimensions are limited to LINKED_ACCOUNT.
- Not (dict) –
  
  Return results that don’t match a Dimension object.
- Dimensions (dict) –
  
  The specific Dimension to use for Expression.
  - Key (string) –
    
    The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.
    
    Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported.
    
    LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.
    
    ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.
  - Values (list) –
    
    The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.
    - (string) –
  - MatchOptions (list) –
    
    The match options that you can use to filter your results.
    
    MatchOptions is only applicable for actions related to Cost Category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported.
    
    The default values for MatchOptions are EQUALS and CASE_SENSITIVE.
    - (string) –
- Tags (dict) –
  
  The specific Tag to use for Expression.
  - Key (string) –
    
    The key for the tag.
  - Values (list) –
    
    The specific value of the tag.
    - (string) –
  - MatchOptions (list) –
    
    The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE.
    - (string) –
- CostCategories (dict) –
  
  The filter that’s based on CostCategory values.
  - Key (string) –
    
    The unique name of the Cost Category.
  - Values (list) –
    
    The specific value of the Cost Category.
    - (string) –
  - MatchOptions (list) –
    
    The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.
    - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Metadata': {
        'RecommendationId': 'string',
        'GenerationTimestamp': 'string',
        'AdditionalMetadata': 'string'
    },
    'SavingsPlansPurchaseRecommendation': {
        'AccountScope': 'PAYER'|'LINKED',
        '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',
        'LookbackPeriodInDays': 'SEVEN_DAYS'|'THIRTY_DAYS'|'SIXTY_DAYS',
        'SavingsPlansPurchaseRecommendationDetails': [
            {
                'SavingsPlansDetails': {
                    'Region': 'string',
                    'InstanceFamily': 'string',
                    'OfferingId': 'string'
                },
                'AccountId': 'string',
                'UpfrontCost': 'string',
                'EstimatedROI': 'string',
                'CurrencyCode': 'string',
                'EstimatedSPCost': 'string',
                'EstimatedOnDemandCost': 'string',
                'EstimatedOnDemandCostWithCurrentCommitment': 'string',
                'EstimatedSavingsAmount': 'string',
                'EstimatedSavingsPercentage': 'string',
                'HourlyCommitmentToPurchase': 'string',
                'EstimatedAverageUtilization': 'string',
                'EstimatedMonthlySavingsAmount': 'string',
                'CurrentMinimumHourlyOnDemandSpend': 'string',
                'CurrentMaximumHourlyOnDemandSpend': 'string',
                'CurrentAverageHourlyOnDemandSpend': 'string',
                'RecommendationDetailId': 'string'
            },
        ],
        'SavingsPlansPurchaseRecommendationSummary': {
            'EstimatedROI': 'string',
            'CurrencyCode': 'string',
            'EstimatedTotalCost': 'string',
            'CurrentOnDemandSpend': 'string',
            'EstimatedSavingsAmount': 'string',
            'TotalRecommendationCount': 'string',
            'DailyCommitmentToPurchase': 'string',
            'HourlyCommitmentToPurchase': 'string',
            'EstimatedSavingsPercentage': 'string',
            'EstimatedMonthlySavingsAmount': 'string',
            'EstimatedOnDemandCostWithCurrentCommitment': 'string'
        }
    },
    'NextPageToken': 'string'
}

Response Structure

(dict) –
- Metadata (dict) –
  
  Information that regards this specific recommendation set.
  - RecommendationId (string) –
    
    The unique identifier for the recommendation set.
  - GenerationTimestamp (string) –
    
    The timestamp that shows when the recommendations were generated.
  - AdditionalMetadata (string) –
    
    Additional metadata that might be applicable to the recommendation.
- SavingsPlansPurchaseRecommendation (dict) –
  
  Contains your request parameters, Savings Plan Recommendations Summary, and Details.
  - AccountScope (string) –
    
    The account scope that you want your recommendations for. Amazon Web Services calculates recommendations that include 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.
  - SavingsPlansType (string) –
    
    The requested Savings Plans recommendation type.
  - TermInYears (string) –
    
    The Savings Plans recommendation term in years. It’s used to generate the recommendation.
  - PaymentOption (string) –
    
    The payment option that’s used to generate the recommendation.
  - LookbackPeriodInDays (string) –
    
    The lookback period in days that’s used to generate the recommendation.
  - SavingsPlansPurchaseRecommendationDetails (list) –
    
    Details for the Savings Plans that we recommend that you purchase to cover existing Savings Plans eligible workloads.
    - (dict) –
      
      Details for your recommended Savings Plans.
      - SavingsPlansDetails (dict) –
        
        Details for your recommended Savings Plans.
        
        Region (string) –
        
        A collection of Amazon Web Services resources in a geographic area. Each Amazon Web Services Region is isolated and independent of the other Regions.
        
        InstanceFamily (string) –
        
        A group of instance types that Savings Plans applies to.
        
        OfferingId (string) –
        
        The unique ID that’s used to distinguish Savings Plans from one another.
      - AccountId (string) –
        
        The AccountID the recommendation is generated for.
      - UpfrontCost (string) –
        
        The upfront cost of the recommended Savings Plans, based on the selected payment option.
      - EstimatedROI (string) –
        
        The estimated return on investment that’s based on the recommended Savings Plans that you purchased. This is calculated as estimatedSavingsAmount/ ``estimatedSPCost``*100.
      - CurrencyCode (string) –
        
        The currency code that Amazon Web Services used to generate the recommendations and present potential savings.
      - EstimatedSPCost (string) –
        
        The cost of the recommended Savings Plans over the length of the lookback period.
      - EstimatedOnDemandCost (string) –
        
        The remaining On-Demand cost estimated to not be covered by the recommended Savings Plans, 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 Plans you own.
      - EstimatedSavingsAmount (string) –
        
        The estimated savings amount that’s based on the recommended Savings Plans 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.
      - HourlyCommitmentToPurchase (string) –
        
        The recommended hourly commitment level for the Savings Plans type and the configuration that’s based on the usage during the lookback period.
      - EstimatedAverageUtilization (string) –
        
        The estimated utilization of the recommended Savings Plans.
      - EstimatedMonthlySavingsAmount (string) –
        
        The estimated monthly savings amount based on the recommended Savings Plans.
      - CurrentMinimumHourlyOnDemandSpend (string) –
        
        The lowest 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.
      - CurrentAverageHourlyOnDemandSpend (string) –
        
        The average value of hourly On-Demand spend over the lookback period of the applicable usage type.
      - RecommendationDetailId (string) –
        
        Contains detailed information about a specific Savings Plan recommendation.
  - SavingsPlansPurchaseRecommendationSummary (dict) –
    
    Summary metrics for your Savings Plans Recommendations.
    - EstimatedROI (string) –
      
      The estimated return on investment that’s based on the recommended Savings Plans and estimated savings.
    - CurrencyCode (string) –
      
      The currency code that Amazon Web Services used to generate the recommendations and present potential savings.
    - EstimatedTotalCost (string) –
      
      The estimated total cost of the usage after purchasing the recommended Savings Plans. This is a sum of the cost of Savings Plans during this term, and the remaining On-Demand usage.
    - CurrentOnDemandSpend (string) –
      
      The current total on demand spend of the applicable usage types over the lookback period.
    - EstimatedSavingsAmount (string) –
      
      The estimated total savings over the lookback period, based on the purchase of the recommended Savings Plans.
    - TotalRecommendationCount (string) –
      
      The aggregate number of Savings Plans recommendations that exist for your account.
    - DailyCommitmentToPurchase (string) –
      
      The recommended Savings Plans cost on a daily (24 hourly) basis.
    - HourlyCommitmentToPurchase (string) –
      
      The recommended hourly commitment that’s based on the recommendation parameters.
    - EstimatedSavingsPercentage (string) –
      
      The estimated savings relative to the total cost of On-Demand usage, over the lookback period. This is calculated as estimatedSavingsAmount/ ``CurrentOnDemandSpend``*100.
    - EstimatedMonthlySavingsAmount (string) –
      
      The estimated monthly savings amount that’s based on the recommended Savings Plans purchase.
    - EstimatedOnDemandCostWithCurrentCommitment (string) –
      
      The estimated On-Demand costs you expect with no additional commitment. It’s based on your usage of the selected time period and the Savings Plans you own.
- NextPageToken (string) –
  
  The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

Exceptions

CostExplorer.Client.exceptions.LimitExceededException
CostExplorer.Client.exceptions.InvalidNextTokenException