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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of databricks-sdk might be problematic. Click here for more details.

Files changed (31) hide show
  1. databricks/sdk/__init__.py +15 -9
  2. databricks/sdk/service/aibuilder.py +157 -16
  3. databricks/sdk/service/apps.py +14 -42
  4. databricks/sdk/service/billing.py +17 -51
  5. databricks/sdk/service/catalog.py +198 -399
  6. databricks/sdk/service/cleanrooms.py +11 -33
  7. databricks/sdk/service/compute.py +63 -189
  8. databricks/sdk/service/dashboards.py +21 -63
  9. databricks/sdk/service/database.py +45 -30
  10. databricks/sdk/service/files.py +18 -54
  11. databricks/sdk/service/iam.py +55 -165
  12. databricks/sdk/service/jobs.py +232 -85
  13. databricks/sdk/service/marketplace.py +46 -146
  14. databricks/sdk/service/ml.py +455 -216
  15. databricks/sdk/service/oauth2.py +17 -45
  16. databricks/sdk/service/pipelines.py +81 -40
  17. databricks/sdk/service/provisioning.py +30 -90
  18. databricks/sdk/service/qualitymonitorv2.py +5 -15
  19. databricks/sdk/service/serving.py +30 -42
  20. databricks/sdk/service/settings.py +103 -314
  21. databricks/sdk/service/sharing.py +30 -86
  22. databricks/sdk/service/sql.py +74 -184
  23. databricks/sdk/service/vectorsearch.py +13 -43
  24. databricks/sdk/service/workspace.py +35 -105
  25. databricks/sdk/version.py +1 -1
  26. {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.57.0.dist-info}/METADATA +1 -1
  27. {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.57.0.dist-info}/RECORD +31 -31
  28. {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.57.0.dist-info}/WHEEL +0 -0
  29. {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.57.0.dist-info}/licenses/LICENSE +0 -0
  30. {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.57.0.dist-info}/licenses/NOTICE +0 -0
  31. {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.57.0.dist-info}/top_level.txt +0 -0
@@ -9834,9 +9834,7 @@ class ClusterPoliciesAPI:
9834
9834
  policy_family_definition_overrides: Optional[str] = None,
9835
9835
  policy_family_id: Optional[str] = None,
9836
9836
  ) -> CreatePolicyResponse:
9837
- """Create a new policy.
9838
-
9839
- Creates a new policy with prescribed settings.
9837
+ """Creates a new policy with prescribed settings.
9840
9838
 
9841
9839
  :param definition: str (optional)
9842
9840
  Policy definition document expressed in [Databricks Cluster Policy Definition Language].
@@ -9894,9 +9892,7 @@ class ClusterPoliciesAPI:
9894
9892
  return CreatePolicyResponse.from_dict(res)
9895
9893
 
9896
9894
  def delete(self, policy_id: str):
9897
- """Delete a cluster policy.
9898
-
9899
- Delete a policy for a cluster. Clusters governed by this policy can still run, but cannot be edited.
9895
+ """Delete a policy for a cluster. Clusters governed by this policy can still run, but cannot be edited.
9900
9896
 
9901
9897
  :param policy_id: str
9902
9898
  The ID of the policy to delete.
@@ -9925,9 +9921,7 @@ class ClusterPoliciesAPI:
9925
9921
  policy_family_definition_overrides: Optional[str] = None,
9926
9922
  policy_family_id: Optional[str] = None,
9927
9923
  ):
9928
- """Update a cluster policy.
9929
-
9930
- Update an existing policy for cluster. This operation may make some clusters governed by the previous
9924
+ """Update an existing policy for cluster. This operation may make some clusters governed by the previous
9931
9925
  policy invalid.
9932
9926
 
9933
9927
  :param policy_id: str
@@ -9989,9 +9983,7 @@ class ClusterPoliciesAPI:
9989
9983
  self._api.do("POST", "/api/2.0/policies/clusters/edit", body=body, headers=headers)
9990
9984
 
9991
9985
  def get(self, policy_id: str) -> Policy:
9992
- """Get a cluster policy.
9993
-
9994
- Get a cluster policy entity. Creation and editing is available to admins only.
9986
+ """Get a cluster policy entity. Creation and editing is available to admins only.
9995
9987
 
9996
9988
  :param policy_id: str
9997
9989
  Canonical unique identifier for the Cluster Policy.
@@ -10010,9 +10002,7 @@ class ClusterPoliciesAPI:
10010
10002
  return Policy.from_dict(res)
10011
10003
 
10012
10004
  def get_permission_levels(self, cluster_policy_id: str) -> GetClusterPolicyPermissionLevelsResponse:
10013
- """Get cluster policy permission levels.
10014
-
10015
- Gets the permission levels that a user can have on an object.
10005
+ """Gets the permission levels that a user can have on an object.
10016
10006
 
10017
10007
  :param cluster_policy_id: str
10018
10008
  The cluster policy for which to get or manage permissions.
@@ -10030,9 +10020,7 @@ class ClusterPoliciesAPI:
10030
10020
  return GetClusterPolicyPermissionLevelsResponse.from_dict(res)
10031
10021
 
10032
10022
  def get_permissions(self, cluster_policy_id: str) -> ClusterPolicyPermissions:
10033
- """Get cluster policy permissions.
10034
-
10035
- Gets the permissions of a cluster policy. Cluster policies can inherit permissions from their root
10023
+ """Gets the permissions of a cluster policy. Cluster policies can inherit permissions from their root
10036
10024
  object.
10037
10025
 
10038
10026
  :param cluster_policy_id: str
@@ -10051,9 +10039,7 @@ class ClusterPoliciesAPI:
10051
10039
  def list(
10052
10040
  self, *, sort_column: Optional[ListSortColumn] = None, sort_order: Optional[ListSortOrder] = None
10053
10041
  ) -> Iterator[Policy]:
10054
- """List cluster policies.
10055
-
10056
- Returns a list of policies accessible by the requesting user.
10042
+ """Returns a list of policies accessible by the requesting user.
10057
10043
 
10058
10044
  :param sort_column: :class:`ListSortColumn` (optional)
10059
10045
  The cluster policy attribute to sort by. * `POLICY_CREATION_TIME` - Sort result list by policy
@@ -10081,9 +10067,7 @@ class ClusterPoliciesAPI:
10081
10067
  def set_permissions(
10082
10068
  self, cluster_policy_id: str, *, access_control_list: Optional[List[ClusterPolicyAccessControlRequest]] = None
10083
10069
  ) -> ClusterPolicyPermissions:
10084
- """Set cluster policy permissions.
10085
-
10086
- Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct
10070
+ """Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct
10087
10071
  permissions if none are specified. Objects can inherit permissions from their root object.
10088
10072
 
10089
10073
  :param cluster_policy_id: str
@@ -10108,9 +10092,7 @@ class ClusterPoliciesAPI:
10108
10092
  def update_permissions(
10109
10093
  self, cluster_policy_id: str, *, access_control_list: Optional[List[ClusterPolicyAccessControlRequest]] = None
10110
10094
  ) -> ClusterPolicyPermissions:
10111
- """Update cluster policy permissions.
10112
-
10113
- Updates the permissions on a cluster policy. Cluster policies can inherit permissions from their root
10095
+ """Updates the permissions on a cluster policy. Cluster policies can inherit permissions from their root
10114
10096
  object.
10115
10097
 
10116
10098
  :param cluster_policy_id: str
@@ -10226,9 +10208,7 @@ class ClustersAPI:
10226
10208
  raise TimeoutError(f"timed out after {timeout}: {status_message}")
10227
10209
 
10228
10210
  def change_owner(self, cluster_id: str, owner_username: str):
10229
- """Change cluster owner.
10230
-
10231
- Change the owner of the cluster. You must be an admin and the cluster must be terminated to perform
10211
+ """Change the owner of the cluster. You must be an admin and the cluster must be terminated to perform
10232
10212
  this operation. The service principal application ID can be supplied as an argument to
10233
10213
  `owner_username`.
10234
10214
 
@@ -10285,9 +10265,7 @@ class ClustersAPI:
10285
10265
  use_ml_runtime: Optional[bool] = None,
10286
10266
  workload_type: Optional[WorkloadType] = None,
10287
10267
  ) -> Wait[ClusterDetails]:
10288
- """Create new cluster.
10289
-
10290
- Creates a new Spark cluster. This method will acquire new instances from the cloud provider if
10268
+ """Creates a new Spark cluster. This method will acquire new instances from the cloud provider if
10291
10269
  necessary. This method is asynchronous; the returned ``cluster_id`` can be used to poll the cluster
10292
10270
  status. When this method returns, the cluster will be in a ``PENDING`` state. The cluster will be
10293
10271
  usable once it enters a ``RUNNING`` state. Note: Databricks may not be able to acquire some of the
@@ -10615,9 +10593,7 @@ class ClustersAPI:
10615
10593
  ).result(timeout=timeout)
10616
10594
 
10617
10595
  def delete(self, cluster_id: str) -> Wait[ClusterDetails]:
10618
- """Terminate cluster.
10619
-
10620
- Terminates the Spark cluster with the specified ID. The cluster is removed asynchronously. Once the
10596
+ """Terminates the Spark cluster with the specified ID. The cluster is removed asynchronously. Once the
10621
10597
  termination has completed, the cluster will be in a `TERMINATED` state. If the cluster is already in a
10622
10598
  `TERMINATING` or `TERMINATED` state, nothing will happen.
10623
10599
 
@@ -10681,9 +10657,7 @@ class ClustersAPI:
10681
10657
  use_ml_runtime: Optional[bool] = None,
10682
10658
  workload_type: Optional[WorkloadType] = None,
10683
10659
  ) -> Wait[ClusterDetails]:
10684
- """Update cluster configuration.
10685
-
10686
- Updates the configuration of a cluster to match the provided attributes and size. A cluster can be
10660
+ """Updates the configuration of a cluster to match the provided attributes and size. A cluster can be
10687
10661
  updated if it is in a `RUNNING` or `TERMINATED` state.
10688
10662
 
10689
10663
  If a cluster is updated while in a `RUNNING` state, it will be restarted so that the new attributes
@@ -11018,9 +10992,7 @@ class ClustersAPI:
11018
10992
  page_token: Optional[str] = None,
11019
10993
  start_time: Optional[int] = None,
11020
10994
  ) -> Iterator[ClusterEvent]:
11021
- """List cluster activity events.
11022
-
11023
- Retrieves a list of events about the activity of a cluster. This API is paginated. If there are more
10995
+ """Retrieves a list of events about the activity of a cluster. This API is paginated. If there are more
11024
10996
  events to read, the response includes all the parameters necessary to request the next page of events.
11025
10997
 
11026
10998
  :param cluster_id: str
@@ -11088,9 +11060,7 @@ class ClustersAPI:
11088
11060
  body = json["next_page"]
11089
11061
 
11090
11062
  def get(self, cluster_id: str) -> ClusterDetails:
11091
- """Get cluster info.
11092
-
11093
- Retrieves the information for a cluster given its identifier. Clusters can be described while they are
11063
+ """Retrieves the information for a cluster given its identifier. Clusters can be described while they are
11094
11064
  running, or up to 60 days after they are terminated.
11095
11065
 
11096
11066
  :param cluster_id: str
@@ -11110,9 +11080,7 @@ class ClustersAPI:
11110
11080
  return ClusterDetails.from_dict(res)
11111
11081
 
11112
11082
  def get_permission_levels(self, cluster_id: str) -> GetClusterPermissionLevelsResponse:
11113
- """Get cluster permission levels.
11114
-
11115
- Gets the permission levels that a user can have on an object.
11083
+ """Gets the permission levels that a user can have on an object.
11116
11084
 
11117
11085
  :param cluster_id: str
11118
11086
  The cluster for which to get or manage permissions.
@@ -11128,9 +11096,7 @@ class ClustersAPI:
11128
11096
  return GetClusterPermissionLevelsResponse.from_dict(res)
11129
11097
 
11130
11098
  def get_permissions(self, cluster_id: str) -> ClusterPermissions:
11131
- """Get cluster permissions.
11132
-
11133
- Gets the permissions of a cluster. Clusters can inherit permissions from their root object.
11099
+ """Gets the permissions of a cluster. Clusters can inherit permissions from their root object.
11134
11100
 
11135
11101
  :param cluster_id: str
11136
11102
  The cluster for which to get or manage permissions.
@@ -11153,9 +11119,7 @@ class ClustersAPI:
11153
11119
  page_token: Optional[str] = None,
11154
11120
  sort_by: Optional[ListClustersSortBy] = None,
11155
11121
  ) -> Iterator[ClusterDetails]:
11156
- """List clusters.
11157
-
11158
- Return information about all pinned and active clusters, and all clusters terminated within the last
11122
+ """Return information about all pinned and active clusters, and all clusters terminated within the last
11159
11123
  30 days. Clusters terminated prior to this period are not included.
11160
11124
 
11161
11125
  :param filter_by: :class:`ListClustersFilterBy` (optional)
@@ -11195,9 +11159,7 @@ class ClustersAPI:
11195
11159
  query["page_token"] = json["next_page_token"]
11196
11160
 
11197
11161
  def list_node_types(self) -> ListNodeTypesResponse:
11198
- """List node types.
11199
-
11200
- Returns a list of supported Spark node types. These node types can be used to launch a cluster.
11162
+ """Returns a list of supported Spark node types. These node types can be used to launch a cluster.
11201
11163
 
11202
11164
  :returns: :class:`ListNodeTypesResponse`
11203
11165
  """
@@ -11210,9 +11172,7 @@ class ClustersAPI:
11210
11172
  return ListNodeTypesResponse.from_dict(res)
11211
11173
 
11212
11174
  def list_zones(self) -> ListAvailableZonesResponse:
11213
- """List availability zones.
11214
-
11215
- Returns a list of availability zones where clusters can be created in (For example, us-west-2a). These
11175
+ """Returns a list of availability zones where clusters can be created in (For example, us-west-2a). These
11216
11176
  zones can be used to launch a cluster.
11217
11177
 
11218
11178
  :returns: :class:`ListAvailableZonesResponse`
@@ -11226,9 +11186,7 @@ class ClustersAPI:
11226
11186
  return ListAvailableZonesResponse.from_dict(res)
11227
11187
 
11228
11188
  def permanent_delete(self, cluster_id: str):
11229
- """Permanently delete cluster.
11230
-
11231
- Permanently deletes a Spark cluster. This cluster is terminated and resources are asynchronously
11189
+ """Permanently deletes a Spark cluster. This cluster is terminated and resources are asynchronously
11232
11190
  removed.
11233
11191
 
11234
11192
  In addition, users will no longer see permanently deleted clusters in the cluster list, and API users
@@ -11250,9 +11208,7 @@ class ClustersAPI:
11250
11208
  self._api.do("POST", "/api/2.1/clusters/permanent-delete", body=body, headers=headers)
11251
11209
 
11252
11210
  def pin(self, cluster_id: str):
11253
- """Pin cluster.
11254
-
11255
- Pinning a cluster ensures that the cluster will always be returned by the ListClusters API. Pinning a
11211
+ """Pinning a cluster ensures that the cluster will always be returned by the ListClusters API. Pinning a
11256
11212
  cluster that is already pinned will have no effect. This API can only be called by workspace admins.
11257
11213
 
11258
11214
  :param cluster_id: str
@@ -11272,9 +11228,7 @@ class ClustersAPI:
11272
11228
  def resize(
11273
11229
  self, cluster_id: str, *, autoscale: Optional[AutoScale] = None, num_workers: Optional[int] = None
11274
11230
  ) -> Wait[ClusterDetails]:
11275
- """Resize cluster.
11276
-
11277
- Resizes a cluster to have a desired number of workers. This will fail unless the cluster is in a
11231
+ """Resizes a cluster to have a desired number of workers. This will fail unless the cluster is in a
11278
11232
  `RUNNING` state.
11279
11233
 
11280
11234
  :param cluster_id: str
@@ -11324,9 +11278,7 @@ class ClustersAPI:
11324
11278
  return self.resize(autoscale=autoscale, cluster_id=cluster_id, num_workers=num_workers).result(timeout=timeout)
11325
11279
 
11326
11280
  def restart(self, cluster_id: str, *, restart_user: Optional[str] = None) -> Wait[ClusterDetails]:
11327
- """Restart cluster.
11328
-
11329
- Restarts a Spark cluster with the supplied ID. If the cluster is not currently in a `RUNNING` state,
11281
+ """Restarts a Spark cluster with the supplied ID. If the cluster is not currently in a `RUNNING` state,
11330
11282
  nothing will happen.
11331
11283
 
11332
11284
  :param cluster_id: str
@@ -11360,9 +11312,7 @@ class ClustersAPI:
11360
11312
  def set_permissions(
11361
11313
  self, cluster_id: str, *, access_control_list: Optional[List[ClusterAccessControlRequest]] = None
11362
11314
  ) -> ClusterPermissions:
11363
- """Set cluster permissions.
11364
-
11365
- Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct
11315
+ """Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct
11366
11316
  permissions if none are specified. Objects can inherit permissions from their root object.
11367
11317
 
11368
11318
  :param cluster_id: str
@@ -11383,9 +11333,7 @@ class ClustersAPI:
11383
11333
  return ClusterPermissions.from_dict(res)
11384
11334
 
11385
11335
  def spark_versions(self) -> GetSparkVersionsResponse:
11386
- """List available Spark versions.
11387
-
11388
- Returns the list of available Spark versions. These versions can be used to launch a cluster.
11336
+ """Returns the list of available Spark versions. These versions can be used to launch a cluster.
11389
11337
 
11390
11338
  :returns: :class:`GetSparkVersionsResponse`
11391
11339
  """
@@ -11398,9 +11346,7 @@ class ClustersAPI:
11398
11346
  return GetSparkVersionsResponse.from_dict(res)
11399
11347
 
11400
11348
  def start(self, cluster_id: str) -> Wait[ClusterDetails]:
11401
- """Start terminated cluster.
11402
-
11403
- Starts a terminated Spark cluster with the supplied ID. This works similar to `createCluster` except:
11349
+ """Starts a terminated Spark cluster with the supplied ID. This works similar to `createCluster` except:
11404
11350
  - The previous cluster id and attributes are preserved. - The cluster starts with the last specified
11405
11351
  cluster size. - If the previous cluster was an autoscaling cluster, the current cluster starts with
11406
11352
  the minimum number of nodes. - If the cluster is not currently in a ``TERMINATED`` state, nothing will
@@ -11430,9 +11376,7 @@ class ClustersAPI:
11430
11376
  return self.start(cluster_id=cluster_id).result(timeout=timeout)
11431
11377
 
11432
11378
  def unpin(self, cluster_id: str):
11433
- """Unpin cluster.
11434
-
11435
- Unpinning a cluster will allow the cluster to eventually be removed from the ListClusters API.
11379
+ """Unpinning a cluster will allow the cluster to eventually be removed from the ListClusters API.
11436
11380
  Unpinning a cluster that is not pinned will have no effect. This API can only be called by workspace
11437
11381
  admins.
11438
11382
 
@@ -11453,9 +11397,7 @@ class ClustersAPI:
11453
11397
  def update(
11454
11398
  self, cluster_id: str, update_mask: str, *, cluster: Optional[UpdateClusterResource] = None
11455
11399
  ) -> Wait[ClusterDetails]:
11456
- """Update cluster configuration (partial).
11457
-
11458
- Updates the configuration of a cluster to match the partial set of attributes and size. Denote which
11400
+ """Updates the configuration of a cluster to match the partial set of attributes and size. Denote which
11459
11401
  fields to update using the `update_mask` field in the request body. A cluster can be updated if it is
11460
11402
  in a `RUNNING` or `TERMINATED` state. If a cluster is updated while in a `RUNNING` state, it will be
11461
11403
  restarted so that the new attributes can take effect. If a cluster is updated while in a `TERMINATED`
@@ -11516,9 +11458,7 @@ class ClustersAPI:
11516
11458
  def update_permissions(
11517
11459
  self, cluster_id: str, *, access_control_list: Optional[List[ClusterAccessControlRequest]] = None
11518
11460
  ) -> ClusterPermissions:
11519
- """Update cluster permissions.
11520
-
11521
- Updates the permissions on a cluster. Clusters can inherit permissions from their root object.
11461
+ """Updates the permissions on a cluster. Clusters can inherit permissions from their root object.
11522
11462
 
11523
11463
  :param cluster_id: str
11524
11464
  The cluster for which to get or manage permissions.
@@ -11657,9 +11597,7 @@ class CommandExecutionAPI:
11657
11597
  def cancel(
11658
11598
  self, *, cluster_id: Optional[str] = None, command_id: Optional[str] = None, context_id: Optional[str] = None
11659
11599
  ) -> Wait[CommandStatusResponse]:
11660
- """Cancel a command.
11661
-
11662
- Cancels a currently running command within an execution context.
11600
+ """Cancels a currently running command within an execution context.
11663
11601
 
11664
11602
  The command ID is obtained from a prior successful call to __execute__.
11665
11603
 
@@ -11703,9 +11641,7 @@ class CommandExecutionAPI:
11703
11641
  return self.cancel(cluster_id=cluster_id, command_id=command_id, context_id=context_id).result(timeout=timeout)
11704
11642
 
11705
11643
  def command_status(self, cluster_id: str, context_id: str, command_id: str) -> CommandStatusResponse:
11706
- """Get command info.
11707
-
11708
- Gets the status of and, if available, the results from a currently executing command.
11644
+ """Gets the status of and, if available, the results from a currently executing command.
11709
11645
 
11710
11646
  The command ID is obtained from a prior successful call to __execute__.
11711
11647
 
@@ -11731,9 +11667,7 @@ class CommandExecutionAPI:
11731
11667
  return CommandStatusResponse.from_dict(res)
11732
11668
 
11733
11669
  def context_status(self, cluster_id: str, context_id: str) -> ContextStatusResponse:
11734
- """Get status.
11735
-
11736
- Gets the status for an execution context.
11670
+ """Gets the status for an execution context.
11737
11671
 
11738
11672
  :param cluster_id: str
11739
11673
  :param context_id: str
@@ -11756,9 +11690,7 @@ class CommandExecutionAPI:
11756
11690
  def create(
11757
11691
  self, *, cluster_id: Optional[str] = None, language: Optional[Language] = None
11758
11692
  ) -> Wait[ContextStatusResponse]:
11759
- """Create an execution context.
11760
-
11761
- Creates an execution context for running cluster commands.
11693
+ """Creates an execution context for running cluster commands.
11762
11694
 
11763
11695
  If successful, this method returns the ID of the new execution context.
11764
11696
 
@@ -11794,9 +11726,7 @@ class CommandExecutionAPI:
11794
11726
  return self.create(cluster_id=cluster_id, language=language).result(timeout=timeout)
11795
11727
 
11796
11728
  def destroy(self, cluster_id: str, context_id: str):
11797
- """Delete an execution context.
11798
-
11799
- Deletes an execution context.
11729
+ """Deletes an execution context.
11800
11730
 
11801
11731
  :param cluster_id: str
11802
11732
  :param context_id: str
@@ -11823,9 +11753,7 @@ class CommandExecutionAPI:
11823
11753
  context_id: Optional[str] = None,
11824
11754
  language: Optional[Language] = None,
11825
11755
  ) -> Wait[CommandStatusResponse]:
11826
- """Run a command.
11827
-
11828
- Runs a cluster command in the given execution context, using the provided language.
11756
+ """Runs a cluster command in the given execution context, using the provided language.
11829
11757
 
11830
11758
  If successful, it returns an ID for tracking the status of the command's execution.
11831
11759
 
@@ -11893,9 +11821,7 @@ class GlobalInitScriptsAPI:
11893
11821
  def create(
11894
11822
  self, name: str, script: str, *, enabled: Optional[bool] = None, position: Optional[int] = None
11895
11823
  ) -> CreateResponse:
11896
- """Create init script.
11897
-
11898
- Creates a new global init script in this workspace.
11824
+ """Creates a new global init script in this workspace.
11899
11825
 
11900
11826
  :param name: str
11901
11827
  The name of the script
@@ -11934,9 +11860,7 @@ class GlobalInitScriptsAPI:
11934
11860
  return CreateResponse.from_dict(res)
11935
11861
 
11936
11862
  def delete(self, script_id: str):
11937
- """Delete init script.
11938
-
11939
- Deletes a global init script.
11863
+ """Deletes a global init script.
11940
11864
 
11941
11865
  :param script_id: str
11942
11866
  The ID of the global init script.
@@ -11951,9 +11875,7 @@ class GlobalInitScriptsAPI:
11951
11875
  self._api.do("DELETE", f"/api/2.0/global-init-scripts/{script_id}", headers=headers)
11952
11876
 
11953
11877
  def get(self, script_id: str) -> GlobalInitScriptDetailsWithContent:
11954
- """Get an init script.
11955
-
11956
- Gets all the details of a script, including its Base64-encoded contents.
11878
+ """Gets all the details of a script, including its Base64-encoded contents.
11957
11879
 
11958
11880
  :param script_id: str
11959
11881
  The ID of the global init script.
@@ -11969,9 +11891,7 @@ class GlobalInitScriptsAPI:
11969
11891
  return GlobalInitScriptDetailsWithContent.from_dict(res)
11970
11892
 
11971
11893
  def list(self) -> Iterator[GlobalInitScriptDetails]:
11972
- """Get init scripts.
11973
-
11974
- Get a list of all global init scripts for this workspace. This returns all properties for each script
11894
+ """Get a list of all global init scripts for this workspace. This returns all properties for each script
11975
11895
  but **not** the script contents. To retrieve the contents of a script, use the [get a global init
11976
11896
  script](:method:globalinitscripts/get) operation.
11977
11897
 
@@ -11989,9 +11909,7 @@ class GlobalInitScriptsAPI:
11989
11909
  def update(
11990
11910
  self, script_id: str, name: str, script: str, *, enabled: Optional[bool] = None, position: Optional[int] = None
11991
11911
  ):
11992
- """Update init script.
11993
-
11994
- Updates a global init script, specifying only the fields to change. All fields are optional.
11912
+ """Updates a global init script, specifying only the fields to change. All fields are optional.
11995
11913
  Unspecified fields retain their current value.
11996
11914
 
11997
11915
  :param script_id: str
@@ -12068,9 +11986,7 @@ class InstancePoolsAPI:
12068
11986
  preloaded_docker_images: Optional[List[DockerImage]] = None,
12069
11987
  preloaded_spark_versions: Optional[List[str]] = None,
12070
11988
  ) -> CreateInstancePoolResponse:
12071
- """Create a new instance pool.
12072
-
12073
- Creates a new instance pool using idle and ready-to-use cloud instances.
11989
+ """Creates a new instance pool using idle and ready-to-use cloud instances.
12074
11990
 
12075
11991
  :param instance_pool_name: str
12076
11992
  Pool name requested by the user. Pool name must be unique. Length must be between 1 and 100
@@ -12157,9 +12073,7 @@ class InstancePoolsAPI:
12157
12073
  return CreateInstancePoolResponse.from_dict(res)
12158
12074
 
12159
12075
  def delete(self, instance_pool_id: str):
12160
- """Delete an instance pool.
12161
-
12162
- Deletes the instance pool permanently. The idle instances in the pool are terminated asynchronously.
12076
+ """Deletes the instance pool permanently. The idle instances in the pool are terminated asynchronously.
12163
12077
 
12164
12078
  :param instance_pool_id: str
12165
12079
  The instance pool to be terminated.
@@ -12187,9 +12101,7 @@ class InstancePoolsAPI:
12187
12101
  max_capacity: Optional[int] = None,
12188
12102
  min_idle_instances: Optional[int] = None,
12189
12103
  ):
12190
- """Edit an existing instance pool.
12191
-
12192
- Modifies the configuration of an existing instance pool.
12104
+ """Modifies the configuration of an existing instance pool.
12193
12105
 
12194
12106
  :param instance_pool_id: str
12195
12107
  Instance pool ID
@@ -12244,9 +12156,7 @@ class InstancePoolsAPI:
12244
12156
  self._api.do("POST", "/api/2.0/instance-pools/edit", body=body, headers=headers)
12245
12157
 
12246
12158
  def get(self, instance_pool_id: str) -> GetInstancePool:
12247
- """Get instance pool information.
12248
-
12249
- Retrieve the information for an instance pool based on its identifier.
12159
+ """Retrieve the information for an instance pool based on its identifier.
12250
12160
 
12251
12161
  :param instance_pool_id: str
12252
12162
  The canonical unique identifier for the instance pool.
@@ -12265,9 +12175,7 @@ class InstancePoolsAPI:
12265
12175
  return GetInstancePool.from_dict(res)
12266
12176
 
12267
12177
  def get_permission_levels(self, instance_pool_id: str) -> GetInstancePoolPermissionLevelsResponse:
12268
- """Get instance pool permission levels.
12269
-
12270
- Gets the permission levels that a user can have on an object.
12178
+ """Gets the permission levels that a user can have on an object.
12271
12179
 
12272
12180
  :param instance_pool_id: str
12273
12181
  The instance pool for which to get or manage permissions.
@@ -12285,9 +12193,7 @@ class InstancePoolsAPI:
12285
12193
  return GetInstancePoolPermissionLevelsResponse.from_dict(res)
12286
12194
 
12287
12195
  def get_permissions(self, instance_pool_id: str) -> InstancePoolPermissions:
12288
- """Get instance pool permissions.
12289
-
12290
- Gets the permissions of an instance pool. Instance pools can inherit permissions from their root
12196
+ """Gets the permissions of an instance pool. Instance pools can inherit permissions from their root
12291
12197
  object.
12292
12198
 
12293
12199
  :param instance_pool_id: str
@@ -12304,9 +12210,7 @@ class InstancePoolsAPI:
12304
12210
  return InstancePoolPermissions.from_dict(res)
12305
12211
 
12306
12212
  def list(self) -> Iterator[InstancePoolAndStats]:
12307
- """List instance pool info.
12308
-
12309
- Gets a list of instance pools with their statistics.
12213
+ """Gets a list of instance pools with their statistics.
12310
12214
 
12311
12215
  :returns: Iterator over :class:`InstancePoolAndStats`
12312
12216
  """
@@ -12322,9 +12226,7 @@ class InstancePoolsAPI:
12322
12226
  def set_permissions(
12323
12227
  self, instance_pool_id: str, *, access_control_list: Optional[List[InstancePoolAccessControlRequest]] = None
12324
12228
  ) -> InstancePoolPermissions:
12325
- """Set instance pool permissions.
12326
-
12327
- Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct
12229
+ """Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct
12328
12230
  permissions if none are specified. Objects can inherit permissions from their root object.
12329
12231
 
12330
12232
  :param instance_pool_id: str
@@ -12347,9 +12249,7 @@ class InstancePoolsAPI:
12347
12249
  def update_permissions(
12348
12250
  self, instance_pool_id: str, *, access_control_list: Optional[List[InstancePoolAccessControlRequest]] = None
12349
12251
  ) -> InstancePoolPermissions:
12350
- """Update instance pool permissions.
12351
-
12352
- Updates the permissions on an instance pool. Instance pools can inherit permissions from their root
12252
+ """Updates the permissions on an instance pool. Instance pools can inherit permissions from their root
12353
12253
  object.
12354
12254
 
12355
12255
  :param instance_pool_id: str
@@ -12391,9 +12291,7 @@ class InstanceProfilesAPI:
12391
12291
  is_meta_instance_profile: Optional[bool] = None,
12392
12292
  skip_validation: Optional[bool] = None,
12393
12293
  ):
12394
- """Register an instance profile.
12395
-
12396
- Registers an instance profile in Databricks. In the UI, you can then give users the permission to use
12294
+ """Registers an instance profile in Databricks. In the UI, you can then give users the permission to use
12397
12295
  this instance profile when launching clusters.
12398
12296
 
12399
12297
  This API is only available to admin users.
@@ -12445,9 +12343,7 @@ class InstanceProfilesAPI:
12445
12343
  iam_role_arn: Optional[str] = None,
12446
12344
  is_meta_instance_profile: Optional[bool] = None,
12447
12345
  ):
12448
- """Edit an instance profile.
12449
-
12450
- The only supported field to change is the optional IAM role ARN associated with the instance profile.
12346
+ """The only supported field to change is the optional IAM role ARN associated with the instance profile.
12451
12347
  It is required to specify the IAM role ARN if both of the following are true:
12452
12348
 
12453
12349
  * Your role name and instance profile name do not match. The name is the part after the last slash in
@@ -12493,9 +12389,7 @@ class InstanceProfilesAPI:
12493
12389
  self._api.do("POST", "/api/2.0/instance-profiles/edit", body=body, headers=headers)
12494
12390
 
12495
12391
  def list(self) -> Iterator[InstanceProfile]:
12496
- """List available instance profiles.
12497
-
12498
- List the instance profiles that the calling user can use to launch a cluster.
12392
+ """List the instance profiles that the calling user can use to launch a cluster.
12499
12393
 
12500
12394
  This API is available to all users.
12501
12395
 
@@ -12511,9 +12405,7 @@ class InstanceProfilesAPI:
12511
12405
  return parsed if parsed is not None else []
12512
12406
 
12513
12407
  def remove(self, instance_profile_arn: str):
12514
- """Remove the instance profile.
12515
-
12516
- Remove the instance profile with the provided ARN. Existing clusters with this instance profile will
12408
+ """Remove the instance profile with the provided ARN. Existing clusters with this instance profile will
12517
12409
  continue to function.
12518
12410
 
12519
12411
  This API is only accessible to admin users.
@@ -12553,9 +12445,7 @@ class LibrariesAPI:
12553
12445
  self._api = api_client
12554
12446
 
12555
12447
  def all_cluster_statuses(self) -> Iterator[ClusterLibraryStatuses]:
12556
- """Get all statuses.
12557
-
12558
- Get the status of all libraries on all clusters. A status is returned for all libraries installed on
12448
+ """Get the status of all libraries on all clusters. A status is returned for all libraries installed on
12559
12449
  this cluster via the API or the libraries UI.
12560
12450
 
12561
12451
  :returns: Iterator over :class:`ClusterLibraryStatuses`
@@ -12570,9 +12460,7 @@ class LibrariesAPI:
12570
12460
  return parsed if parsed is not None else []
12571
12461
 
12572
12462
  def cluster_status(self, cluster_id: str) -> Iterator[LibraryFullStatus]:
12573
- """Get status.
12574
-
12575
- Get the status of libraries on a cluster. A status is returned for all libraries installed on this
12463
+ """Get the status of libraries on a cluster. A status is returned for all libraries installed on this
12576
12464
  cluster via the API or the libraries UI. The order of returned libraries is as follows: 1. Libraries
12577
12465
  set to be installed on this cluster, in the order that the libraries were added to the cluster, are
12578
12466
  returned first. 2. Libraries that were previously requested to be installed on this cluster or, but
@@ -12596,9 +12484,7 @@ class LibrariesAPI:
12596
12484
  return parsed if parsed is not None else []
12597
12485
 
12598
12486
  def install(self, cluster_id: str, libraries: List[Library]):
12599
- """Add a library.
12600
-
12601
- Add libraries to install on a cluster. The installation is asynchronous; it happens in the background
12487
+ """Add libraries to install on a cluster. The installation is asynchronous; it happens in the background
12602
12488
  after the completion of this request.
12603
12489
 
12604
12490
  :param cluster_id: str
@@ -12621,9 +12507,7 @@ class LibrariesAPI:
12621
12507
  self._api.do("POST", "/api/2.0/libraries/install", body=body, headers=headers)
12622
12508
 
12623
12509
  def uninstall(self, cluster_id: str, libraries: List[Library]):
12624
- """Uninstall libraries.
12625
-
12626
- Set libraries to uninstall from a cluster. The libraries won't be uninstalled until the cluster is
12510
+ """Set libraries to uninstall from a cluster. The libraries won't be uninstalled until the cluster is
12627
12511
  restarted. A request to uninstall a library that is not currently installed is ignored.
12628
12512
 
12629
12513
  :param cluster_id: str
@@ -12662,9 +12546,7 @@ class PolicyComplianceForClustersAPI:
12662
12546
  def enforce_compliance(
12663
12547
  self, cluster_id: str, *, validate_only: Optional[bool] = None
12664
12548
  ) -> EnforceClusterComplianceResponse:
12665
- """Enforce cluster policy compliance.
12666
-
12667
- Updates a cluster to be compliant with the current version of its policy. A cluster can be updated if
12549
+ """Updates a cluster to be compliant with the current version of its policy. A cluster can be updated if
12668
12550
  it is in a `RUNNING` or `TERMINATED` state.
12669
12551
 
12670
12552
  If a cluster is updated while in a `RUNNING` state, it will be restarted so that the new attributes
@@ -12698,9 +12580,7 @@ class PolicyComplianceForClustersAPI:
12698
12580
  return EnforceClusterComplianceResponse.from_dict(res)
12699
12581
 
12700
12582
  def get_compliance(self, cluster_id: str) -> GetClusterComplianceResponse:
12701
- """Get cluster policy compliance.
12702
-
12703
- Returns the policy compliance status of a cluster. Clusters could be out of compliance if their policy
12583
+ """Returns the policy compliance status of a cluster. Clusters could be out of compliance if their policy
12704
12584
  was updated after the cluster was last edited.
12705
12585
 
12706
12586
  :param cluster_id: str
@@ -12722,9 +12602,7 @@ class PolicyComplianceForClustersAPI:
12722
12602
  def list_compliance(
12723
12603
  self, policy_id: str, *, page_size: Optional[int] = None, page_token: Optional[str] = None
12724
12604
  ) -> Iterator[ClusterCompliance]:
12725
- """List cluster policy compliance.
12726
-
12727
- Returns the policy compliance status of all clusters that use a given policy. Clusters could be out of
12605
+ """Returns the policy compliance status of all clusters that use a given policy. Clusters could be out of
12728
12606
  compliance if their policy was updated after the cluster was last edited.
12729
12607
 
12730
12608
  :param policy_id: str
@@ -12775,9 +12653,7 @@ class PolicyFamiliesAPI:
12775
12653
  self._api = api_client
12776
12654
 
12777
12655
  def get(self, policy_family_id: str, *, version: Optional[int] = None) -> PolicyFamily:
12778
- """Get policy family information.
12779
-
12780
- Retrieve the information for an policy family based on its identifier and version
12656
+ """Retrieve the information for an policy family based on its identifier and version
12781
12657
 
12782
12658
  :param policy_family_id: str
12783
12659
  The family ID about which to retrieve information.
@@ -12798,9 +12674,7 @@ class PolicyFamiliesAPI:
12798
12674
  return PolicyFamily.from_dict(res)
12799
12675
 
12800
12676
  def list(self, *, max_results: Optional[int] = None, page_token: Optional[str] = None) -> Iterator[PolicyFamily]:
12801
- """List policy families.
12802
-
12803
- Returns the list of policy definition types available to use at their latest version. This API is
12677
+ """Returns the list of policy definition types available to use at their latest version. This API is
12804
12678
  paginated.
12805
12679
 
12806
12680
  :param max_results: int (optional)