:doc:`DeadlineCloud <../../deadline>` / Paginator / ListBudgets

***********
ListBudgets
***********



.. py:class:: DeadlineCloud.Paginator.ListBudgets

  ::

    
    paginator = client.get_paginator('list_budgets')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`DeadlineCloud.Client.list_budgets`.

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


    **Request Syntax**
    ::

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

      The farm ID associated with the budgets.

      

    
    :type status: string
    :param status: 

      The status to list for the budgets.

      

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

      
      ::

        {
            '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)
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

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

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    