:doc:`DeadlineCloud <../../deadline>` / Client / list_budgets

************
list_budgets
************



.. py:method:: DeadlineCloud.Client.list_budgets(**kwargs)

  

  A list of budgets in a farm.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/deadline-2023-10-12/ListBudgets>`_  


  **Request Syntax**
  ::

    response = client.list_budgets(
        nextToken='string',
        farmId='string',
        maxResults=123,
        status='ACTIVE'|'INACTIVE'
    )
    
  :type nextToken: string
  :param nextToken: 

    The token for the next set of results, or ``null`` to start from the beginning.

    

  
  :type farmId: string
  :param farmId: **[REQUIRED]** 

    The farm ID associated with the budgets.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return. Use this parameter with ``NextToken`` to get results as a set of sequential pages.

    

  
  :type status: string
  :param status: 

    The status to list for the budgets.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'nextToken': 'string',
          'budgets': [
              {
                  'budgetId': 'string',
                  'usageTrackingResource': {
                      'queueId': 'string'
                  },
                  'status': 'ACTIVE'|'INACTIVE',
                  'displayName': 'string',
                  'description': 'string',
                  'approximateDollarLimit': ...,
                  'usages': {
                      'approximateDollarUsage': ...
                  },
                  'createdBy': 'string',
                  'createdAt': datetime(2015, 1, 1),
                  'updatedBy': 'string',
                  'updatedAt': datetime(2015, 1, 1)
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **nextToken** *(string) --* 

        If Deadline Cloud returns ``nextToken``, then there are more results available. The value of ``nextToken`` is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then ``nextToken`` is set to ``null``. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ``ValidationException`` error.

        
      

      - **budgets** *(list) --* 

        The budgets to include on the list.

        
        

        - *(dict) --* 

          The budget summary.

          
          

          - **budgetId** *(string) --* 

            The budget ID.

            
          

          - **usageTrackingResource** *(dict) --* 

            The resource used to track expenditure in the budget.

            .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``queueId``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


          
            

            - **queueId** *(string) --* 

              The queue ID.

              
        
          

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

            The status of the budget.

             

            
            * ``ACTIVE``–The budget is being evaluated.
             
            * ``INACTIVE``–The budget is inactive. This can include Expired, Canceled, or deleted Deleted statuses.
            

            
          

          - **displayName** *(string) --* 

            The display name of the budget summary to update.

             

            .. warning::

               

              This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

              

            
          

          - **description** *(string) --* 

            The description of the budget summary.

             

            .. warning::

               

              This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

              

            
          

          - **approximateDollarLimit** *(float) --* 

            The approximate dollar limit of the budget.

            
          

          - **usages** *(dict) --* 

            The consumed usage for the budget.

            
            

            - **approximateDollarUsage** *(float) --* 

              The amount of the budget consumed.

              
        
          

          - **createdBy** *(string) --* 

            The user or system that created this resource.

            
          

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

            The date and time the resource was created.

            
          

          - **updatedBy** *(string) --* 

            The user or system that updated this resource.

            
          

          - **updatedAt** *(datetime) --* 

            The date and time the resource was updated.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`DeadlineCloud.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`DeadlineCloud.Client.exceptions.InternalServerErrorException`

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

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

  
  *   :py:class:`DeadlineCloud.Client.exceptions.ValidationException`

  