Updates a notebook in Amazon SageMaker Unified Studio¶

Description¶

Updates a notebook in Amazon SageMaker Unified Studio.

Usage¶

datazone_update_notebook(domainIdentifier, identifier, description,
  status, name, cellOrder, type, metadata, parameters,
  environmentConfiguration, clientToken)

Arguments¶

domainIdentifier

[required] The identifier of the Amazon SageMaker Unified Studio domain in which the notebook exists.
identifier

[required] The identifier of the notebook to update.
description

The updated description of the notebook.
status

The updated status of the notebook.
name

The updated name of the notebook.
cellOrder

The updated ordered list of cells in the notebook.
type

The updated type of the notebook.
metadata

The updated metadata for the notebook, specified as key-value pairs.
parameters

The updated sensitive parameters for the notebook, specified as key-value pairs.
environmentConfiguration

The updated environment configuration for the notebook.
clientToken

A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

Value¶

A list with the following syntax:

list(
  id = "string",
  name = "string",
  owningProjectId = "string",
  domainId = "string",
  cellOrder = list(
    list()
  ),
  status = "ACTIVE"|"ARCHIVED"|"SYNC_IN_PROGRESS"|"SYNC_FAILED",
  type = "DATA"|"SQL",
  description = "string",
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  createdBy = "string",
  updatedAt = as.POSIXct(
    "2015-01-01"
  ),
  updatedBy = "string",
  lockedBy = "string",
  lockedAt = as.POSIXct(
    "2015-01-01"
  ),
  lockExpiresAt = as.POSIXct(
    "2015-01-01"
  ),
  computeId = "string",
  metadata = list(
    "string"
  ),
  parameters = list(
    "string"
  ),
  environmentConfiguration = list(
    imageVersion = "string",
    packageConfig = list(
      packageManager = "UV",
      packageSpecification = "string"
    )
  ),
  error = list(
    message = "string"
  ),
  gitMetadata = list(
    connectionId = "string",
    repository = "string",
    branch = "string",
    commitHash = "string",
    fileName = "string",
    committedAt = as.POSIXct(
      "2015-01-01"
    ),
    commitMessage = "string"
  )
)

Request syntax¶

svc$update_notebook(
  domainIdentifier = "string",
  identifier = "string",
  description = "string",
  status = "ACTIVE"|"ARCHIVED"|"SYNC_IN_PROGRESS"|"SYNC_FAILED",
  name = "string",
  cellOrder = list(
    list()
  ),
  type = "DATA"|"SQL",
  metadata = list(
    "string"
  ),
  parameters = list(
    "string"
  ),
  environmentConfiguration = list(
    imageVersion = "string",
    packageConfig = list(
      packageManager = "UV",
      packageSpecification = "string"
    )
  ),
  clientToken = "string"
)