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

*******************
list_bill_estimates
*******************



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

  

  Lists all bill estimates for the account.

  

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


  **Request Syntax**
  ::

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

    Filters to apply to the list of bill estimates.

    

  
    - *(dict) --* 

      Represents a filter for listing bill 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).

        

      
    

  :type createdAtFilter: dict
  :param createdAtFilter: 

    Filter bill estimates based on the creation date.

    

  
    - **afterTimestamp** *(datetime) --* 

      Include results after this timestamp.

      

    
    - **beforeTimestamp** *(datetime) --* 

      Include results before this timestamp.

      

    
  
  :type expiresAtFilter: dict
  :param expiresAtFilter: 

    Filter bill estimates based on the expiration date.

    

  
    - **afterTimestamp** *(datetime) --* 

      Include results after this timestamp.

      

    
    - **beforeTimestamp** *(datetime) --* 

      Include results before this timestamp.

      

    
  
  :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',
                  'name': 'string',
                  'status': 'IN_PROGRESS'|'COMPLETE'|'FAILED',
                  'billInterval': {
                      'start': datetime(2015, 1, 1),
                      'end': datetime(2015, 1, 1)
                  },
                  'createdAt': datetime(2015, 1, 1),
                  'expiresAt': datetime(2015, 1, 1)
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **items** *(list) --* 

        The list of bill estimates for the account.

        
        

        - *(dict) --* 

          Provides a summary of a bill estimate.

          
          

          - **id** *(string) --* 

            The unique identifier of the bill estimate.

            
          

          - **name** *(string) --* 

            The name of the bill estimate.

            
          

          - **status** *(string) --* 

            The current status of the bill estimate.

            
          

          - **billInterval** *(dict) --* 

            The time period covered by the bill estimate.

            
            

            - **start** *(datetime) --* 

              The start date and time of the interval.

              
            

            - **end** *(datetime) --* 

              The end date and time of the interval.

              
        
          

          - **createdAt** *(datetime) --* 

            The timestamp when the bill estimate was created.

            
          

          - **expiresAt** *(datetime) --* 

            The timestamp when the bill estimate will expire.

            
      
    
      

      - **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.AccessDeniedException`

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

  