Skip to content

Start Notebook Import

datazone_start_notebook_import R Documentation

Starts a notebook import in Amazon SageMaker Unified Studio

Description

Starts a notebook import in Amazon SageMaker Unified Studio. This operation imports a notebook from an Amazon Simple Storage Service location into a project.

Usage

datazone_start_notebook_import(domainIdentifier,
  owningProjectIdentifier, sourceLocation, name, description, clientToken)

Arguments

domainIdentifier

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

owningProjectIdentifier

[required] The identifier of the project that will own the imported notebook.

sourceLocation

[required] The source location of the notebook to import. This specifies the Amazon Simple Storage Service URI of the notebook file.

name

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

description

The description of the imported 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(
  notebookId = "string",
  status = "ACTIVE"|"ARCHIVED",
  domainId = "string",
  owningProjectId = "string",
  name = "string",
  description = "string",
  sourceLocation = list(
    s3 = "string"
  ),
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  createdBy = "string"
)

Request syntax

svc$start_notebook_import(
  domainIdentifier = "string",
  owningProjectIdentifier = "string",
  sourceLocation = list(
    s3 = "string"
  ),
  name = "string",
  description = "string",
  clientToken = "string"
)