CostExplorer / Client / get_reservation_coverage

get_reservation_coverage#

CostExplorer.Client.get_reservation_coverage(**kwargs)#

Retrieves the reservation coverage for your account, which you can use to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation. An organization’s management account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. For any time period, you can filter data about reservation usage by the following dimensions:

AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
SERVICE
TAG
TENANCY

To determine valid values for a dimension, use the GetDimensionValues operation.

See also: AWS API Documentation

Request Syntax

response = client.get_reservation_coverage(
    TimePeriod={
        'Start': 'string',
        'End': 'string'
    },
    GroupBy=[
        {
            'Type': 'DIMENSION'|'TAG'|'COST_CATEGORY',
            'Key': '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',
            ]
        }
    },
    Metrics=[
        'string',
    ],
    NextPageToken='string',
    SortBy={
        'Key': 'string',
        'SortOrder': 'ASCENDING'|'DESCENDING'
    },
    MaxResults=123
)

Parameters:

TimePeriod (dict) –
[REQUIRED]

The start and end dates of the period that you want to retrieve data about reservation coverage for. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01 , then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01 .
- 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 .
GroupBy (list) –
You can group the data by the following attributes:
- AZ
- CACHE_ENGINE
- DATABASE_ENGINE
- DEPLOYMENT_OPTION
- INSTANCE_TYPE
- INVOICING_ENTITY
- LINKED_ACCOUNT
- OPERATING_SYSTEM
- PLATFORM
- REGION
- TENANCY
- (dict) –
  
  Represents a group when you specify a group by criteria or in the response to a query with a specific grouping.
  - Type (string) –
    
    The string that represents the type of group.
  - Key (string) –
    
    The string that represents a key for a specified group.
Granularity (string) –
The granularity of the Amazon Web Services cost data for the reservation. Valid values are MONTHLY and DAILY .

If GroupBy is set, Granularity can’t be set. If Granularity isn’t set, the response object doesn’t include Granularity , either MONTHLY or DAILY .

The GetReservationCoverage operation supports only DAILY and MONTHLY granularities.
Filter (dict) –
Filters utilization data by dimensions. You can filter by the following dimensions:
- AZ
- CACHE_ENGINE
- DATABASE_ENGINE
- DEPLOYMENT_OPTION
- INSTANCE_TYPE
- LINKED_ACCOUNT
- OPERATING_SYSTEM
- PLATFORM
- REGION
- SERVICE
- TAG
- TENANCY
GetReservationCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR’d together.

If you don’t provide a SERVICE filter, Cost Explorer defaults to EC2.

Cost category is also 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) –
Metrics (list) –
The measurement that you want your reservation coverage reported in.

Valid values are Hour , Unit , and Cost . You can use multiple values in a request.
- (string) –
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.
SortBy (dict) –
The value by which you want to sort the data.

The following values are supported for Key :
- OnDemandCost
- CoverageHoursPercentage
- OnDemandHours
- ReservedHours
- TotalRunningHours
- CoverageNormalizedUnitsPercentage
- OnDemandNormalizedUnits
- ReservedNormalizedUnits
- TotalRunningNormalizedUnits
- Time
Supported values for SortOrder are ASCENDING or DESCENDING .
- Key (string) – [REQUIRED]
  
  The key that’s used to sort the data.
- SortOrder (string) –
  
  The order that’s used to sort the data.
MaxResults (integer) – The maximum number of objects that you returned for this request. If more objects are available, in the response, Amazon Web Services provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.

Return type:

dict

Returns:

Response Syntax

{
    'CoveragesByTime': [
        {
            'TimePeriod': {
                'Start': 'string',
                'End': 'string'
            },
            'Groups': [
                {
                    'Attributes': {
                        'string': 'string'
                    },
                    'Coverage': {
                        'CoverageHours': {
                            'OnDemandHours': 'string',
                            'ReservedHours': 'string',
                            'TotalRunningHours': 'string',
                            'CoverageHoursPercentage': 'string'
                        },
                        'CoverageNormalizedUnits': {
                            'OnDemandNormalizedUnits': 'string',
                            'ReservedNormalizedUnits': 'string',
                            'TotalRunningNormalizedUnits': 'string',
                            'CoverageNormalizedUnitsPercentage': 'string'
                        },
                        'CoverageCost': {
                            'OnDemandCost': 'string'
                        }
                    }
                },
            ],
            'Total': {
                'CoverageHours': {
                    'OnDemandHours': 'string',
                    'ReservedHours': 'string',
                    'TotalRunningHours': 'string',
                    'CoverageHoursPercentage': 'string'
                },
                'CoverageNormalizedUnits': {
                    'OnDemandNormalizedUnits': 'string',
                    'ReservedNormalizedUnits': 'string',
                    'TotalRunningNormalizedUnits': 'string',
                    'CoverageNormalizedUnitsPercentage': 'string'
                },
                'CoverageCost': {
                    'OnDemandCost': 'string'
                }
            }
        },
    ],
    'Total': {
        'CoverageHours': {
            'OnDemandHours': 'string',
            'ReservedHours': 'string',
            'TotalRunningHours': 'string',
            'CoverageHoursPercentage': 'string'
        },
        'CoverageNormalizedUnits': {
            'OnDemandNormalizedUnits': 'string',
            'ReservedNormalizedUnits': 'string',
            'TotalRunningNormalizedUnits': 'string',
            'CoverageNormalizedUnitsPercentage': 'string'
        },
        'CoverageCost': {
            'OnDemandCost': 'string'
        }
    },
    'NextPageToken': 'string'
}

Response Structure

(dict) –
- CoveragesByTime (list) –
  
  The amount of time that your reservations covered.
  - (dict) –
    
    Reservation coverage for a specified period, in hours.
    - TimePeriod (dict) –
      
      The period that this coverage was used over.
      - 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 .
    - Groups (list) –
      
      The groups of instances that the reservation covered.
      - (dict) –
        
        A group of reservations that share a set of attributes.
        
        Attributes (dict) –
        
        The attributes for this group of reservations.
        
        (string) –
        
        (string) –
        
        Coverage (dict) –
        
        How much instance usage this group of reservations covered.
        
        CoverageHours (dict) –
        
        The amount of instance usage that the reservation covered, in hours.
        
        OnDemandHours (string) –
        
        The number of instance running hours that On-Demand Instances covered.
        
        ReservedHours (string) –
        
        The number of instance running hours that reservations covered.
        
        TotalRunningHours (string) –
        
        The total instance usage, in hours.
        
        CoverageHoursPercentage (string) –
        
        The percentage of instance hours that a reservation covered.
        
        CoverageNormalizedUnits (dict) –
        
        The amount of instance usage that the reservation covered, in normalized units.
        
        OnDemandNormalizedUnits (string) –
        
        The number of normalized units that are covered by On-Demand Instances instead of a reservation.
        
        ReservedNormalizedUnits (string) –
        
        The number of normalized units that a reservation covers.
        
        TotalRunningNormalizedUnits (string) –
        
        The total number of normalized units that you used.
        
        CoverageNormalizedUnitsPercentage (string) –
        
        The percentage of your used instance normalized units that a reservation covers.
        
        CoverageCost (dict) –
        
        The amount of cost that the reservation covered.
        
        OnDemandCost (string) –
        
        How much an On-Demand Instance costs.
    - Total (dict) –
      
      The total reservation coverage, in hours.
      - CoverageHours (dict) –
        
        The amount of instance usage that the reservation covered, in hours.
        
        OnDemandHours (string) –
        
        The number of instance running hours that On-Demand Instances covered.
        
        ReservedHours (string) –
        
        The number of instance running hours that reservations covered.
        
        TotalRunningHours (string) –
        
        The total instance usage, in hours.
        
        CoverageHoursPercentage (string) –
        
        The percentage of instance hours that a reservation covered.
      - CoverageNormalizedUnits (dict) –
        
        The amount of instance usage that the reservation covered, in normalized units.
        
        OnDemandNormalizedUnits (string) –
        
        The number of normalized units that are covered by On-Demand Instances instead of a reservation.
        
        ReservedNormalizedUnits (string) –
        
        The number of normalized units that a reservation covers.
        
        TotalRunningNormalizedUnits (string) –
        
        The total number of normalized units that you used.
        
        CoverageNormalizedUnitsPercentage (string) –
        
        The percentage of your used instance normalized units that a reservation covers.
      - CoverageCost (dict) –
        
        The amount of cost that the reservation covered.
        
        OnDemandCost (string) –
        
        How much an On-Demand Instance costs.
- Total (dict) –
  
  The total amount of instance usage that a reservation covered.
  - CoverageHours (dict) –
    
    The amount of instance usage that the reservation covered, in hours.
    - OnDemandHours (string) –
      
      The number of instance running hours that On-Demand Instances covered.
    - ReservedHours (string) –
      
      The number of instance running hours that reservations covered.
    - TotalRunningHours (string) –
      
      The total instance usage, in hours.
    - CoverageHoursPercentage (string) –
      
      The percentage of instance hours that a reservation covered.
  - CoverageNormalizedUnits (dict) –
    
    The amount of instance usage that the reservation covered, in normalized units.
    - OnDemandNormalizedUnits (string) –
      
      The number of normalized units that are covered by On-Demand Instances instead of a reservation.
    - ReservedNormalizedUnits (string) –
      
      The number of normalized units that a reservation covers.
    - TotalRunningNormalizedUnits (string) –
      
      The total number of normalized units that you used.
    - CoverageNormalizedUnitsPercentage (string) –
      
      The percentage of your used instance normalized units that a reservation covers.
  - CoverageCost (dict) –
    
    The amount of cost that the reservation covered.
    - OnDemandCost (string) –
      
      How much an On-Demand Instance costs.
- 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.DataUnavailableException
CostExplorer.Client.exceptions.InvalidNextTokenException