BillingandCostManagementPricingCalculator / Client / get_bill_estimate

get_bill_estimate#

BillingandCostManagementPricingCalculator.Client.get_bill_estimate(**kwargs)#

Retrieves details of a specific bill estimate.

Request Syntax

response = client.get_bill_estimate(
    identifier='string'
)

Parameters:

identifier (string) –

[REQUIRED]

The unique identifier of the bill estimate to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'name': 'string',
    'status': 'IN_PROGRESS'|'COMPLETE'|'FAILED',
    'failureMessage': 'string',
    'billInterval': {
        'start': datetime(2015, 1, 1),
        'end': datetime(2015, 1, 1)
    },
    'costSummary': {
        'totalCostDifference': {
            'historicalCost': {
                'amount': 123.0,
                'currency': 'USD'
            },
            'estimatedCost': {
                'amount': 123.0,
                'currency': 'USD'
            }
        },
        'serviceCostDifferences': {
            'string': {
                'historicalCost': {
                    'amount': 123.0,
                    'currency': 'USD'
                },
                'estimatedCost': {
                    'amount': 123.0,
                    'currency': 'USD'
                }
            }
        }
    },
    'createdAt': datetime(2015, 1, 1),
    'expiresAt': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- id (string) –
  
  The unique identifier of the retrieved bill estimate.
- name (string) –
  
  The name of the retrieved bill estimate.
- status (string) –
  
  The current status of the bill estimate.
- failureMessage (string) –
  
  An error message if the bill estimate retrieval failed.
- billInterval (dict) –
  
  The time period covered by the bill estimate.
  - start (datetime) –
    
    The start date and time of the interval.
  - end (datetime) –
    
    The end date and time of the interval.
- costSummary (dict) –
  
  A summary of the estimated costs.
  - totalCostDifference (dict) –
    
    The total difference in cost between the estimated and historical costs.
    - historicalCost (dict) –
      
      The historical cost amount.
      - amount (float) –
        
        The numeric value of the cost.
      - currency (string) –
        
        The currency code for the cost amount.
    - estimatedCost (dict) –
      
      The estimated cost amount.
      - amount (float) –
        
        The numeric value of the cost.
      - currency (string) –
        
        The currency code for the cost amount.
  - serviceCostDifferences (dict) –
    
    A breakdown of cost differences by Amazon Web Services service.
    - (string) –
      - (dict) –
        
        Represents the difference between historical and estimated costs.
        
        historicalCost (dict) –
        
        The historical cost amount.
        
        amount (float) –
        
        The numeric value of the cost.
        
        currency (string) –
        
        The currency code for the cost amount.
        
        estimatedCost (dict) –
        
        The estimated cost amount.
        
        amount (float) –
        
        The numeric value of the cost.
        
        currency (string) –
        
        The currency code for the cost amount.
- createdAt (datetime) –
  
  The timestamp when the bill estimate was created.
- expiresAt (datetime) –
  
  The timestamp when the bill estimate will expire.

Exceptions

BillingandCostManagementPricingCalculator.Client.exceptions.ValidationException
BillingandCostManagementPricingCalculator.Client.exceptions.DataUnavailableException
BillingandCostManagementPricingCalculator.Client.exceptions.InternalServerException
BillingandCostManagementPricingCalculator.Client.exceptions.ResourceNotFoundException
BillingandCostManagementPricingCalculator.Client.exceptions.AccessDeniedException
BillingandCostManagementPricingCalculator.Client.exceptions.ThrottlingException