BillingandCostManagementPricingCalculator / Client / get_workload_estimate

get_workload_estimate#

BillingandCostManagementPricingCalculator.Client.get_workload_estimate(**kwargs)#

Retrieves details of a specific workload estimate.

Request Syntax

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

Parameters:

identifier (string) –

[REQUIRED]

The unique identifier of the workload estimate to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'name': 'string',
    'createdAt': datetime(2015, 1, 1),
    'expiresAt': datetime(2015, 1, 1),
    'rateType': 'BEFORE_DISCOUNTS'|'AFTER_DISCOUNTS',
    'rateTimestamp': datetime(2015, 1, 1),
    'status': 'UPDATING'|'VALID'|'INVALID'|'ACTION_NEEDED',
    'totalCost': 123.0,
    'costCurrency': 'USD',
    'failureMessage': 'string'
}

Response Structure

(dict) –

Mixin for common fields returned by CRUD APIs
- id (string) –
  
  The unique identifier of the retrieved workload estimate.
- name (string) –
  
  The name of the retrieved workload estimate.
- createdAt (datetime) –
  
  The timestamp when the workload estimate was created.
- expiresAt (datetime) –
  
  The timestamp when the workload estimate will expire.
- rateType (string) –
  
  The type of pricing rates used for the estimate.
- rateTimestamp (datetime) –
  
  The timestamp of the pricing rates used for the estimate.
- status (string) –
  
  The current status of the workload estimate.
- totalCost (float) –
  
  The total estimated cost for the workload.
- costCurrency (string) –
  
  The currency of the estimated cost.
- failureMessage (string) –
  
  An error message if the workload estimate retrieval failed.

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