BillingandCostManagementPricingCalculator / Client / list_workload_estimates

list_workload_estimates#

BillingandCostManagementPricingCalculator.Client.list_workload_estimates(**kwargs)#

Lists all workload estimates for the account.

Request Syntax

response = client.list_workload_estimates(
    createdAtFilter={
        'afterTimestamp': datetime(2015, 1, 1),
        'beforeTimestamp': datetime(2015, 1, 1)
    },
    expiresAtFilter={
        'afterTimestamp': datetime(2015, 1, 1),
        'beforeTimestamp': datetime(2015, 1, 1)
    },
    filters=[
        {
            'name': 'STATUS'|'NAME',
            'values': [
                'string',
            ],
            'matchOption': 'EQUALS'|'STARTS_WITH'|'CONTAINS'
        },
    ],
    nextToken='string',
    maxResults=123
)

Parameters:

createdAtFilter (dict) –
Filter workload estimates based on their creation date.
- afterTimestamp (datetime) –
  
  Include results after this timestamp.
- beforeTimestamp (datetime) –
  
  Include results before this timestamp.
expiresAtFilter (dict) –
Filter workload estimates based on their expiration date.
- afterTimestamp (datetime) –
  
  Include results after this timestamp.
- beforeTimestamp (datetime) –
  
  Include results before this timestamp.
filters (list) –
Filters to apply to the list of workload estimates.
- (dict) –
  
  Represents a filter for listing workload estimates.
  - name (string) – [REQUIRED]
    
    The name of the filter attribute.
  - values (list) – [REQUIRED]
    
    The values to filter by.
    - (string) –
  - matchOption (string) –
    
    The match option for the filter (e.g., equals, contains).
nextToken (string) – A token to retrieve the next page of results.
maxResults (integer) – The maximum number of results to return per page.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            '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'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- items (list) –
  
  The list of workload estimates for the account.
  - (dict) –
    
    Provides a summary of a workload estimate.
    - id (string) –
      
      The unique identifier of the workload estimate.
    - name (string) –
      
      The name of the 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 creation or processing failed.
- nextToken (string) –
  
  A token to retrieve the next page of results, if any.

Exceptions

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