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

**********
get_budget
**********



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

  

  Get a budget.

  

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


  **Request Syntax**
  ::

    response = client.get_budget(
        farmId='string',
        budgetId='string'
    )
    
  :type farmId: string
  :param farmId: **[REQUIRED]** 

    The farm ID of the farm connected to the budget.

    

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

    The budget ID.

    

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

    
    ::

      {
          'budgetId': 'string',
          'usageTrackingResource': {
              'queueId': 'string'
          },
          'status': 'ACTIVE'|'INACTIVE',
          'displayName': 'string',
          'description': 'string',
          'approximateDollarLimit': ...,
          'usages': {
              'approximateDollarUsage': ...
          },
          'actions': [
              {
                  'type': 'STOP_SCHEDULING_AND_COMPLETE_TASKS'|'STOP_SCHEDULING_AND_CANCEL_TASKS',
                  'thresholdPercentage': ...,
                  'description': 'string'
              },
          ],
          'schedule': {
              'fixed': {
                  'startTime': datetime(2015, 1, 1),
                  'endTime': datetime(2015, 1, 1)
              }
          },
          'createdBy': 'string',
          'createdAt': datetime(2015, 1, 1),
          'updatedBy': 'string',
          'updatedAt': datetime(2015, 1, 1),
          'queueStoppedAt': datetime(2015, 1, 1)
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The budget ID.

        
      

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

        The resource that the budget is tracking usage for.

        .. 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``–Get a budget being evaluated.
         
        * ``INACTIVE``–Get an inactive budget. This can include expired, canceled, or deleted statuses.
        

        
      

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

        The display name of the budget.

         

        .. 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.

         

        .. 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 consumed usage limit for the budget.

        
      

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

        The usages of the budget.

        
        

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

          The amount of the budget consumed.

          
    
      

      - **actions** *(list) --* 

        The budget actions for the budget.

        
        

        - *(dict) --* 

          The details of a budget action.

          
          

          - **type** *(string) --* 

            The action taken on the budget once scheduling stops.

            
          

          - **thresholdPercentage** *(float) --* 

            The percentage threshold for the budget.

            
          

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

            The budget action description.

             

            .. 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.

              

            
      
    
      

      - **schedule** *(dict) --* 

        The budget schedule.

        .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``fixed``.     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'}


      
        

        - **fixed** *(dict) --* 

          The fixed start and end time of the budget's schedule.

          
          

          - **startTime** *(datetime) --* 

            When the budget starts.

            
          

          - **endTime** *(datetime) --* 

            When the budget ends.

            
      
    
      

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

        
      

      - **queueStoppedAt** *(datetime) --* 

        The date and time the queue stopped.

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

  