delete_datalab

DatalabsApi.delete_datalab(id, role_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Delete a datalab

Deletes a datalab and the resources created for it. A studio datalab can only be deleted once it is in service or has failed. Requires owner access and cannot be undone.

Parameters:

  • id (str) – Identifier of the datalab. (required)

  • role_id (str) – User role id (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

DeleteDatalabResponse

Returns:

Returns the result object.

Request and Response Examples

HTTP: DELETE /datalabs/{id}

Success (HTTP 200)

200 response

Request / response example

{
  "Message": "Data Lab deletion triggered."
}

Errors

Documented error codes: IPV-1002, STU-1004.

HTTP 400

Missing required request parameters

DatalabId does not exist

{
  "Message": "IPV-1002 - Invalid DatalabId - b1e6c2a0-9f4d-4c7a-8f2e-1a2b3c4d5e6f, resource not found."
}

Datalab is mid-transition

{
  "Message": "STU-1004 - Cannot delete datalab as it is in Deleting state"
}

HTTP 500

Something went wrong at backend

Request / response example

{
  "Message": "Sessions were not deleted, hence Notebook deletion did not complete. Try Again"
}