databricks-sdk 0.19.1__py3-none-any.whl → 0.21.0__py3-none-any.whl

databricks/sdk/service/provisioning.py

@@ -597,6 +597,20 @@ class CustomerManagedKey:
                    use_cases=_repeated_enum(d, 'use_cases', KeyUseCase))
 
 
+@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
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> DeleteResponse:
+        """Deserializes the DeleteResponse from a dictionary."""
+        return cls()
+
+
 class EndpointUseCase(Enum):
     """This enumeration represents the type of Databricks VPC [endpoint service] that was used when
     creating this VPC endpoint.
@@ -1062,6 +1076,20 @@ class PrivateAccessSettings:
                    region=d.get('region', None))
 
 
+@dataclass
+class ReplaceResponse:
+
+    def as_dict(self) -> dict:
+        """Serializes the ReplaceResponse into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> ReplaceResponse:
+        """Deserializes the ReplaceResponse from a dictionary."""
+        return cls()
+
+
 @dataclass
 class RootBucketInfo:
     """Root S3 bucket information."""
@@ -1142,6 +1170,20 @@ class StsRole:
         return cls(external_id=d.get('external_id', None), role_arn=d.get('role_arn', None))
 
 
+@dataclass
+class UpdateResponse:
+
+    def as_dict(self) -> dict:
+        """Serializes the UpdateResponse into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> UpdateResponse:
+        """Deserializes the UpdateResponse from a dictionary."""
+        return cls()
+
+
 @dataclass
 class UpdateWorkspaceRequest:
     aws_region: Optional[str] = None
@@ -1162,8 +1204,6 @@ class UpdateWorkspaceRequest:
     is available only for updating failed workspaces."""
 
     network_connectivity_config_id: Optional[str] = None
-    """The ID of the network connectivity configuration object, which is the parent resource of this
-    private endpoint rule object."""
 
     network_id: Optional[str] = None
     """The ID of the workspace's network configuration object. Used only if you already use a
@@ -1581,6 +1621,7 @@ class CredentialsAPI:
         if aws_credentials is not None: body['aws_credentials'] = aws_credentials.as_dict()
         if credentials_name is not None: body['credentials_name'] = credentials_name
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
         res = self._api.do('POST',
                            f'/api/2.0/accounts/{self._api.account_id}/credentials',
                            body=body,
@@ -1600,6 +1641,7 @@ class CredentialsAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         self._api.do('DELETE',
                      f'/api/2.0/accounts/{self._api.account_id}/credentials/{credentials_id}',
                      headers=headers)
@@ -1616,6 +1658,7 @@ class CredentialsAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         res = self._api.do('GET',
                            f'/api/2.0/accounts/{self._api.account_id}/credentials/{credentials_id}',
                            headers=headers)
@@ -1630,6 +1673,7 @@ class CredentialsAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         res = self._api.do('GET', f'/api/2.0/accounts/{self._api.account_id}/credentials', headers=headers)
         return [Credential.from_dict(v) for v in res]
 
@@ -1685,6 +1729,7 @@ class EncryptionKeysAPI:
         if gcp_key_info is not None: body['gcp_key_info'] = gcp_key_info.as_dict()
         if use_cases is not None: body['use_cases'] = [v.value for v in use_cases]
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
         res = self._api.do('POST',
                            f'/api/2.0/accounts/{self._api.account_id}/customer-managed-keys',
                            body=body,
@@ -1704,6 +1749,7 @@ class EncryptionKeysAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         self._api.do(
             'DELETE',
             f'/api/2.0/accounts/{self._api.account_id}/customer-managed-keys/{customer_managed_key_id}',
@@ -1732,6 +1778,7 @@ class EncryptionKeysAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         res = self._api.do(
             'GET',
             f'/api/2.0/accounts/{self._api.account_id}/customer-managed-keys/{customer_managed_key_id}',
@@ -1756,6 +1803,7 @@ class EncryptionKeysAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         res = self._api.do('GET',
                            f'/api/2.0/accounts/{self._api.account_id}/customer-managed-keys',
                            headers=headers)
@@ -1812,6 +1860,7 @@ class NetworksAPI:
         if vpc_endpoints is not None: body['vpc_endpoints'] = vpc_endpoints.as_dict()
         if vpc_id is not None: body['vpc_id'] = vpc_id
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
         res = self._api.do('POST',
                            f'/api/2.0/accounts/{self._api.account_id}/networks',
                            body=body,
@@ -1833,6 +1882,7 @@ class NetworksAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         self._api.do('DELETE',
                      f'/api/2.0/accounts/{self._api.account_id}/networks/{network_id}',
                      headers=headers)
@@ -1849,6 +1899,7 @@ class NetworksAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         res = self._api.do('GET',
                            f'/api/2.0/accounts/{self._api.account_id}/networks/{network_id}',
                            headers=headers)
@@ -1865,6 +1916,7 @@ class NetworksAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         res = self._api.do('GET', f'/api/2.0/accounts/{self._api.account_id}/networks', headers=headers)
         return [Network.from_dict(v) for v in res]
 
@@ -1936,6 +1988,7 @@ class PrivateAccessAPI:
         if public_access_enabled is not None: body['public_access_enabled'] = public_access_enabled
         if region is not None: body['region'] = region
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
         res = self._api.do('POST',
                            f'/api/2.0/accounts/{self._api.account_id}/private-access-settings',
                            body=body,
@@ -1960,6 +2013,7 @@ class PrivateAccessAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         self._api.do(
             'DELETE',
             f'/api/2.0/accounts/{self._api.account_id}/private-access-settings/{private_access_settings_id}',
@@ -1983,6 +2037,7 @@ class PrivateAccessAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         res = self._api.do(
             'GET',
             f'/api/2.0/accounts/{self._api.account_id}/private-access-settings/{private_access_settings_id}',
@@ -1998,6 +2053,7 @@ class PrivateAccessAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         res = self._api.do('GET',
                            f'/api/2.0/accounts/{self._api.account_id}/private-access-settings',
                            headers=headers)
@@ -2072,6 +2128,7 @@ class PrivateAccessAPI:
         if public_access_enabled is not None: body['public_access_enabled'] = public_access_enabled
         if region is not None: body['region'] = region
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
         self._api.do(
             'PUT',
             f'/api/2.0/accounts/{self._api.account_id}/private-access-settings/{private_access_settings_id}',
@@ -2114,6 +2171,7 @@ class StorageAPI:
         if storage_configuration_name is not None:
             body['storage_configuration_name'] = storage_configuration_name
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
         res = self._api.do('POST',
                            f'/api/2.0/accounts/{self._api.account_id}/storage-configurations',
                            body=body,
@@ -2133,6 +2191,7 @@ class StorageAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         self._api.do(
             'DELETE',
             f'/api/2.0/accounts/{self._api.account_id}/storage-configurations/{storage_configuration_id}',
@@ -2150,6 +2209,7 @@ class StorageAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         res = self._api.do(
             'GET',
             f'/api/2.0/accounts/{self._api.account_id}/storage-configurations/{storage_configuration_id}',
@@ -2165,6 +2225,7 @@ class StorageAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         res = self._api.do('GET',
                            f'/api/2.0/accounts/{self._api.account_id}/storage-configurations',
                            headers=headers)
@@ -2215,6 +2276,7 @@ class VpcEndpointsAPI:
         if region is not None: body['region'] = region
         if vpc_endpoint_name is not None: body['vpc_endpoint_name'] = vpc_endpoint_name
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
         res = self._api.do('POST',
                            f'/api/2.0/accounts/{self._api.account_id}/vpc-endpoints',
                            body=body,
@@ -2240,6 +2302,7 @@ class VpcEndpointsAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         self._api.do('DELETE',
                      f'/api/2.0/accounts/{self._api.account_id}/vpc-endpoints/{vpc_endpoint_id}',
                      headers=headers)
@@ -2260,6 +2323,7 @@ class VpcEndpointsAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         res = self._api.do('GET',
                            f'/api/2.0/accounts/{self._api.account_id}/vpc-endpoints/{vpc_endpoint_id}',
                            headers=headers)
@@ -2278,6 +2342,7 @@ class VpcEndpointsAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         res = self._api.do('GET', f'/api/2.0/accounts/{self._api.account_id}/vpc-endpoints', headers=headers)
         return [VpcEndpoint.from_dict(v) for v in res]
 
@@ -2466,6 +2531,7 @@ class WorkspacesAPI:
             body['storage_customer_managed_key_id'] = storage_customer_managed_key_id
         if workspace_name is not None: body['workspace_name'] = workspace_name
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
         op_response = self._api.do('POST',
                                    f'/api/2.0/accounts/{self._api.account_id}/workspaces',
                                    body=body,
@@ -2528,6 +2594,7 @@ class WorkspacesAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         self._api.do('DELETE',
                      f'/api/2.0/accounts/{self._api.account_id}/workspaces/{workspace_id}',
                      headers=headers)
@@ -2555,6 +2622,7 @@ class WorkspacesAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         res = self._api.do('GET',
                            f'/api/2.0/accounts/{self._api.account_id}/workspaces/{workspace_id}',
                            headers=headers)
@@ -2572,6 +2640,7 @@ class WorkspacesAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         res = self._api.do('GET', f'/api/2.0/accounts/{self._api.account_id}/workspaces', headers=headers)
         return [Workspace.from_dict(v) for v in res]
 
@@ -2608,7 +2677,10 @@ class WorkspacesAPI:
         the private access settings ID to upgrade a workspace to add support for front-end, back-end, or both
         types of connectivity. You cannot remove (downgrade) any existing front-end or back-end PrivateLink
         support on a workspace. - Custom tags. Given you provide an empty custom tags, the update would not be
-        applied.
+        applied. - Network connectivity configuration ID to add serverless stable IP support. You can add or
+        update the network connectivity configuration ID to ensure the workspace uses the same set of stable
+        IP CIDR blocks to access your resources. You cannot remove a network connectivity configuration from
+        the workspace once attached, you can only switch to another one.
         
         After calling the `PATCH` operation to update the workspace configuration, make repeated `GET`
         requests with the workspace ID and check the workspace status. The workspace is successful if the
@@ -2619,28 +2691,29 @@ class WorkspacesAPI:
         
         ### Update a running workspace You can update a Databricks workspace configuration for running
         workspaces for some fields, but not all fields. For a running workspace, this request supports
-        updating the following fields only: - Credential configuration ID
-        
-        - Network configuration ID. Used only if you already use a customer-managed VPC. You cannot convert a
-        running workspace from a Databricks-managed VPC to a customer-managed VPC. You can use a network
-        configuration update in this API for a failed or running workspace to add support for PrivateLink,
-        although you also need to add a private access settings object.
-        
-        - Key configuration ID for managed services (control plane storage, such as notebook source and
-        Databricks SQL queries). Databricks does not directly encrypt the data with the customer-managed key
-        (CMK). Databricks uses both the CMK and the Databricks managed key (DMK) that is unique to your
-        workspace to encrypt the Data Encryption Key (DEK). Databricks uses the DEK to encrypt your
-        workspace's managed services persisted data. If the workspace does not already have a CMK for managed
-        services, adding this ID enables managed services encryption for new or updated data. Existing managed
-        services data that existed before adding the key remains not encrypted with the DEK until it is
-        modified. If the workspace already has customer-managed keys for managed services, this request
-        rotates (changes) the CMK keys and the DEK is re-encrypted with the DMK and the new CMK. - Key
+        updating the following fields only: - Credential configuration ID - Network configuration ID. Used
+        only if you already use a customer-managed VPC. You cannot convert a running workspace from a
+        Databricks-managed VPC to a customer-managed VPC. You can use a network configuration update in this
+        API for a failed or running workspace to add support for PrivateLink, although you also need to add a
+        private access settings object. - Key configuration ID for managed services (control plane storage,
+        such as notebook source and Databricks SQL queries). Databricks does not directly encrypt the data
+        with the customer-managed key (CMK). Databricks uses both the CMK and the Databricks managed key (DMK)
+        that is unique to your workspace to encrypt the Data Encryption Key (DEK). Databricks uses the DEK to
+        encrypt your workspace's managed services persisted data. If the workspace does not already have a CMK
+        for managed services, adding this ID enables managed services encryption for new or updated data.
+        Existing managed services data that existed before adding the key remains not encrypted with the DEK
+        until it is modified. If the workspace already has customer-managed keys for managed services, this
+        request rotates (changes) the CMK keys and the DEK is re-encrypted with the DMK and the new CMK. - Key
         configuration ID for workspace storage (root S3 bucket and, optionally, EBS volumes). You can set this
         only if the workspace does not already have a customer-managed key configuration for workspace
         storage. - Private access settings ID to add PrivateLink support. You can add or update the private
         access settings ID to upgrade a workspace to add support for front-end, back-end, or both types of
         connectivity. You cannot remove (downgrade) any existing front-end or back-end PrivateLink support on
-        a workspace. - Custom tags. Given you provide an empty custom tags, the update would not be applied.
+        a workspace. - Custom tags. Given you provide an empty custom tags, the update would not be applied. -
+        Network connectivity configuration ID to add serverless stable IP support. You can add or update the
+        network connectivity configuration ID to ensure the workspace uses the same set of stable IP CIDR
+        blocks to access your resources. You cannot remove a network connectivity configuration from the
+        workspace once attached, you can only switch to another one.
         
         **Important**: To update a running workspace, your workspace must have no running compute resources
         that run in your workspace's VPC in the Classic data plane. For example, stop all all-purpose
@@ -2655,15 +2728,13 @@ class WorkspacesAPI:
         [Account Console]. However, you cannot use or create clusters for another 20 minutes after that status
         change. This results in a total of up to 40 minutes in which you cannot create clusters. If you create
         or use clusters before this time interval elapses, clusters do not launch successfully, fail, or could
-        cause other unexpected behavior.
-        
-        * For workspaces with a customer-managed VPC, the workspace status stays at status `RUNNING` and the
-        VPC change happens immediately. A change to the storage customer-managed key configuration ID might
-        take a few minutes to update, so continue to check the workspace until you observe that it has been
-        updated. If the update fails, the workspace might revert silently to its original configuration. After
-        the workspace has been updated, you cannot use or create clusters for another 20 minutes. If you
-        create or use clusters before this time interval elapses, clusters do not launch successfully, fail,
-        or could cause other unexpected behavior.
+        cause other unexpected behavior. * For workspaces with a customer-managed VPC, the workspace status
+        stays at status `RUNNING` and the VPC change happens immediately. A change to the storage
+        customer-managed key configuration ID might take a few minutes to update, so continue to check the
+        workspace until you observe that it has been updated. If the update fails, the workspace might revert
+        silently to its original configuration. After the workspace has been updated, you cannot use or create
+        clusters for another 20 minutes. If you create or use clusters before this time interval elapses,
+        clusters do not launch successfully, fail, or could cause other unexpected behavior.
         
         If you update the _storage_ customer-managed key configurations, it takes 20 minutes for the changes
         to fully take effect. During the 20 minute wait, it is important that you stop all REST API calls to
@@ -2696,8 +2767,6 @@ class WorkspacesAPI:
           The ID of the workspace's managed services encryption key configuration object. This parameter is
           available only for updating failed workspaces.
         :param network_connectivity_config_id: str (optional)
-          The ID of the network connectivity configuration object, which is the parent resource of this
-          private endpoint rule object.
         :param network_id: str (optional)
           The ID of the workspace's network configuration object. Used only if you already use a
           customer-managed VPC. For failed workspaces only, you can switch from a Databricks-managed VPC to a
@@ -2726,11 +2795,14 @@ class WorkspacesAPI:
         if storage_customer_managed_key_id is not None:
             body['storage_customer_managed_key_id'] = storage_customer_managed_key_id
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
-        self._api.do('PATCH',
-                     f'/api/2.0/accounts/{self._api.account_id}/workspaces/{workspace_id}',
-                     body=body,
-                     headers=headers)
-        return Wait(self.wait_get_workspace_running, workspace_id=workspace_id)
+
+        op_response = self._api.do('PATCH',
+                                   f'/api/2.0/accounts/{self._api.account_id}/workspaces/{workspace_id}',
+                                   body=body,
+                                   headers=headers)
+        return Wait(self.wait_get_workspace_running,
+                    response=UpdateResponse.from_dict(op_response),
+                    workspace_id=workspace_id)
 
     def update_and_wait(
         self,