DeadlineCloud / Paginator / ListBudgets


class DeadlineCloud.Paginator.ListBudgets#
paginator = client.get_paginator('list_budgets')

Creates an iterator that will paginate through responses from DeadlineCloud.Client.list_budgets().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • farmId (string) –


    The farm ID associated with the budgets.

  • status (string) – The status to list for the budgets.

  • PaginationConfig (dict) –

    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.

Return type:



Response Syntax

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

Response Structure

  • (dict) –

    • budgets (list) –

      The budgets to include on the list.

      • (dict) –

        The budget summary.

        • approximateDollarLimit (float) –

          The approximate dollar limit of the budget.

        • budgetId (string) –

          The budget ID.

        • createdAt (datetime) –

          The date and time the resource was created.

        • createdBy (string) –

          The user or system that created this resource.

        • description (string) –

          The description of the budget summary.

        • displayName (string) –

          The display name of the budget summary to update.

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

        • updatedAt (datetime) –

          The date and time the resource was updated.

        • updatedBy (string) –

          The user or system that updated this resource.

        • usageTrackingResource (dict) –

          The resource used to track expenditure in the budget.


          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.

        • usages (dict) –

          The consumed usage for the budget.

          • approximateDollarUsage (float) –

            The amount of the budget consumed.

    • NextToken (string) –

      A token to resume pagination.