AccessBudgetDetails
Detailed information about an access budget including time bounds, budget allocation, and configuration settings.
Contents
- budget
-
The total budget allocation amount for this access budget.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 1000000.
Required: Yes
- budgetType
-
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.Type: String
Valid Values:
CALENDAR_DAY | CALENDAR_MONTH | CALENDAR_WEEK | LIFETIMERequired: Yes
- remainingBudget
-
The remaining budget amount available for use within this access budget.
Type: Integer
Valid Range: Minimum value of 0.
Required: Yes
- startTime
-
The start time for the access budget period.
Type: Timestamp
Required: Yes
- autoRefresh
-
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 whenbudgetTypeis set toLIFETIME.Type: String
Valid Values:
ENABLED | DISABLEDRequired: No
- endTime
-
The end time for the access budget period.
Type: Timestamp
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
