list_datalabs_apps

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

List apps in a studio datalab

Returns the apps in a studio datalab, such as JupyterLab and RStudio, each with a sign-in URL. When an app is not running, or the caller is missing dataset or domain permissions, the URL is returned as the literal N/A and a message explains why.

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:

StudioAppsList

Returns:

Returns the result object.

Request and Response Examples

HTTP: GET /datalabs/{id}/apps

Success (HTTP 200)

200 response

App in service with a sign-in URL

{
  "StudioApps": [
    {
      "StudioAppName": "jupyterlab-jdoe",
      "StudioAppType": "JupyterLab",
      "StudioAppStatus": "InService",
      "SpaceName": "jdoe-space",
      "URL": "https://studio-abc123.studio.us-east-1.sagemaker.aws/jupyterlab/default",
      "CreatedBy": "jdoe",
      "CreationTime": "2026-08-01 09:20:00"
    }
  ]
}

App not running, or access missing - URL is the literal N/A

{
  "StudioApps": [
    {
      "StudioAppName": "rstudio-jdoe",
      "StudioAppType": "RStudio",
      "StudioAppStatus": "Stopped",
      "URL": "N/A",
      "Message": "Kindly update the datalab and try again in a while"
    }
  ]
}

Errors

Documented error codes: IPV-1016, AUTH-1002.

HTTP 400

Invalid input parameters

Datalab is not a studio datalab

{
  "Message": "IPV-1016 - Unsupported Datalab type - sagemaker-notebook."
}

Caller has no access on the datalab

{
  "Message": "AUTH-1002 - User action is not permitted"
}

HTTP 500

Something went wrong at backend

Request / response example

{
  "Message": "An error occurred (ThrottlingException) when calling the DescribeNotebookInstance operation (reached max retries: 4): Rate exceeded"
}