CostExplorer / Client / get_savings_plans_utilization

get_savings_plans_utilization#

CostExplorer.Client.get_savings_plans_utilization(**kwargs)#

Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity. Management account in an organization have access to member accounts. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values.

Note

You can’t group by any dimension values for GetSavingsPlansUtilization.

See also: AWS API Documentation

Request Syntax

response = client.get_savings_plans_utilization(
    TimePeriod={
        'Start': 'string',
        'End': 'string'
    },
    Granularity='DAILY'|'MONTHLY'|'HOURLY',
    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',
            ]
        }
    },
    SortBy={
        'Key': 'string',
        'SortOrder': 'ASCENDING'|'DESCENDING'
    }
)

Parameters:

TimePeriod (dict) –
[REQUIRED]

The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can’t be used as an End date.
- Start (string) – [REQUIRED]
  
  The beginning of the time period. The start date is inclusive. For example, if start is 2017-01-01, Amazon Web Services retrieves cost and usage data starting at 2017-01-01 up to the end date. The start date must be equal to or no later than the current date to avoid a validation error.
- End (string) – [REQUIRED]
  
  The end of the time period. The end date is exclusive. For example, if end is 2017-05-01, Amazon Web Services retrieves cost and usage data from the start date up to, but not including, 2017-05-01.
Granularity (string) –
The granularity of the Amazon Web Services utillization data for your Savings Plans.

The GetSavingsPlansUtilization operation supports only DAILY and MONTHLY granularities.
Filter (dict) –
Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:
- LINKED_ACCOUNT
- SAVINGS_PLAN_ARN
- SAVINGS_PLANS_TYPE
- REGION
- PAYMENT_OPTION
- INSTANCE_TYPE_FAMILY
GetSavingsPlansUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension.
- 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) –
SortBy (dict) –
The value that you want to sort the data by.

The following values are supported for Key:
- UtilizationPercentage
- TotalCommitment
- UsedCommitment
- UnusedCommitment
- NetSavings
The supported values for SortOrder are ASCENDING and DESCENDING.
- Key (string) – [REQUIRED]
  
  The key that’s used to sort the data.
- SortOrder (string) –
  
  The order that’s used to sort the data.

Return type:

dict

Returns:

Response Syntax

{
    'SavingsPlansUtilizationsByTime': [
        {
            'TimePeriod': {
                'Start': 'string',
                'End': 'string'
            },
            'Utilization': {
                'TotalCommitment': 'string',
                'UsedCommitment': 'string',
                'UnusedCommitment': 'string',
                'UtilizationPercentage': 'string'
            },
            'Savings': {
                'NetSavings': 'string',
                'OnDemandCostEquivalent': 'string'
            },
            'AmortizedCommitment': {
                'AmortizedRecurringCommitment': 'string',
                'AmortizedUpfrontCommitment': 'string',
                'TotalAmortizedCommitment': 'string'
            }
        },
    ],
    'Total': {
        'Utilization': {
            'TotalCommitment': 'string',
            'UsedCommitment': 'string',
            'UnusedCommitment': 'string',
            'UtilizationPercentage': 'string'
        },
        'Savings': {
            'NetSavings': 'string',
            'OnDemandCostEquivalent': 'string'
        },
        'AmortizedCommitment': {
            'AmortizedRecurringCommitment': 'string',
            'AmortizedUpfrontCommitment': 'string',
            'TotalAmortizedCommitment': 'string'
        }
    }
}

Response Structure

(dict) –
- SavingsPlansUtilizationsByTime (list) –
  
  The amount of cost/commitment that you used your Savings Plans. You can use it to specify date ranges.
  - (dict) –
    
    The amount of Savings Plans utilization (in hours).
    - TimePeriod (dict) –
      
      The time period of the request.
      - Start (string) –
        
        The beginning of the time period. The start date is inclusive. For example, if start is 2017-01-01, Amazon Web Services retrieves cost and usage data starting at 2017-01-01 up to the end date. The start date must be equal to or no later than the current date to avoid a validation error.
      - End (string) –
        
        The end of the time period. The end date is exclusive. For example, if end is 2017-05-01, Amazon Web Services retrieves cost and usage data from the start date up to, but not including, 2017-05-01.
    - Utilization (dict) –
      
      A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings Plans eligible.
      - TotalCommitment (string) –
        
        The total amount of Savings Plans commitment that’s been purchased in an account (or set of accounts).
      - UsedCommitment (string) –
        
        The amount of your Savings Plans commitment that was consumed from Savings Plans eligible usage in a specific period.
      - UnusedCommitment (string) –
        
        The amount of your Savings Plans commitment that wasn’t consumed from Savings Plans eligible usage in a specific period.
      - UtilizationPercentage (string) –
        
        The amount of UsedCommitment divided by the TotalCommitment for your Savings Plans.
    - Savings (dict) –
      
      The amount that’s saved by using existing Savings Plans. Savings returns both net savings from Savings Plans and also the onDemandCostEquivalent of the Savings Plans when considering the utilization rate.
      - NetSavings (string) –
        
        The savings amount that you’re accumulating for the usage that’s covered by a Savings Plans, when compared to the On-Demand equivalent of the same usage.
      - OnDemandCostEquivalent (string) –
        
        How much the amount that the usage would have cost if it was accrued at the On-Demand rate.
    - AmortizedCommitment (dict) –
      
      The total amortized commitment for a Savings Plans. This includes the sum of the upfront and recurring Savings Plans fees.
      - AmortizedRecurringCommitment (string) –
        
        The amortized amount of your Savings Plans commitment that was purchased with either a Partial or a NoUpfront.
      - AmortizedUpfrontCommitment (string) –
        
        The amortized amount of your Savings Plans commitment that was purchased with an Upfront or PartialUpfront Savings Plans.
      - TotalAmortizedCommitment (string) –
        
        The total amortized amount of your Savings Plans commitment, regardless of your Savings Plans purchase method.
- Total (dict) –
  
  The total amount of cost/commitment that you used your Savings Plans, regardless of date ranges.
  - Utilization (dict) –
    
    A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings Plans eligible.
    - TotalCommitment (string) –
      
      The total amount of Savings Plans commitment that’s been purchased in an account (or set of accounts).
    - UsedCommitment (string) –
      
      The amount of your Savings Plans commitment that was consumed from Savings Plans eligible usage in a specific period.
    - UnusedCommitment (string) –
      
      The amount of your Savings Plans commitment that wasn’t consumed from Savings Plans eligible usage in a specific period.
    - UtilizationPercentage (string) –
      
      The amount of UsedCommitment divided by the TotalCommitment for your Savings Plans.
  - Savings (dict) –
    
    The amount that’s saved by using existing Savings Plans. Savings returns both net savings from Savings Plans and also the onDemandCostEquivalent of the Savings Plans when considering the utilization rate.
    - NetSavings (string) –
      
      The savings amount that you’re accumulating for the usage that’s covered by a Savings Plans, when compared to the On-Demand equivalent of the same usage.
    - OnDemandCostEquivalent (string) –
      
      How much the amount that the usage would have cost if it was accrued at the On-Demand rate.
  - AmortizedCommitment (dict) –
    
    The total amortized commitment for a Savings Plans. This includes the sum of the upfront and recurring Savings Plans fees.
    - AmortizedRecurringCommitment (string) –
      
      The amortized amount of your Savings Plans commitment that was purchased with either a Partial or a NoUpfront.
    - AmortizedUpfrontCommitment (string) –
      
      The amortized amount of your Savings Plans commitment that was purchased with an Upfront or PartialUpfront Savings Plans.
    - TotalAmortizedCommitment (string) –
      
      The total amortized amount of your Savings Plans commitment, regardless of your Savings Plans purchase method.

Exceptions

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