Skip to content

AccessBudgetDetails

Source code in docs_src/capo_cleanrooms/types/access_budget_details.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
class AccessBudgetDetails(TypedDict, closed=True):
    start_time: "datetime.datetime"
    """<p>The start time for the access budget period.</p>"""
    end_time: NotRequired["datetime.datetime"]
    """<p>The end time for the access budget period.</p>"""
    remaining_budget: "capo_cleanrooms.types.remaining_budget.RemainingBudget"
    """<p>The remaining budget amount available for use within this access budget.</p>"""
    budget: "capo_cleanrooms.types.budget.Budget"
    """<p>The total budget allocation amount for this access budget.</p>"""
    budget_type: "capo_cleanrooms.types.access_budget_type.AccessBudgetType"
    """<p>Specifies the time period for limiting table usage in queries and jobs. For calendar-based periods, the budget can renew if auto refresh is enabled. For lifetime budgets, the limit applies to the total usage throughout the collaboration. Valid values are:</p> <p> <code>CALENDAR_DAY</code> - Limit table usage per day.</p> <p> <code>CALENDAR_WEEK</code> - Limit table usage per week.</p> <p> <code>CALENDAR_MONTH</code> - Limit table usage per month.</p> <p> <code>LIFETIME</code> - Limit total table usage for the collaboration duration.</p>"""
    auto_refresh: NotRequired["capo_cleanrooms.types.auto_refresh_mode.AutoRefreshMode"]
    """<p>Indicates whether the budget automatically refreshes for each time period specified in <code>budgetType</code>. Valid values are:</p> <p> <code>ENABLED</code> - The budget refreshes automatically at the start of each period.</p> <p> <code>DISABLED</code> - The budget must be refreshed manually.</p> <p> <code>NULL</code> - The value is null when <code>budgetType</code> is set to <code>LIFETIME</code>.</p>"""

auto_refresh instance-attribute 

auto_refresh: NotRequired[AutoRefreshMode]

Indicates whether the budget automatically refreshes for each time period specified in budgetType. Valid values are:

ENABLED - The budget refreshes automatically at the start of each period.

DISABLED - The budget must be refreshed manually.

NULL - The value is null when budgetType is set to LIFETIME.

budget instance-attribute 

budget: Budget

The total budget allocation amount for this access budget.

budget_type instance-attribute 

budget_type: AccessBudgetType

Specifies the time period for limiting table usage in queries and jobs. For calendar-based periods, the budget can renew if auto refresh is enabled. For lifetime budgets, the limit applies to the total usage throughout the collaboration. Valid values are:

CALENDAR_DAY - Limit table usage per day.

CALENDAR_WEEK - Limit table usage per week.

CALENDAR_MONTH - Limit table usage per month.

LIFETIME - Limit total table usage for the collaboration duration.

end_time instance-attribute 

end_time: NotRequired[datetime]

The end time for the access budget period.

remaining_budget instance-attribute 

remaining_budget: RemainingBudget

The remaining budget amount available for use within this access budget.

start_time instance-attribute 

start_time: datetime

The start time for the access budget period.