pulumi-databricks 1.75.0a1756323569__py3-none-any.whl → 1.77.0__py3-none-any.whl

pulumi_databricks/get_dashboards.py

@@ -14,6 +14,7 @@ else:
     from typing_extensions import NotRequired, TypedDict, TypeAlias
 from . import _utilities
 from . import outputs
+from ._inputs import *
 
 __all__ = [
     'GetDashboardsResult',
@@ -27,7 +28,7 @@ class GetDashboardsResult:
     """
     A collection of values returned by getDashboards.
     """
-    def __init__(__self__, dashboard_name_contains=None, dashboards=None, id=None):
+    def __init__(__self__, dashboard_name_contains=None, dashboards=None, id=None, provider_config=None):
         if dashboard_name_contains and not isinstance(dashboard_name_contains, str):
             raise TypeError("Expected argument 'dashboard_name_contains' to be a str")
         pulumi.set(__self__, "dashboard_name_contains", dashboard_name_contains)
@@ -37,6 +38,9 @@ class GetDashboardsResult:
         if id and not isinstance(id, str):
             raise TypeError("Expected argument 'id' to be a str")
         pulumi.set(__self__, "id", id)
+        if provider_config and not isinstance(provider_config, dict):
+            raise TypeError("Expected argument 'provider_config' to be a dict")
+        pulumi.set(__self__, "provider_config", provider_config)
 
     @_builtins.property
     @pulumi.getter(name="dashboardNameContains")
@@ -59,6 +63,11 @@ class GetDashboardsResult:
         """
         return pulumi.get(self, "id")
 
+    @_builtins.property
+    @pulumi.getter(name="providerConfig")
+    def provider_config(self) -> Optional['outputs.GetDashboardsProviderConfigResult']:
+        return pulumi.get(self, "provider_config")
+
 
 class AwaitableGetDashboardsResult(GetDashboardsResult):
     # pylint: disable=using-constant-test
@@ -68,43 +77,54 @@ class AwaitableGetDashboardsResult(GetDashboardsResult):
         return GetDashboardsResult(
             dashboard_name_contains=self.dashboard_name_contains,
             dashboards=self.dashboards,
-            id=self.id)
+            id=self.id,
+            provider_config=self.provider_config)
 
 
 def get_dashboards(dashboard_name_contains: Optional[_builtins.str] = None,
+                   provider_config: Optional[Union['GetDashboardsProviderConfigArgs', 'GetDashboardsProviderConfigArgsDict']] = None,
                    opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetDashboardsResult:
     """
     This data source allows you to retrieve information about Databricks [Dashboards](https://docs.databricks.com/en/dashboards/index.html).
 
     > This data source can only be used with a workspace-level provider!
 
+    ## Example Usage
+
 
     :param _builtins.str dashboard_name_contains: A **case-insensitive** substring to filter Dashboards by their name.
     """
     __args__ = dict()
     __args__['dashboardNameContains'] = dashboard_name_contains
+    __args__['providerConfig'] = provider_config
     opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
     __ret__ = pulumi.runtime.invoke('databricks:index/getDashboards:getDashboards', __args__, opts=opts, typ=GetDashboardsResult).value
 
     return AwaitableGetDashboardsResult(
         dashboard_name_contains=pulumi.get(__ret__, 'dashboard_name_contains'),
         dashboards=pulumi.get(__ret__, 'dashboards'),
-        id=pulumi.get(__ret__, 'id'))
+        id=pulumi.get(__ret__, 'id'),
+        provider_config=pulumi.get(__ret__, 'provider_config'))
 def get_dashboards_output(dashboard_name_contains: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                          provider_config: Optional[pulumi.Input[Optional[Union['GetDashboardsProviderConfigArgs', 'GetDashboardsProviderConfigArgsDict']]]] = None,
                           opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetDashboardsResult]:
     """
     This data source allows you to retrieve information about Databricks [Dashboards](https://docs.databricks.com/en/dashboards/index.html).
 
     > This data source can only be used with a workspace-level provider!
 
+    ## Example Usage
+
 
     :param _builtins.str dashboard_name_contains: A **case-insensitive** substring to filter Dashboards by their name.
     """
     __args__ = dict()
     __args__['dashboardNameContains'] = dashboard_name_contains
+    __args__['providerConfig'] = provider_config
     opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
     __ret__ = pulumi.runtime.invoke_output('databricks:index/getDashboards:getDashboards', __args__, opts=opts, typ=GetDashboardsResult)
     return __ret__.apply(lambda __response__: GetDashboardsResult(
         dashboard_name_contains=pulumi.get(__response__, 'dashboard_name_contains'),
         dashboards=pulumi.get(__response__, 'dashboards'),
-        id=pulumi.get(__response__, 'id')))
+        id=pulumi.get(__response__, 'id'),
+        provider_config=pulumi.get(__response__, 'provider_config')))

pulumi_databricks/get_data_quality_monitor.py

@@ -0,0 +1,210 @@
+# coding=utf-8
+# *** WARNING: this file was generated by pulumi-language-python. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import builtins as _builtins
+import warnings
+import sys
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
+from . import _utilities
+from . import outputs
+
+__all__ = [
+    'GetDataQualityMonitorResult',
+    'AwaitableGetDataQualityMonitorResult',
+    'get_data_quality_monitor',
+    'get_data_quality_monitor_output',
+]
+
+@pulumi.output_type
+class GetDataQualityMonitorResult:
+    """
+    A collection of values returned by getDataQualityMonitor.
+    """
+    def __init__(__self__, anomaly_detection_config=None, data_profiling_config=None, id=None, object_id=None, object_type=None):
+        if anomaly_detection_config and not isinstance(anomaly_detection_config, dict):
+            raise TypeError("Expected argument 'anomaly_detection_config' to be a dict")
+        pulumi.set(__self__, "anomaly_detection_config", anomaly_detection_config)
+        if data_profiling_config and not isinstance(data_profiling_config, dict):
+            raise TypeError("Expected argument 'data_profiling_config' to be a dict")
+        pulumi.set(__self__, "data_profiling_config", data_profiling_config)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if object_id and not isinstance(object_id, str):
+            raise TypeError("Expected argument 'object_id' to be a str")
+        pulumi.set(__self__, "object_id", object_id)
+        if object_type and not isinstance(object_type, str):
+            raise TypeError("Expected argument 'object_type' to be a str")
+        pulumi.set(__self__, "object_type", object_type)
+
+    @_builtins.property
+    @pulumi.getter(name="anomalyDetectionConfig")
+    def anomaly_detection_config(self) -> 'outputs.GetDataQualityMonitorAnomalyDetectionConfigResult':
+        """
+        (AnomalyDetectionConfig) - Anomaly Detection Configuration, applicable to `schema` object types
+        """
+        return pulumi.get(self, "anomaly_detection_config")
+
+    @_builtins.property
+    @pulumi.getter(name="dataProfilingConfig")
+    def data_profiling_config(self) -> 'outputs.GetDataQualityMonitorDataProfilingConfigResult':
+        """
+        (DataProfilingConfig) - Data Profiling Configuration, applicable to `table` object types. Exactly one `Analysis Configuration`
+        must be present
+        """
+        return pulumi.get(self, "data_profiling_config")
+
+    @_builtins.property
+    @pulumi.getter
+    def id(self) -> _builtins.str:
+        """
+        The provider-assigned unique ID for this managed resource.
+        """
+        return pulumi.get(self, "id")
+
+    @_builtins.property
+    @pulumi.getter(name="objectId")
+    def object_id(self) -> _builtins.str:
+        """
+        (string) - The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.
+        """
+        return pulumi.get(self, "object_id")
+
+    @_builtins.property
+    @pulumi.getter(name="objectType")
+    def object_type(self) -> _builtins.str:
+        """
+        (string) - The type of the monitored object. Can be one of the following: `schema` or `table`
+        """
+        return pulumi.get(self, "object_type")
+
+
+class AwaitableGetDataQualityMonitorResult(GetDataQualityMonitorResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetDataQualityMonitorResult(
+            anomaly_detection_config=self.anomaly_detection_config,
+            data_profiling_config=self.data_profiling_config,
+            id=self.id,
+            object_id=self.object_id,
+            object_type=self.object_type)
+
+
+def get_data_quality_monitor(object_id: Optional[_builtins.str] = None,
+                             object_type: Optional[_builtins.str] = None,
+                             opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetDataQualityMonitorResult:
+    """
+    [![Public Beta](https://img.shields.io/badge/Release_Stage-Public_Beta-orange)](https://docs.databricks.com/aws/en/release-notes/release-types)
+
+    This data source can be used to fetch a data quality monitor.
+
+    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.
+
+    > **Note** This data source can only be used with a workspace-level provider!
+
+    ## Example Usage
+
+    Getting a data quality monitor by Unity Catalog object type (currently supports `schema` and `table`) and object id:
+
+    ```python
+    import pulumi
+    import pulumi_databricks as databricks
+
+    this = databricks.get_schema(name="my_catalog.my_schema")
+    this_get_data_quality_monitor = databricks.get_data_quality_monitor(object_type="schema",
+        object_id=this.schema_info.schema_id)
+    ```
+
+
+    :param _builtins.str object_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](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.
+           2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `schema` > go to the `Details` tab > the `Schema ID` field.
+           
+           Find the `table_id` from either:
+           1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.
+           2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field
+    :param _builtins.str object_type: The type of the monitored object. Can be one of the following: `schema` or `table`
+    """
+    __args__ = dict()
+    __args__['objectId'] = object_id
+    __args__['objectType'] = object_type
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('databricks:index/getDataQualityMonitor:getDataQualityMonitor', __args__, opts=opts, typ=GetDataQualityMonitorResult).value
+
+    return AwaitableGetDataQualityMonitorResult(
+        anomaly_detection_config=pulumi.get(__ret__, 'anomaly_detection_config'),
+        data_profiling_config=pulumi.get(__ret__, 'data_profiling_config'),
+        id=pulumi.get(__ret__, 'id'),
+        object_id=pulumi.get(__ret__, 'object_id'),
+        object_type=pulumi.get(__ret__, 'object_type'))
+def get_data_quality_monitor_output(object_id: Optional[pulumi.Input[_builtins.str]] = None,
+                                    object_type: Optional[pulumi.Input[_builtins.str]] = None,
+                                    opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetDataQualityMonitorResult]:
+    """
+    [![Public Beta](https://img.shields.io/badge/Release_Stage-Public_Beta-orange)](https://docs.databricks.com/aws/en/release-notes/release-types)
+
+    This data source can be used to fetch a data quality monitor.
+
+    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.
+
+    > **Note** This data source can only be used with a workspace-level provider!
+
+    ## Example Usage
+
+    Getting a data quality monitor by Unity Catalog object type (currently supports `schema` and `table`) and object id:
+
+    ```python
+    import pulumi
+    import pulumi_databricks as databricks
+
+    this = databricks.get_schema(name="my_catalog.my_schema")
+    this_get_data_quality_monitor = databricks.get_data_quality_monitor(object_type="schema",
+        object_id=this.schema_info.schema_id)
+    ```
+
+
+    :param _builtins.str object_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](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.
+           2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `schema` > go to the `Details` tab > the `Schema ID` field.
+           
+           Find the `table_id` from either:
+           1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.
+           2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field
+    :param _builtins.str object_type: The type of the monitored object. Can be one of the following: `schema` or `table`
+    """
+    __args__ = dict()
+    __args__['objectId'] = object_id
+    __args__['objectType'] = object_type
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('databricks:index/getDataQualityMonitor:getDataQualityMonitor', __args__, opts=opts, typ=GetDataQualityMonitorResult)
+    return __ret__.apply(lambda __response__: GetDataQualityMonitorResult(
+        anomaly_detection_config=pulumi.get(__response__, 'anomaly_detection_config'),
+        data_profiling_config=pulumi.get(__response__, 'data_profiling_config'),
+        id=pulumi.get(__response__, 'id'),
+        object_id=pulumi.get(__response__, 'object_id'),
+        object_type=pulumi.get(__response__, 'object_type')))

pulumi_databricks/get_data_quality_monitors.py

@@ -0,0 +1,143 @@
+# coding=utf-8
+# *** WARNING: this file was generated by pulumi-language-python. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import builtins as _builtins
+import warnings
+import sys
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
+from . import _utilities
+from . import outputs
+
+__all__ = [
+    'GetDataQualityMonitorsResult',
+    'AwaitableGetDataQualityMonitorsResult',
+    'get_data_quality_monitors',
+    'get_data_quality_monitors_output',
+]
+
+@pulumi.output_type
+class GetDataQualityMonitorsResult:
+    """
+    A collection of values returned by getDataQualityMonitors.
+    """
+    def __init__(__self__, id=None, monitors=None, page_size=None):
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if monitors and not isinstance(monitors, list):
+            raise TypeError("Expected argument 'monitors' to be a list")
+        pulumi.set(__self__, "monitors", monitors)
+        if page_size and not isinstance(page_size, int):
+            raise TypeError("Expected argument 'page_size' to be a int")
+        pulumi.set(__self__, "page_size", page_size)
+
+    @_builtins.property
+    @pulumi.getter
+    def id(self) -> _builtins.str:
+        """
+        The provider-assigned unique ID for this managed resource.
+        """
+        return pulumi.get(self, "id")
+
+    @_builtins.property
+    @pulumi.getter
+    def monitors(self) -> Sequence['outputs.GetDataQualityMonitorsMonitorResult']:
+        return pulumi.get(self, "monitors")
+
+    @_builtins.property
+    @pulumi.getter(name="pageSize")
+    def page_size(self) -> Optional[_builtins.int]:
+        return pulumi.get(self, "page_size")
+
+
+class AwaitableGetDataQualityMonitorsResult(GetDataQualityMonitorsResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetDataQualityMonitorsResult(
+            id=self.id,
+            monitors=self.monitors,
+            page_size=self.page_size)
+
+
+def get_data_quality_monitors(page_size: Optional[_builtins.int] = None,
+                              opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetDataQualityMonitorsResult:
+    """
+    [![Public Beta](https://img.shields.io/badge/Release_Stage-Public_Beta-orange)](https://docs.databricks.com/aws/en/release-notes/release-types)
+
+    This data source can be used to fetch the list of data quality monitors.
+
+    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.
+
+    > **Note** This data source can only be used with a workspace-level provider!
+
+    ## Example Usage
+
+    Getting a list of all data quality monitors:
+
+    ```python
+    import pulumi
+    import pulumi_databricks as databricks
+
+    all = databricks.get_data_quality_monitors()
+    ```
+    """
+    __args__ = dict()
+    __args__['pageSize'] = page_size
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('databricks:index/getDataQualityMonitors:getDataQualityMonitors', __args__, opts=opts, typ=GetDataQualityMonitorsResult).value
+
+    return AwaitableGetDataQualityMonitorsResult(
+        id=pulumi.get(__ret__, 'id'),
+        monitors=pulumi.get(__ret__, 'monitors'),
+        page_size=pulumi.get(__ret__, 'page_size'))
+def get_data_quality_monitors_output(page_size: Optional[pulumi.Input[Optional[_builtins.int]]] = None,
+                                     opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetDataQualityMonitorsResult]:
+    """
+    [![Public Beta](https://img.shields.io/badge/Release_Stage-Public_Beta-orange)](https://docs.databricks.com/aws/en/release-notes/release-types)
+
+    This data source can be used to fetch the list of data quality monitors.
+
+    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.
+
+    > **Note** This data source can only be used with a workspace-level provider!
+
+    ## Example Usage
+
+    Getting a list of all data quality monitors:
+
+    ```python
+    import pulumi
+    import pulumi_databricks as databricks
+
+    all = databricks.get_data_quality_monitors()
+    ```
+    """
+    __args__ = dict()
+    __args__['pageSize'] = page_size
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('databricks:index/getDataQualityMonitors:getDataQualityMonitors', __args__, opts=opts, typ=GetDataQualityMonitorsResult)
+    return __ret__.apply(lambda __response__: GetDataQualityMonitorsResult(
+        id=pulumi.get(__response__, 'id'),
+        monitors=pulumi.get(__response__, 'monitors'),
+        page_size=pulumi.get(__response__, 'page_size')))