:doc:`BillingandCostManagementPricingCalculator <../../bcm-pricing-calculator>` / Paginator / ListBillEstimateCommitments

***************************
ListBillEstimateCommitments
***************************



.. py:class:: BillingandCostManagementPricingCalculator.Paginator.ListBillEstimateCommitments

  ::

    
    paginator = client.get_paginator('list_bill_estimate_commitments')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`BillingandCostManagementPricingCalculator.Client.list_bill_estimate_commitments`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          billEstimateId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type billEstimateId: string
    :param billEstimateId: **[REQUIRED]** 

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

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :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 resume pagination.

          
    