databricks-sdk 0.56.0__py3-none-any.whl → 0.58.0__py3-none-any.whl

databricks/sdk/service/billing.py

@@ -863,24 +863,6 @@ class DeleteBudgetConfigurationResponse:
         return cls()
 
 
-@dataclass
-class DeleteResponse:
-    def as_dict(self) -> dict:
-        """Serializes the DeleteResponse into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the DeleteResponse into a shallow dictionary of its immediate attributes."""
-        body = {}
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> DeleteResponse:
-        """Deserializes the DeleteResponse from a dictionary."""
-        return cls()
-
-
 class DeliveryStatus(Enum):
     """* The status string for log delivery. Possible values are: `CREATED`: There were no log delivery
     attempts since the config was created. `SUCCEEDED`: The latest attempt of log delivery has
@@ -1626,7 +1608,6 @@ class WrappedCreateLogDeliveryConfiguration:
     """* Properties of the new log delivery configuration."""
 
     log_delivery_configuration: CreateLogDeliveryConfigurationParams
-    """* Log Delivery Configuration"""
 
     def as_dict(self) -> dict:
         """Serializes the WrappedCreateLogDeliveryConfiguration into a dictionary suitable for use as a JSON request body."""
@@ -1719,9 +1700,7 @@ class BillableUsageAPI:
         self._api = api_client
 
     def download(self, start_month: str, end_month: str, *, personal_data: Optional[bool] = None) -> DownloadResponse:
-        """Return billable usage logs.
-
-        Returns billable usage logs in CSV format for the specified account and date range. For the data
+        """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
@@ -1766,9 +1745,7 @@ class BudgetPolicyAPI:
         self._api = api_client
 
     def create(self, *, policy: Optional[BudgetPolicy] = None, request_id: Optional[str] = None) -> BudgetPolicy:
-        """Create a budget policy.
-
-        Creates a new policy.
+        """Creates a new policy.
 
         :param policy: :class:`BudgetPolicy` (optional)
           The policy to create. `policy_id` needs to be empty as it will be generated `policy_name` must be
@@ -1796,9 +1773,7 @@ class BudgetPolicyAPI:
         return BudgetPolicy.from_dict(res)
 
     def delete(self, policy_id: str):
-        """Delete a budget policy.
-
-        Deletes a policy
+        """Deletes a policy
 
         :param policy_id: str
           The Id of the policy.
@@ -1813,9 +1788,7 @@ class BudgetPolicyAPI:
         self._api.do("DELETE", f"/api/2.1/accounts/{self._api.account_id}/budget-policies/{policy_id}", headers=headers)
 
     def get(self, policy_id: str) -> BudgetPolicy:
-        """Get a budget policy.
-
-        Retrieves a policy by it's ID.
+        """Retrieves a policy by it's ID.
 
         :param policy_id: str
           The Id of the policy.
@@ -1840,9 +1813,7 @@ class BudgetPolicyAPI:
         page_token: Optional[str] = None,
         sort_spec: Optional[SortSpec] = None,
     ) -> Iterator[BudgetPolicy]:
-        """List policies.
-
-        Lists all policies. Policies are returned in the alphabetically ascending order of their names.
+        """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.
@@ -1888,14 +1859,13 @@ class BudgetPolicyAPI:
     def update(
         self, policy_id: str, policy: BudgetPolicy, *, limit_config: Optional[LimitConfig] = None
     ) -> BudgetPolicy:
-        """Update a budget policy.
-
-        Updates a policy
+        """Updates a policy
 
         :param policy_id: str
           The Id of the policy. This field is generated by Databricks and globally unique.
         :param policy: :class:`BudgetPolicy`
-          Contains the BudgetPolicy details.
+          The policy to update. `creator_user_id` cannot be specified in the request. All other fields must be
+          specified even if not changed. The `policy_id` is used to identify the policy to update.
         :param limit_config: :class:`LimitConfig` (optional)
           DEPRECATED. This is redundant field as LimitConfig is part of the BudgetPolicy
 
@@ -1929,9 +1899,7 @@ class BudgetsAPI:
         self._api = api_client
 
     def create(self, budget: CreateBudgetConfigurationBudget) -> CreateBudgetConfigurationResponse:
-        """Create new budget.
-
-        Create a new budget configuration for an account. For full details, see
+        """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`
@@ -1951,9 +1919,7 @@ class BudgetsAPI:
         return CreateBudgetConfigurationResponse.from_dict(res)
 
     def delete(self, budget_id: str):
-        """Delete budget.
-
-        Deletes a budget configuration for an account. Both account and budget configuration are specified by
+        """Deletes a budget configuration for an account. Both account and budget configuration are specified by
         ID. This cannot be undone.
 
         :param budget_id: str
@@ -1969,9 +1935,7 @@ class BudgetsAPI:
         self._api.do("DELETE", f"/api/2.1/accounts/{self._api.account_id}/budgets/{budget_id}", headers=headers)
 
     def get(self, budget_id: str) -> GetBudgetConfigurationResponse:
-        """Get budget.
-
-        Gets a budget configuration for an account. Both account and budget configuration are specified by ID.
+        """Gets a budget configuration for an account. Both account and budget configuration are specified by ID.
 
         :param budget_id: str
           The budget configuration ID
@@ -1987,9 +1951,7 @@ class BudgetsAPI:
         return GetBudgetConfigurationResponse.from_dict(res)
 
     def list(self, *, page_token: Optional[str] = None) -> Iterator[BudgetConfiguration]:
-        """Get all budgets.
-
-        Gets all budgets associated with this account.
+        """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
@@ -2017,9 +1979,7 @@ class BudgetsAPI:
             query["page_token"] = json["next_page_token"]
 
     def update(self, budget_id: str, budget: UpdateBudgetConfigurationBudget) -> UpdateBudgetConfigurationResponse:
-        """Modify budget.
-
-        Updates a budget configuration for an account. Both account and budget configuration are specified by
+        """Updates a budget configuration for an account. Both account and budget configuration are specified by
         ID.
 
         :param budget_id: str
@@ -2044,8 +2004,57 @@ class BudgetsAPI:
 
 
 class LogDeliveryAPI:
-    """These APIs manage Log delivery configurations for this account. Log delivery configs enable you to
-    configure the delivery of the specified type of logs to your storage account."""
+    """These APIs manage log delivery configurations for this account. The two supported log types for this API
+    are _billable usage logs_ and _audit logs_. This feature is in Public Preview. This feature works with all
+    account ID types.
+
+    Log delivery works with all account types. However, if your account is on the E2 version of the platform
+    or on a select custom plan that allows multiple workspaces per account, you can optionally configure
+    different storage destinations for each workspace. Log delivery status is also provided to know the latest
+    status of log delivery attempts.
+
+    The high-level flow of billable usage delivery:
+
+    1. **Create storage**: In AWS, [create a new AWS S3 bucket] with a specific bucket policy. Using
+    Databricks APIs, call the Account API to create a [storage configuration object](:method:Storage/Create)
+    that uses the bucket name.
+
+    2. **Create credentials**: In AWS, create the appropriate AWS IAM role. For full details, including the
+    required IAM role policies and trust relationship, see [Billable usage log delivery]. Using Databricks
+    APIs, call the Account API to create a [credential configuration object](:method:Credentials/Create) that
+    uses the IAM role's ARN.
+
+    3. **Create log delivery configuration**: Using Databricks APIs, call the Account API to [create a log
+    delivery configuration](:method:LogDelivery/Create) that uses the credential and storage configuration
+    objects from previous steps. You can specify if the logs should include all events of that log type in
+    your account (_Account level_ delivery) or only events for a specific set of workspaces (_workspace level_
+    delivery). Account level log delivery applies to all current and future workspaces plus account level
+    logs, while workspace level log delivery solely delivers logs related to the specified workspaces. You can
+    create multiple types of delivery configurations per account.
+
+    For billable usage delivery: * For more information about billable usage logs, see [Billable usage log
+    delivery]. For the CSV schema, see the [Usage page]. * The delivery location is
+    `<bucket-name>/<prefix>/billable-usage/csv/`, where `<prefix>` is the name of the optional delivery path
+    prefix you set up during log delivery configuration. Files are named
+    `workspaceId=<workspace-id>-usageMonth=<month>.csv`. * All billable usage logs apply to specific
+    workspaces (_workspace level_ logs). You can aggregate usage for your entire account by creating an
+    _account level_ delivery configuration that delivers logs for all current and future workspaces in your
+    account. * The files are delivered daily by overwriting the month's CSV file for each workspace.
+
+    For audit log delivery: * For more information about about audit log delivery, see [Audit log delivery],
+    which includes information about the used JSON schema. * The delivery location is
+    `<bucket-name>/<delivery-path-prefix>/workspaceId=<workspaceId>/date=<yyyy-mm-dd>/auditlogs_<internal-id>.json`.
+    Files may get overwritten with the same content multiple times to achieve exactly-once delivery. * If the
+    audit log delivery configuration included specific workspace IDs, only _workspace-level_ audit logs for
+    those workspaces are delivered. If the log delivery configuration applies to the entire account (_account
+    level_ delivery configuration), the audit log delivery includes workspace-level audit logs for all
+    workspaces in the account as well as account-level audit logs. See [Audit log delivery] for details. *
+    Auditable events are typically available in logs within 15 minutes.
+
+    [Audit log delivery]: https://docs.databricks.com/administration-guide/account-settings/audit-logs.html
+    [Billable usage log delivery]: https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html
+    [Usage page]: https://docs.databricks.com/administration-guide/account-settings/usage.html
+    [create a new AWS S3 bucket]: https://docs.databricks.com/administration-guide/account-api/aws-storage.html"""
 
     def __init__(self, api_client):
         self._api = api_client
@@ -2053,9 +2062,7 @@ class LogDeliveryAPI:
     def create(
         self, log_delivery_configuration: CreateLogDeliveryConfigurationParams
     ) -> WrappedLogDeliveryConfiguration:
-        """Create a new log delivery configuration.
-
-        Creates a new Databricks log delivery configuration to enable delivery of the specified type of logs
+        """Creates a new Databricks log delivery configuration to enable delivery of the specified type of logs
         to your storage location. This requires that you already created a [credential
         object](:method:Credentials/Create) (which encapsulates a cross-account service IAM role) and a
         [storage configuration object](:method:Storage/Create) (which encapsulates an S3 bucket).
@@ -2077,7 +2084,6 @@ class LogDeliveryAPI:
         [Deliver and access billable usage logs]: https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html
 
         :param log_delivery_configuration: :class:`CreateLogDeliveryConfigurationParams`
-          * Log Delivery Configuration
 
         :returns: :class:`WrappedLogDeliveryConfiguration`
         """
@@ -2093,9 +2099,7 @@ class LogDeliveryAPI:
         return WrappedLogDeliveryConfiguration.from_dict(res)
 
     def get(self, log_delivery_configuration_id: str) -> GetLogDeliveryConfigurationResponse:
-        """Get log delivery configuration.
-
-        Gets a Databricks log delivery configuration object for an account, both specified by ID.
+        """Gets a Databricks log delivery configuration object for an account, both specified by ID.
 
         :param log_delivery_configuration_id: str
           The log delivery configuration id of customer
@@ -2122,9 +2126,7 @@ class LogDeliveryAPI:
         status: Optional[LogDeliveryConfigStatus] = None,
         storage_configuration_id: Optional[str] = None,
     ) -> Iterator[LogDeliveryConfiguration]:
-        """Get all log delivery configurations.
-
-        Gets all Databricks log delivery configurations associated with an account specified by ID.
+        """Gets all Databricks log delivery configurations associated with an account specified by ID.
 
         :param credentials_id: str (optional)
           The Credentials id to filter the search results with
@@ -2164,9 +2166,7 @@ class LogDeliveryAPI:
             query["page_token"] = json["next_page_token"]
 
     def patch_status(self, log_delivery_configuration_id: str, status: LogDeliveryConfigStatus):
-        """Enable or disable log delivery configuration.
-
-        Enables or disables a log delivery configuration. Deletion of delivery configurations is not
+        """Enables or disables a log delivery configuration. Deletion of delivery configurations is not
         supported, so disable log delivery configurations that are no longer needed. Note that you can't
         re-enable a delivery configuration if this would violate the delivery configuration limits described
         under [Create log delivery](:method:LogDelivery/Create).
@@ -2208,9 +2208,7 @@ class UsageDashboardsAPI:
     def create(
         self, *, dashboard_type: Optional[UsageDashboardType] = None, workspace_id: Optional[int] = None
     ) -> CreateBillingUsageDashboardResponse:
-        """Create new usage dashboard.
-
-        Create a usage dashboard specified by workspaceId, accountId, and dashboard type.
+        """Create a usage dashboard specified by workspaceId, accountId, and dashboard type.
 
         :param dashboard_type: :class:`UsageDashboardType` (optional)
           Workspace level usage dashboard shows usage data for the specified workspace ID. Global level usage
@@ -2236,9 +2234,7 @@ class UsageDashboardsAPI:
     def get(
         self, *, dashboard_type: Optional[UsageDashboardType] = None, workspace_id: Optional[int] = None
     ) -> GetBillingUsageDashboardResponse:
-        """Get usage dashboard.
-
-        Get a usage dashboard specified by workspaceId, accountId, and dashboard type.
+        """Get a usage dashboard specified by workspaceId, accountId, and dashboard type.
 
         :param dashboard_type: :class:`UsageDashboardType` (optional)
           Workspace level usage dashboard shows usage data for the specified workspace ID. Global level usage