:doc:`BillingandCostManagementPricingCalculator <../../bcm-pricing-calculator>` / Client / list_bill_estimate_commitments

******************************
list_bill_estimate_commitments
******************************



.. py:method:: BillingandCostManagementPricingCalculator.Client.list_bill_estimate_commitments(**kwargs)

  

  Lists the commitments associated with a bill estimate.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/bcm-pricing-calculator-2024-06-19/ListBillEstimateCommitments>`_  


  **Request Syntax**
  ::

    response = client.list_bill_estimate_commitments(
        billEstimateId='string',
        nextToken='string',
        maxResults=123
    )
    
  :type billEstimateId: string
  :param billEstimateId: **[REQUIRED]** 

    The unique identifier of the bill estimate to list commitments for.

    

  
  :type nextToken: string
  :param nextToken: 

    A token to retrieve the next page of results.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return per page.

    

  
  
  :rtype: 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**
  
  *   :py:class:`BillingandCostManagementPricingCalculator.Client.exceptions.ValidationException`

  
  *   :py:class:`BillingandCostManagementPricingCalculator.Client.exceptions.DataUnavailableException`

  
  *   :py:class:`BillingandCostManagementPricingCalculator.Client.exceptions.InternalServerException`

  
  *   :py:class:`BillingandCostManagementPricingCalculator.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`BillingandCostManagementPricingCalculator.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`BillingandCostManagementPricingCalculator.Client.exceptions.ThrottlingException`

  