Creates a notebook in Amazon SageMaker Unified Studio¶

Description¶

Creates a notebook in Amazon SageMaker Unified Studio. A notebook is a collaborative document within a project that contains code cells for interactive computing.

Usage¶

datazone_create_notebook(domainIdentifier, owningProjectIdentifier,
  name, description, type, metadata, parameters, clientToken)

Arguments¶

domainIdentifier

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

[required] The identifier of the project that owns the notebook.
name

[required] The name of the notebook. The name must be between 1 and 256 characters.
description

The description of the notebook.
type

The type of the notebook.
metadata

The metadata for the notebook, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.
parameters

The sensitive parameters for the notebook, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.
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$create_notebook(
  domainIdentifier = "string",
  owningProjectIdentifier = "string",
  name = "string",
  description = "string",
  type = "DATA"|"SQL",
  metadata = list(
    "string"
  ),
  parameters = list(
    "string"
  ),
  clientToken = "string"
)