Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,18 @@
# Version changelog

## [Release] Release v0.44.1

### New Features and Improvements

* Introduce new Credential Strategies for Agents ([#882](https://github.com/databricks/databricks-sdk-py/pull/882)).


### Internal Changes

* GetRun logic paginates more arrays ([#867](https://github.com/databricks/databricks-sdk-py/pull/867)).



## [Release] Release v0.44.0

### Internal Changes
Expand Down
2 changes: 1 addition & 1 deletion databricks/sdk/version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = '0.44.0'
__version__ = '0.44.1'
43 changes: 22 additions & 21 deletions docs/account/billing/billable_usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.. py:class:: BillableUsageAPI

This API allows you to download billable usage logs for the specified account and date range. This feature
works with all account types.
works with all account types.

.. py:method:: download(start_month: str, end_month: str [, personal_data: Optional[bool]]) -> DownloadResponse

Expand All @@ -21,23 +21,24 @@ works with all account types.
resp = a.billable_usage.download(start_month="2024-08", end_month="2024-09")

Return billable usage logs.

Returns billable usage logs in CSV format for the specified account and date range. For the data
schema, see [CSV file schema]. Note that this method might take multiple minutes to complete.

**Warning**: Depending on the queried date range, the number of workspaces in the account, the size of
the response and the internet speed of the caller, this API may hit a timeout after a few minutes. If
you experience this, try to mitigate by calling the API with narrower date ranges.

[CSV file schema]: https://docs.databricks.com/administration-guide/account-settings/usage-analysis.html#schema

:param start_month: str
Format: `YYYY-MM`. First month to return billable usage logs for. This field is required.
:param end_month: str
Format: `YYYY-MM`. Last month to return billable usage logs for. This field is required.
:param personal_data: bool (optional)
Specify whether to include personally identifiable information in the billable usage logs, for
example the email addresses of cluster creators. Handle this information with care. Defaults to
false.

:returns: :class:`DownloadResponse`

Returns billable usage logs in CSV format for the specified account and date range. For the data
schema, see [CSV file schema]. Note that this method might take multiple minutes to complete.

**Warning**: Depending on the queried date range, the number of workspaces in the account, the size of
the response and the internet speed of the caller, this API may hit a timeout after a few minutes. If
you experience this, try to mitigate by calling the API with narrower date ranges.

[CSV file schema]: https://docs.databricks.com/administration-guide/account-settings/usage-analysis.html#schema

:param start_month: str
Format: `YYYY-MM`. First month to return billable usage logs for. This field is required.
:param end_month: str
Format: `YYYY-MM`. Last month to return billable usage logs for. This field is required.
:param personal_data: bool (optional)
Specify whether to include personally identifiable information in the billable usage logs, for
example the email addresses of cluster creators. Handle this information with care. Defaults to
false.

:returns: :class:`DownloadResponse`

121 changes: 61 additions & 60 deletions docs/account/billing/budget_policy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,79 +9,80 @@
.. py:method:: create( [, custom_tags: Optional[List[compute.CustomPolicyTag]], policy_name: Optional[str], request_id: Optional[str]]) -> BudgetPolicy

Create a budget policy.

Creates a new policy.

:param custom_tags: List[:class:`CustomPolicyTag`] (optional)
A list of tags defined by the customer. At most 40 entries are allowed per policy.
:param policy_name: str (optional)
The name of the policy. - Must be unique among active policies. - Can contain only characters of
0-9, a-z, A-Z, -, =, ., :, /, @, _, +, whitespace.
:param request_id: str (optional)
A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is
recommended. This request is only idempotent if a `request_id` is provided.

:returns: :class:`BudgetPolicy`

Creates a new policy.
:param custom_tags: List[:class:`CustomPolicyTag`] (optional)
A list of tags defined by the customer. At most 40 entries are allowed per policy.
:param policy_name: str (optional)
The name of the policy. - Must be unique among active policies. - Can contain only characters of
0-9, a-z, A-Z, -, =, ., :, /, @, _, +, whitespace.
:param request_id: str (optional)
A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is
recommended. This request is only idempotent if a `request_id` is provided.
:returns: :class:`BudgetPolicy`

.. py:method:: delete(policy_id: str)

Delete a budget policy.

Deletes a policy

:param policy_id: str
The Id of the policy.



Deletes a policy
:param policy_id: str
The Id of the policy.

.. py:method:: get(policy_id: str) -> BudgetPolicy

Get a budget policy.

Retrieves a policy by it's ID.

:param policy_id: str
The Id of the policy.

:returns: :class:`BudgetPolicy`

Retrieves a policy by it's ID.
:param policy_id: str
The Id of the policy.
:returns: :class:`BudgetPolicy`

.. py:method:: list( [, filter_by: Optional[Filter], page_size: Optional[int], page_token: Optional[str], sort_spec: Optional[SortSpec]]) -> Iterator[BudgetPolicy]

List policies.

Lists all policies. Policies are returned in the alphabetically ascending order of their names.

:param filter_by: :class:`Filter` (optional)
A filter to apply to the list of policies.
:param page_size: int (optional)
The maximum number of budget policies to return. If unspecified, at most 100 budget policies will be
returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
:param page_token: str (optional)
A page token, received from a previous `ListServerlessPolicies` call. Provide this to retrieve the
subsequent page. If unspecified, the first page will be returned.

When paginating, all other parameters provided to `ListServerlessPoliciesRequest` must match the
call that provided the page token.
:param sort_spec: :class:`SortSpec` (optional)
The sort specification.

:returns: Iterator over :class:`BudgetPolicy`

Lists all policies. Policies are returned in the alphabetically ascending order of their names.
:param filter_by: :class:`Filter` (optional)
A filter to apply to the list of policies.
:param page_size: int (optional)
The maximum number of budget policies to return. If unspecified, at most 100 budget policies will be
returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
:param page_token: str (optional)
A page token, received from a previous `ListServerlessPolicies` call. Provide this to retrieve the
subsequent page. If unspecified, the first page will be returned.
When paginating, all other parameters provided to `ListServerlessPoliciesRequest` must match the
call that provided the page token.
:param sort_spec: :class:`SortSpec` (optional)
The sort specification.
:returns: Iterator over :class:`BudgetPolicy`

.. py:method:: update(policy_id: str [, limit_config: Optional[LimitConfig], policy: Optional[BudgetPolicy]]) -> BudgetPolicy

Update a budget policy.

Updates a policy

:param policy_id: str
The Id of the policy. This field is generated by Databricks and globally unique.
:param limit_config: :class:`LimitConfig` (optional)
DEPRECATED. This is redundant field as LimitConfig is part of the BudgetPolicy
:param policy: :class:`BudgetPolicy` (optional)
Contains the BudgetPolicy details.

:returns: :class:`BudgetPolicy`

Updates a policy

:param policy_id: str
The Id of the policy. This field is generated by Databricks and globally unique.
:param limit_config: :class:`LimitConfig` (optional)
DEPRECATED. This is redundant field as LimitConfig is part of the BudgetPolicy
:param policy: :class:`BudgetPolicy` (optional)
Contains the BudgetPolicy details.

:returns: :class:`BudgetPolicy`

95 changes: 48 additions & 47 deletions docs/account/billing/budgets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
.. py:class:: BudgetsAPI

These APIs manage budget configurations for this account. Budgets enable you to monitor usage across your
account. You can set up budgets to either track account-wide spending, or apply filters to track the
spending of specific teams, projects, or workspaces.
account. You can set up budgets to either track account-wide spending, or apply filters to track the
spending of specific teams, projects, or workspaces.

.. py:method:: create(budget: CreateBudgetConfigurationBudget) -> CreateBudgetConfigurationResponse

Expand Down Expand Up @@ -47,28 +47,28 @@ spending of specific teams, projects, or workspaces.
a.budgets.delete(budget_id=created.budget.budget_configuration_id)

Create new budget.

Create a new budget configuration for an account. For full details, see
https://docs.databricks.com/en/admin/account-settings/budgets.html.

:param budget: :class:`CreateBudgetConfigurationBudget`
Properties of the new budget configuration.

:returns: :class:`CreateBudgetConfigurationResponse`

Create a new budget configuration for an account. For full details, see
https://docs.databricks.com/en/admin/account-settings/budgets.html.
:param budget: :class:`CreateBudgetConfigurationBudget`
Properties of the new budget configuration.
:returns: :class:`CreateBudgetConfigurationResponse`

.. py:method:: delete(budget_id: str)

Delete budget.

Deletes a budget configuration for an account. Both account and budget configuration are specified by
ID. This cannot be undone.

:param budget_id: str
The Databricks budget configuration ID.



Deletes a budget configuration for an account. Both account and budget configuration are specified by
ID. This cannot be undone.
:param budget_id: str
The Databricks budget configuration ID.

.. py:method:: get(budget_id: str) -> GetBudgetConfigurationResponse

Expand Down Expand Up @@ -111,14 +111,14 @@ ID. This cannot be undone.
a.budgets.delete(budget_id=created.budget.budget_configuration_id)

Get budget.

Gets a budget configuration for an account. Both account and budget configuration are specified by ID.

:param budget_id: str
The budget configuration ID

:returns: :class:`GetBudgetConfigurationResponse`

Gets a budget configuration for an account. Both account and budget configuration are specified by ID.
:param budget_id: str
The budget configuration ID
:returns: :class:`GetBudgetConfigurationResponse`

.. py:method:: list( [, page_token: Optional[str]]) -> Iterator[BudgetConfiguration]

Expand All @@ -135,15 +135,15 @@ Gets a budget configuration for an account. Both account and budget configuratio
all = a.budgets.list(billing.ListBudgetConfigurationsRequest())

Get all budgets.

Gets all budgets associated with this account.

:param page_token: str (optional)
A page token received from a previous get all budget configurations call. This token can be used to
retrieve the subsequent page. Requests first page if absent.

:returns: Iterator over :class:`BudgetConfiguration`

Gets all budgets associated with this account.
:param page_token: str (optional)
A page token received from a previous get all budget configurations call. This token can be used to
retrieve the subsequent page. Requests first page if absent.
:returns: Iterator over :class:`BudgetConfiguration`

.. py:method:: update(budget_id: str, budget: UpdateBudgetConfigurationBudget) -> UpdateBudgetConfigurationResponse

Expand Down Expand Up @@ -205,13 +205,14 @@ Gets all budgets associated with this account.
a.budgets.delete(budget_id=created.budget.budget_configuration_id)

Modify budget.

Updates a budget configuration for an account. Both account and budget configuration are specified by
ID.

:param budget_id: str
The Databricks budget configuration ID.
:param budget: :class:`UpdateBudgetConfigurationBudget`
The updated budget. This will overwrite the budget specified by the budget ID.

:returns: :class:`UpdateBudgetConfigurationResponse`

Updates a budget configuration for an account. Both account and budget configuration are specified by
ID.

:param budget_id: str
The Databricks budget configuration ID.
:param budget: :class:`UpdateBudgetConfigurationBudget`
The updated budget. This will overwrite the budget specified by the budget ID.

:returns: :class:`UpdateBudgetConfigurationResponse`

Loading
Loading