Skip to content

ListBudgetsRequest

Source code in docs_src/capo_deadline/types/list_budgets_request.py
class ListBudgetsRequest(TypedDict, closed=True):
    farm_id: "capo_deadline.types.farm_id.FarmId"
    """<p>The farm ID associated with the budgets.</p>"""
    next_token: NotRequired["capo_deadline.types.next_token.NextToken"]
    """<p>The token for the next set of results, or <code>null</code> to start from the beginning.</p>"""
    max_results: "capo_deadline.types.max_results.MaxResults"
    """<p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>"""
    status: NotRequired["capo_deadline.types.budget_status.BudgetStatus"]
    """<p>The status to list for the budgets.</p>"""

farm_id instance-attribute

farm_id: FarmId

The farm ID associated with the budgets.

max_results instance-attribute

max_results: MaxResults

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

next_token instance-attribute

next_token: NotRequired[NextToken]

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

status instance-attribute

status: NotRequired[BudgetStatus]

The status to list for the budgets.