databricks-sdk 0.68.0__py3-none-any.whl → 0.70.0__py3-none-any.whl

databricks/sdk/service/dataquality.py

@@ -163,7 +163,7 @@ class DataProfilingConfig:
     """The warehouse for dashboard creation"""
 
     inference_log: Optional[InferenceLogConfig] = None
-    """Configuration for monitoring inference log tables."""
+    """`Analysis Configuration` for monitoring inference log tables."""
 
     latest_monitor_failure_message: Optional[str] = None
     """The latest error message for a monitor failure."""
@@ -196,13 +196,13 @@ class DataProfilingConfig:
     high-cardinality columns, only the top 100 unique values by frequency will generate slices."""
 
     snapshot: Optional[SnapshotConfig] = None
-    """Configuration for monitoring snapshot tables."""
+    """`Analysis Configuration` for monitoring snapshot tables."""
 
     status: Optional[DataProfilingStatus] = None
     """The data profiling monitor status."""
 
     time_series: Optional[TimeSeriesConfig] = None
-    """Configuration for monitoring time series tables."""
+    """`Analysis Configuration` for monitoring time series tables."""
 
     warehouse_id: Optional[str] = None
     """Optional argument to specify the warehouse for dashboard creation. If not specified, the first
@@ -556,13 +556,24 @@ class Monitor:
     """The type of the monitored object. Can be one of the following: `schema` or `table`."""
 
     object_id: str
-    """The UUID of the request object. For example, schema id."""
+    """The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.
+    
+    Find the `schema_id` from either: 1. The [schema_id] of the `Schemas` resource. 2. In [Catalog
+    Explorer] > select the `schema` > go to the `Details` tab > the `Schema ID` field.
+    
+    Find the `table_id` from either: 1. The [table_id] of the `Tables` resource. 2. In [Catalog
+    Explorer] > select the `table` > go to the `Details` tab > the `Table ID` field.
+    
+    [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/
+    [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id
+    [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id"""
 
     anomaly_detection_config: Optional[AnomalyDetectionConfig] = None
     """Anomaly Detection Configuration, applicable to `schema` object types."""
 
     data_profiling_config: Optional[DataProfilingConfig] = None
-    """Data Profiling Configuration, applicable to `table` object types"""
+    """Data Profiling Configuration, applicable to `table` object types. Exactly one `Analysis
+    Configuration` must be present."""
 
     def as_dict(self) -> dict:
         """Serializes the Monitor into a dictionary suitable for use as a JSON request body."""
@@ -664,7 +675,17 @@ class Refresh:
     """The type of the monitored object. Can be one of the following: `schema`or `table`."""
 
     object_id: str
-    """The UUID of the request object. For example, table id."""
+    """The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.
+    
+    Find the `schema_id` from either: 1. The [schema_id] of the `Schemas` resource. 2. In [Catalog
+    Explorer] > select the `schema` > go to the `Details` tab > the `Schema ID` field.
+    
+    Find the `table_id` from either: 1. The [table_id] of the `Tables` resource. 2. In [Catalog
+    Explorer] > select the `table` > go to the `Details` tab > the `Table ID` field.
+    
+    [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/
+    [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id
+    [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id"""
 
     end_time_ms: Optional[int] = None
     """Time when the refresh ended (milliseconds since 1/1/1970 UTC)."""
@@ -826,12 +847,28 @@ class DataQualityAPI:
         self._api = api_client
 
     def cancel_refresh(self, object_type: str, object_id: str, refresh_id: int) -> CancelRefreshResponse:
-        """Cancels a data quality monitor refresh. Currently only supported for the `table` `object_type`.
+        """Cancels a data quality monitor refresh. Currently only supported for the `table` `object_type`. The
+        call must be made in the same workspace as where the monitor was created.
+
+        The caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on
+        the table's parent catalog. 2. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and
+        **USE_SCHEMA** on the table's parent schema. 3. **USE_CATALOG** on the table's parent catalog,
+        **USE_SCHEMA** on the table's parent schema, and **MANAGE** on the table.
 
         :param object_type: str
           The type of the monitored object. Can be one of the following: `schema` or `table`.
         :param object_id: str
-          The UUID of the request object. For example, schema id.
+          The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.
+
+          Find the `schema_id` from either: 1. The [schema_id] of the `Schemas` resource. 2. In [Catalog
+          Explorer] > select the `schema` > go to the `Details` tab > the `Schema ID` field.
+
+          Find the `table_id` from either: 1. The [table_id] of the `Tables` resource. 2. In [Catalog
+          Explorer] > select the `table` > go to the `Details` tab > the `Table ID` field.
+
+          [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/
+          [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id
+          [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id
         :param refresh_id: int
           Unique id of the refresh operation.
 
@@ -854,14 +891,19 @@ class DataQualityAPI:
         """Create a data quality monitor on a Unity Catalog object. The caller must provide either
         `anomaly_detection_config` for a schema monitor or `data_profiling_config` for a table monitor.
 
-        For the `table` `object_type`, the caller must either: 1. be an owner of the table's parent catalog,
-        have **USE_SCHEMA** on the table's parent schema, and have **SELECT** access on the table 2. have
-        **USE_CATALOG** on the table's parent catalog, be an owner of the table's parent schema, and have
-        **SELECT** access on the table. 3. have the following permissions: - **USE_CATALOG** on the table's
-        parent catalog - **USE_SCHEMA** on the table's parent schema - be an owner of the table.
+        For the `table` `object_type`, the caller must have either of the following sets of permissions: 1.
+        **MANAGE** and **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's parent
+        schema, and **SELECT** on the table 2. **USE_CATALOG** on the table's parent catalog, **MANAGE** and
+        **USE_SCHEMA** on the table's parent schema, and **SELECT** on the table. 3. **USE_CATALOG** on the
+        table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **MANAGE** and **SELECT** on
+        the table.
 
         Workspace assets, such as the dashboard, will be created in the workspace where this call was made.
 
+        For the `schema` `object_type`, the caller must have either of the following sets of permissions: 1.
+        **MANAGE** and **USE_CATALOG** on the schema's parent catalog. 2. **USE_CATALOG** on the schema's
+        parent catalog, and **MANAGE** and **USE_SCHEMA** on the schema.
+
         :param monitor: :class:`Monitor`
           The monitor to create.
 
@@ -877,17 +919,28 @@ class DataQualityAPI:
         return Monitor.from_dict(res)
 
     def create_refresh(self, object_type: str, object_id: str, refresh: Refresh) -> Refresh:
-        """Creates a refresh. Currently only supported for the `table` `object_type`.
+        """Creates a refresh. Currently only supported for the `table` `object_type`. The call must be made in
+        the same workspace as where the monitor was created.
 
-        The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG** on the
-        table's parent catalog and be an owner of the table's parent schema 3. have the following permissions:
-        - **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on the table's parent schema - be an
-        owner of the table
+        The caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on
+        the table's parent catalog. 2. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and
+        **USE_SCHEMA** on the table's parent schema. 3. **USE_CATALOG** on the table's parent catalog,
+        **USE_SCHEMA** on the table's parent schema, and **MANAGE** on the table.
 
         :param object_type: str
           The type of the monitored object. Can be one of the following: `schema`or `table`.
         :param object_id: str
-          The UUID of the request object. For example, table id.
+          The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.
+
+          Find the `schema_id` from either: 1. The [schema_id] of the `Schemas` resource. 2. In [Catalog
+          Explorer] > select the `schema` > go to the `Details` tab > the `Schema ID` field.
+
+          Find the `table_id` from either: 1. The [table_id] of the `Tables` resource. 2. In [Catalog
+          Explorer] > select the `table` > go to the `Details` tab > the `Table ID` field.
+
+          [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/
+          [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id
+          [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id
         :param refresh: :class:`Refresh`
           The refresh to create
 
@@ -907,18 +960,32 @@ class DataQualityAPI:
     def delete_monitor(self, object_type: str, object_id: str):
         """Delete a data quality monitor on Unity Catalog object.
 
-        For the `table` `object_type`, the caller must either: 1. be an owner of the table's parent catalog 2.
-        have **USE_CATALOG** on the table's parent catalog and be an owner of the table's parent schema 3.
-        have the following permissions: - **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on
-        the table's parent schema - be an owner of the table.
+        For the `table` `object_type`, the caller must have either of the following sets of permissions:
+        **MANAGE** and **USE_CATALOG** on the table's parent catalog. **USE_CATALOG** on the table's parent
+        catalog, and **MANAGE** and **USE_SCHEMA** on the table's parent schema. **USE_CATALOG** on the
+        table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **MANAGE** on the table.
 
         Note that the metric tables and dashboard will not be deleted as part of this call; those assets must
         be manually cleaned up (if desired).
 
+        For the `schema` `object_type`, the caller must have either of the following sets of permissions: 1.
+        **MANAGE** and **USE_CATALOG** on the schema's parent catalog. 2. **USE_CATALOG** on the schema's
+        parent catalog, and **MANAGE** and **USE_SCHEMA** on the schema.
+
         :param object_type: str
           The type of the monitored object. Can be one of the following: `schema` or `table`.
         :param object_id: str
-          The UUID of the request object. For example, schema id.
+          The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.
+
+          Find the `schema_id` from either: 1. The [schema_id] of the `Schemas` resource. 2. In [Catalog
+          Explorer] > select the `schema` > go to the `Details` tab > the `Schema ID` field.
+
+          Find the `table_id` from either: 1. The [table_id] of the `Tables` resource. 2. In [Catalog
+          Explorer] > select the `table` > go to the `Details` tab > the `Table ID` field.
+
+          [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/
+          [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id
+          [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id
 
 
         """
@@ -935,7 +1002,17 @@ class DataQualityAPI:
         :param object_type: str
           The type of the monitored object. Can be one of the following: `schema` or `table`.
         :param object_id: str
-          The UUID of the request object. For example, schema id.
+          The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.
+
+          Find the `schema_id` from either: 1. The [schema_id] of the `Schemas` resource. 2. In [Catalog
+          Explorer] > select the `schema` > go to the `Details` tab > the `Schema ID` field.
+
+          Find the `table_id` from either: 1. The [table_id] of the `Tables` resource. 2. In [Catalog
+          Explorer] > select the `table` > go to the `Details` tab > the `Table ID` field.
+
+          [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/
+          [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id
+          [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id
         :param refresh_id: int
           Unique id of the refresh operation.
 
@@ -951,21 +1028,35 @@ class DataQualityAPI:
         )
 
     def get_monitor(self, object_type: str, object_id: str) -> Monitor:
-        """Read a data quality monitor on Unity Catalog object.
+        """Read a data quality monitor on a Unity Catalog object.
+
+        For the `table` `object_type`, the caller must have either of the following sets of permissions: 1.
+        **MANAGE** and **USE_CATALOG** on the table's parent catalog. 2. **USE_CATALOG** on the table's parent
+        catalog, and **MANAGE** and **USE_SCHEMA** on the table's parent schema. 3. **USE_CATALOG** on the
+        table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **SELECT** on the table.
 
-        For the `table` `object_type`, the caller must either: 1. be an owner of the table's parent catalog 2.
-        have **USE_CATALOG** on the table's parent catalog and be an owner of the table's parent schema. 3.
-        have the following permissions: - **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on
-        the table's parent schema - **SELECT** privilege on the table.
+        For the `schema` `object_type`, the caller must have either of the following sets of permissions: 1.
+        **MANAGE** and **USE_CATALOG** on the schema's parent catalog. 2. **USE_CATALOG** on the schema's
+        parent catalog, and **USE_SCHEMA** on the schema.
 
-        The returned information includes configuration values, as well as information on assets created by
-        the monitor. Some information (e.g., dashboard) may be filtered out if the caller is in a different
-        workspace than where the monitor was created.
+        The returned information includes configuration values on the entity and parent entity as well as
+        information on assets created by the monitor. Some information (e.g. dashboard) may be filtered out if
+        the caller is in a different workspace than where the monitor was created.
 
         :param object_type: str
           The type of the monitored object. Can be one of the following: `schema` or `table`.
         :param object_id: str
-          The UUID of the request object. For example, schema id.
+          The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.
+
+          Find the `schema_id` from either: 1. The [schema_id] of the `Schemas` resource. 2. In [Catalog
+          Explorer] > select the `schema` > go to the `Details` tab > the `Schema ID` field.
+
+          Find the `table_id` from either: 1. The [table_id] of the `Tables` resource. 2. In [Catalog
+          Explorer] > select the `table` > go to the `Details` tab > the `Table ID` field.
+
+          [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/
+          [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id
+          [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id
 
         :returns: :class:`Monitor`
         """
@@ -978,17 +1069,32 @@ class DataQualityAPI:
         return Monitor.from_dict(res)
 
     def get_refresh(self, object_type: str, object_id: str, refresh_id: int) -> Refresh:
-        """Get data quality monitor refresh.
+        """Get data quality monitor refresh. The call must be made in the same workspace as where the monitor was
+        created.
 
-        For the `table` `object_type`, the caller must either: 1. be an owner of the table's parent catalog 2.
-        have **USE_CATALOG** on the table's parent catalog and be an owner of the table's parent schema 3.
-        have the following permissions: - **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on
-        the table's parent schema - **SELECT** privilege on the table.
+        For the `table` `object_type`, the caller must have either of the following sets of permissions: 1.
+        **MANAGE** and **USE_CATALOG** on the table's parent catalog. 2. **USE_CATALOG** on the table's parent
+        catalog, and **MANAGE** and **USE_SCHEMA** on the table's parent schema. 3. **USE_CATALOG** on the
+        table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **SELECT** on the table.
+
+        For the `schema` `object_type`, the caller must have either of the following sets of permissions: 1.
+        **MANAGE** and **USE_CATALOG** on the schema's parent catalog. 2. **USE_CATALOG** on the schema's
+        parent catalog, and **USE_SCHEMA** on the schema.
 
         :param object_type: str
           The type of the monitored object. Can be one of the following: `schema` or `table`.
         :param object_id: str
-          The UUID of the request object. For example, schema id.
+          The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.
+
+          Find the `schema_id` from either: 1. The [schema_id] of the `Schemas` resource. 2. In [Catalog
+          Explorer] > select the `schema` > go to the `Details` tab > the `Schema ID` field.
+
+          Find the `table_id` from either: 1. The [table_id] of the `Tables` resource. 2. In [Catalog
+          Explorer] > select the `table` > go to the `Details` tab > the `Table ID` field.
+
+          [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/
+          [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id
+          [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id
         :param refresh_id: int
           Unique id of the refresh operation.
 
@@ -1034,17 +1140,32 @@ class DataQualityAPI:
     def list_refresh(
         self, object_type: str, object_id: str, *, page_size: Optional[int] = None, page_token: Optional[str] = None
     ) -> Iterator[Refresh]:
-        """List data quality monitor refreshes.
+        """List data quality monitor refreshes. The call must be made in the same workspace as where the monitor
+        was created.
+
+        For the `table` `object_type`, the caller must have either of the following sets of permissions: 1.
+        **MANAGE** and **USE_CATALOG** on the table's parent catalog. 2. **USE_CATALOG** on the table's parent
+        catalog, and **MANAGE** and **USE_SCHEMA** on the table's parent schema. 3. **USE_CATALOG** on the
+        table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **SELECT** on the table.
 
-        For the `table` `object_type`, the caller must either: 1. be an owner of the table's parent catalog 2.
-        have **USE_CATALOG** on the table's parent catalog and be an owner of the table's parent schema 3.
-        have the following permissions: - **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on
-        the table's parent schema - **SELECT** privilege on the table.
+        For the `schema` `object_type`, the caller must have either of the following sets of permissions: 1.
+        **MANAGE** and **USE_CATALOG** on the schema's parent catalog. 2. **USE_CATALOG** on the schema's
+        parent catalog, and **USE_SCHEMA** on the schema.
 
         :param object_type: str
           The type of the monitored object. Can be one of the following: `schema` or `table`.
         :param object_id: str
-          The UUID of the request object. For example, schema id.
+          The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.
+
+          Find the `schema_id` from either: 1. The [schema_id] of the `Schemas` resource. 2. In [Catalog
+          Explorer] > select the `schema` > go to the `Details` tab > the `Schema ID` field.
+
+          Find the `table_id` from either: 1. The [table_id] of the `Tables` resource. 2. In [Catalog
+          Explorer] > select the `table` > go to the `Details` tab > the `Table ID` field.
+
+          [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/
+          [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id
+          [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id
         :param page_size: int (optional)
         :param page_token: str (optional)
 
@@ -1077,15 +1198,29 @@ class DataQualityAPI:
     def update_monitor(self, object_type: str, object_id: str, monitor: Monitor, update_mask: str) -> Monitor:
         """Update a data quality monitor on Unity Catalog object.
 
-        For the `table` `object_type`, The caller must either: 1. be an owner of the table's parent catalog 2.
-        have **USE_CATALOG** on the table's parent catalog and be an owner of the table's parent schema 3.
-        have the following permissions: - **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on
-        the table's parent schema - be an owner of the table.
+        For the `table` `object_type`, the caller must have either of the following sets of permissions: 1.
+        **MANAGE** and **USE_CATALOG** on the table's parent catalog. 2. **USE_CATALOG** on the table's parent
+        catalog, and **MANAGE** and **USE_SCHEMA** on the table's parent schema. 3. **USE_CATALOG** on the
+        table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **MANAGE** on the table.
+
+        For the `schema` `object_type`, the caller must have either of the following sets of permissions: 1.
+        **MANAGE** and **USE_CATALOG** on the schema's parent catalog. 2. **USE_CATALOG** on the schema's
+        parent catalog, and **MANAGE** and **USE_SCHEMA** on the schema.
 
         :param object_type: str
           The type of the monitored object. Can be one of the following: `schema` or `table`.
         :param object_id: str
-          The UUID of the request object. For example, schema id.
+          The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.
+
+          Find the `schema_id` from either: 1. The [schema_id] of the `Schemas` resource. 2. In [Catalog
+          Explorer] > select the `schema` > go to the `Details` tab > the `Schema ID` field.
+
+          Find the `table_id` from either: 1. The [table_id] of the `Tables` resource. 2. In [Catalog
+          Explorer] > select the `table` > go to the `Details` tab > the `Table ID` field.
+
+          [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/
+          [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id
+          [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id
         :param monitor: :class:`Monitor`
           The monitor to update.
         :param update_mask: str
@@ -1116,7 +1251,17 @@ class DataQualityAPI:
         :param object_type: str
           The type of the monitored object. Can be one of the following: `schema` or `table`.
         :param object_id: str
-          The UUID of the request object. For example, schema id.
+          The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.
+
+          Find the `schema_id` from either: 1. The [schema_id] of the `Schemas` resource. 2. In [Catalog
+          Explorer] > select the `schema` > go to the `Details` tab > the `Schema ID` field.
+
+          Find the `table_id` from either: 1. The [table_id] of the `Tables` resource. 2. In [Catalog
+          Explorer] > select the `table` > go to the `Details` tab > the `Table ID` field.
+
+          [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/
+          [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id
+          [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id
         :param refresh_id: int
           Unique id of the refresh operation.
         :param refresh: :class:`Refresh`