databricks-sdk 0.57.0__py3-none-any.whl → 0.59.0__py3-none-any.whl

databricks/sdk/service/billing.py

@@ -416,41 +416,6 @@ class BudgetPolicy:
         )
 
 
-@dataclass
-class CreateBillingUsageDashboardRequest:
-    dashboard_type: Optional[UsageDashboardType] = None
-    """Workspace level usage dashboard shows usage data for the specified workspace ID. Global level
-    usage dashboard shows usage data for all workspaces in the account."""
-
-    workspace_id: Optional[int] = None
-    """The workspace ID of the workspace in which the usage dashboard is created."""
-
-    def as_dict(self) -> dict:
-        """Serializes the CreateBillingUsageDashboardRequest into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.dashboard_type is not None:
-            body["dashboard_type"] = self.dashboard_type.value
-        if self.workspace_id is not None:
-            body["workspace_id"] = self.workspace_id
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the CreateBillingUsageDashboardRequest into a shallow dictionary of its immediate attributes."""
-        body = {}
-        if self.dashboard_type is not None:
-            body["dashboard_type"] = self.dashboard_type
-        if self.workspace_id is not None:
-            body["workspace_id"] = self.workspace_id
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> CreateBillingUsageDashboardRequest:
-        """Deserializes the CreateBillingUsageDashboardRequest from a dictionary."""
-        return cls(
-            dashboard_type=_enum(d, "dashboard_type", UsageDashboardType), workspace_id=d.get("workspace_id", None)
-        )
-
-
 @dataclass
 class CreateBillingUsageDashboardResponse:
     dashboard_id: Optional[str] = None
@@ -628,31 +593,6 @@ class CreateBudgetConfigurationBudgetAlertConfigurations:
         )
 
 
-@dataclass
-class CreateBudgetConfigurationRequest:
-    budget: CreateBudgetConfigurationBudget
-    """Properties of the new budget configuration."""
-
-    def as_dict(self) -> dict:
-        """Serializes the CreateBudgetConfigurationRequest into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.budget:
-            body["budget"] = self.budget.as_dict()
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the CreateBudgetConfigurationRequest into a shallow dictionary of its immediate attributes."""
-        body = {}
-        if self.budget:
-            body["budget"] = self.budget
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> CreateBudgetConfigurationRequest:
-        """Deserializes the CreateBudgetConfigurationRequest from a dictionary."""
-        return cls(budget=_from_dict(d, "budget", CreateBudgetConfigurationBudget))
-
-
 @dataclass
 class CreateBudgetConfigurationResponse:
     budget: Optional[BudgetConfiguration] = None
@@ -678,43 +618,6 @@ class CreateBudgetConfigurationResponse:
         return cls(budget=_from_dict(d, "budget", BudgetConfiguration))
 
 
-@dataclass
-class CreateBudgetPolicyRequest:
-    """A request to create a BudgetPolicy."""
-
-    policy: Optional[BudgetPolicy] = None
-    """The policy to create. `policy_id` needs to be empty as it will be generated `policy_name` must
-    be provided, custom_tags may need to be provided depending on the cloud provider. All other
-    fields are optional."""
-
-    request_id: Optional[str] = None
-    """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."""
-
-    def as_dict(self) -> dict:
-        """Serializes the CreateBudgetPolicyRequest into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.policy:
-            body["policy"] = self.policy.as_dict()
-        if self.request_id is not None:
-            body["request_id"] = self.request_id
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the CreateBudgetPolicyRequest into a shallow dictionary of its immediate attributes."""
-        body = {}
-        if self.policy:
-            body["policy"] = self.policy
-        if self.request_id is not None:
-            body["request_id"] = self.request_id
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> CreateBudgetPolicyRequest:
-        """Deserializes the CreateBudgetPolicyRequest from a dictionary."""
-        return cls(policy=_from_dict(d, "policy", BudgetPolicy), request_id=d.get("request_id", None))
-
-
 @dataclass
 class CreateLogDeliveryConfigurationParams:
     """* Log Delivery Configuration"""
@@ -863,24 +766,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
@@ -1518,38 +1403,6 @@ class UpdateBudgetConfigurationBudget:
         )
 
 
-@dataclass
-class UpdateBudgetConfigurationRequest:
-    budget: UpdateBudgetConfigurationBudget
-    """The updated budget. This will overwrite the budget specified by the budget ID."""
-
-    budget_id: Optional[str] = None
-    """The Databricks budget configuration ID."""
-
-    def as_dict(self) -> dict:
-        """Serializes the UpdateBudgetConfigurationRequest into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.budget:
-            body["budget"] = self.budget.as_dict()
-        if self.budget_id is not None:
-            body["budget_id"] = self.budget_id
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the UpdateBudgetConfigurationRequest into a shallow dictionary of its immediate attributes."""
-        body = {}
-        if self.budget:
-            body["budget"] = self.budget
-        if self.budget_id is not None:
-            body["budget_id"] = self.budget_id
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> UpdateBudgetConfigurationRequest:
-        """Deserializes the UpdateBudgetConfigurationRequest from a dictionary."""
-        return cls(budget=_from_dict(d, "budget", UpdateBudgetConfigurationBudget), budget_id=d.get("budget_id", None))
-
-
 @dataclass
 class UpdateBudgetConfigurationResponse:
     budget: Optional[BudgetConfiguration] = None
@@ -1575,81 +1428,12 @@ class UpdateBudgetConfigurationResponse:
         return cls(budget=_from_dict(d, "budget", BudgetConfiguration))
 
 
-@dataclass
-class UpdateLogDeliveryConfigurationStatusRequest:
-    """* Update Log Delivery Configuration"""
-
-    status: LogDeliveryConfigStatus
-    """Status of log delivery configuration. Set to `ENABLED` (enabled) or `DISABLED` (disabled).
-    Defaults to `ENABLED`. You can [enable or disable the
-    configuration](#operation/patch-log-delivery-config-status) later. Deletion of a configuration
-    is not supported, so disable a log delivery configuration that is no longer needed."""
-
-    log_delivery_configuration_id: Optional[str] = None
-    """The log delivery configuration id of customer"""
-
-    def as_dict(self) -> dict:
-        """Serializes the UpdateLogDeliveryConfigurationStatusRequest into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.log_delivery_configuration_id is not None:
-            body["log_delivery_configuration_id"] = self.log_delivery_configuration_id
-        if self.status is not None:
-            body["status"] = self.status.value
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the UpdateLogDeliveryConfigurationStatusRequest into a shallow dictionary of its immediate attributes."""
-        body = {}
-        if self.log_delivery_configuration_id is not None:
-            body["log_delivery_configuration_id"] = self.log_delivery_configuration_id
-        if self.status is not None:
-            body["status"] = self.status
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> UpdateLogDeliveryConfigurationStatusRequest:
-        """Deserializes the UpdateLogDeliveryConfigurationStatusRequest from a dictionary."""
-        return cls(
-            log_delivery_configuration_id=d.get("log_delivery_configuration_id", None),
-            status=_enum(d, "status", LogDeliveryConfigStatus),
-        )
-
-
 class UsageDashboardType(Enum):
 
     USAGE_DASHBOARD_TYPE_GLOBAL = "USAGE_DASHBOARD_TYPE_GLOBAL"
     USAGE_DASHBOARD_TYPE_WORKSPACE = "USAGE_DASHBOARD_TYPE_WORKSPACE"
 
 
-@dataclass
-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."""
-        body = {}
-        if self.log_delivery_configuration:
-            body["log_delivery_configuration"] = self.log_delivery_configuration.as_dict()
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the WrappedCreateLogDeliveryConfiguration into a shallow dictionary of its immediate attributes."""
-        body = {}
-        if self.log_delivery_configuration:
-            body["log_delivery_configuration"] = self.log_delivery_configuration
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> WrappedCreateLogDeliveryConfiguration:
-        """Deserializes the WrappedCreateLogDeliveryConfiguration from a dictionary."""
-        return cls(
-            log_delivery_configuration=_from_dict(d, "log_delivery_configuration", CreateLogDeliveryConfigurationParams)
-        )
-
-
 @dataclass
 class WrappedLogDeliveryConfiguration:
     log_delivery_configuration: Optional[LogDeliveryConfiguration] = None
@@ -1720,16 +1504,22 @@ class BillableUsageAPI:
 
     def download(self, start_month: str, end_month: str, *, personal_data: Optional[bool] = None) -> 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.
+        schema, see:
+
+        - AWS: [CSV file schema]. - GCP: [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
+        [CSV file schema]: https://docs.gcp.databricks.com/administration-guide/account-settings/usage-analysis.html#csv-file-schema
 
         :param start_month: str
-          Format: `YYYY-MM`. First month to return billable usage logs for. This field is required.
+          Format specification for month in the format `YYYY-MM`. This is used to specify billable usage
+          `start_month` and `end_month` properties. **Note**: Billable usage logs are unavailable before March
+          2019 (`2019-03`).
         :param end_month: str
           Format: `YYYY-MM`. Last month to return billable usage logs for. This field is required.
         :param personal_data: bool (optional)
@@ -1883,7 +1673,8 @@ class BudgetPolicyAPI:
         :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
 
@@ -2022,8 +1813,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,7 +1893,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`
         """