Skip to content

AccessBudgetDetails

Source code in docs_src/capo_cleanroomsml/types/access_budget_details.py
class AccessBudgetDetails(TypedDict, closed=True):
    start_time: "datetime.datetime"
    """<p>The start time of this budget period.</p>"""
    end_time: NotRequired["datetime.datetime"]
    """<p>The end time of this budget period. If not specified, the budget period continues indefinitely.</p>"""
    remaining_budget: "capo_cleanroomsml.types.budget.Budget"
    """<p>The amount of budget remaining in this period.</p>"""
    budget: "capo_cleanroomsml.types.budget.Budget"
    """<p>The total budget amount allocated for this period.</p>"""
    budget_type: "capo_cleanroomsml.types.access_budget_type.AccessBudgetType"
    """<p>The type of budget period. Calendar-based types reset automatically at regular intervals, while LIFETIME budgets never reset.</p>"""
    auto_refresh: NotRequired[
        "capo_cleanroomsml.types.auto_refresh_mode.AutoRefreshMode"
    ]
    """<p>Specifies whether this budget automatically refreshes when the current period ends.</p>"""

auto_refresh instance-attribute

auto_refresh: NotRequired[AutoRefreshMode]

Specifies whether this budget automatically refreshes when the current period ends.

budget instance-attribute

budget: Budget

The total budget amount allocated for this period.

budget_type instance-attribute

budget_type: AccessBudgetType

The type of budget period. Calendar-based types reset automatically at regular intervals, while LIFETIME budgets never reset.

end_time instance-attribute

end_time: NotRequired[datetime]

The end time of this budget period. If not specified, the budget period continues indefinitely.

remaining_budget instance-attribute

remaining_budget: Budget

The amount of budget remaining in this period.

start_time instance-attribute

start_time: datetime

The start time of this budget period.