BillingandCostManagementPricingCalculator / Client / list_bill_estimate_commitments

list_bill_estimate_commitments#

BillingandCostManagementPricingCalculator.Client.list_bill_estimate_commitments(**kwargs)#

Lists the commitments associated with a bill estimate.

Request Syntax

response = client.list_bill_estimate_commitments(
    billEstimateId='string',
    nextToken='string',
    maxResults=123
)

Parameters:

billEstimateId (string) –
[REQUIRED]

The unique identifier of the bill estimate to list commitments for.
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',
            'purchaseAgreementType': 'SAVINGS_PLANS'|'RESERVED_INSTANCE',
            'offeringId': 'string',
            'usageAccountId': 'string',
            'region': 'string',
            'termLength': 'string',
            'paymentOption': 'string',
            'upfrontPayment': {
                'amount': 123.0,
                'currency': 'USD'
            },
            'monthlyPayment': {
                'amount': 123.0,
                'currency': 'USD'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- items (list) –
  
  The list of commitments associated with the bill estimate.
  - (dict) –
    
    Provides a summary of commitment-related information for a bill estimate.
    - id (string) –
      
      The unique identifier of the commitment.
    - purchaseAgreementType (string) –
      
      The type of purchase agreement (e.g., Reserved Instance, Savings Plan).
    - offeringId (string) –
      
      The identifier of the specific offering associated with this commitment.
    - usageAccountId (string) –
      
      The Amazon Web Services account ID associated with this commitment.
    - region (string) –
      
      The Amazon Web Services region associated with this commitment.
    - termLength (string) –
      
      The length of the commitment term.
    - paymentOption (string) –
      
      The payment option chosen for this commitment (e.g., All Upfront, Partial Upfront, No Upfront).
    - upfrontPayment (dict) –
      
      The upfront payment amount for this commitment, if applicable.
      - amount (float) –
        
        The numeric value of the cost.
      - currency (string) –
        
        The currency code for the cost amount.
    - monthlyPayment (dict) –
      
      The monthly payment amount for this commitment, if applicable.
      - amount (float) –
        
        The numeric value of the cost.
      - currency (string) –
        
        The currency code for the cost amount.
- 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.ResourceNotFoundException
BillingandCostManagementPricingCalculator.Client.exceptions.AccessDeniedException
BillingandCostManagementPricingCalculator.Client.exceptions.ThrottlingException