Datalabs

APIs related to Datalabs.

📄️ List accessible datalabs

Returns the datalabs the caller has access to, with their current status and access level. With action set, returns the available instance types and their prices for that kind of datalab instead.

📄️ Create a datalab

Creates a notebook or studio datalab. Compute, resource access and additional settings are optional and fall back to defaults. Creation runs in the background - poll the get-by-id operation until the status becomes InService.

📄️ Get datalab details

Returns a datalab's configuration and current status. Requires read-only access or higher. For a studio datalab, DatalabURL carries a sign-in URL once both the datalab and the caller's own workspace are in service. When the caller is missing dataset or domain access, DatalabURL is omitted and Message explains what is missing.

📄️ Update, start or stop a datalab

Updates a datalab's description, compute, resource access or additional settings. With operation set, starts or stops a notebook datalab instead - start needs it stopped or failed and stop needs it running. A studio datalab cannot be updated while it is pending, deleting or failed. Requires editor access or higher.

📄️ 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.

📄️ 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.

📄️ Get notebook datalab logs

Returns a page of log output for a notebook datalab. Choose which logs to read with serviceloggroup. Defaults to the last 24 hours when no time range is given.

📄️ Get notebook datalab logs page by page

Returns a page of log output for a notebook datalab, using the time range in the request body. Send the nextToken from a previous response to fetch the following page; when a response has no nextToken there are no more pages.

📄️ List interactive sessions on a datalab

Returns the interactive sessions running under the datalab's service role. Applies to both notebook and studio datalabs; the list is empty when none are running.

📄️ Stop an interactive session

Stops a running interactive session on a notebook datalab. Requires editor access or higher.

📄️ Delete an interactive session

Deletes an interactive session from a notebook datalab. Requires owner access.

📄️ Get resources attached to a datalab

Returns the datasets, domains and parameters attached to a datalab beyond its own configuration, with the state of the most recent access update.

📄️ Update resources attached to a datalab

Replaces the datasets, domains and parameters attached to a datalab. The change is applied in the background - poll the GET operation until the status shows it has completed, as a further update is rejected while one is still in progress. Requires editor access or higher.

📄️ List datalab lifecycle configurations

Returns the lifecycle configurations the caller has access to, together with the built-in ones supplied with the platform. Startup scripts are omitted from the listing - use the get-by-id operation to retrieve them.

📄️ Create a datalab lifecycle configuration

Creates a lifecycle configuration whose startup script runs on the datalabs it is attached to. Notebook configurations accept an on-create and an on-start script; studio configurations require an on-start script.

📄️ Get datalab lifecycle configuration details

Returns a lifecycle configuration, including its startup scripts. With action=get_dependent_resources, returns the datalabs currently using it instead.

📄️ Update datalab lifecycle configuration

Updates a lifecycle configuration's scripts, description or keywords. Configurations for studio datalabs cannot be updated. With operation set, enables or disables a built-in configuration instead, ignoring the contents of the request body though a body must still be sent; one still attached to a datalab cannot be disabled.

📄️ Delete a datalab lifecycle configuration

Deletes a lifecycle configuration. Rejected while any datalab still uses it, and the response then lists those datalabs. Requires owner access.