Skip to content

Starts a notebook sync in Amazon SageMaker Unified Studio

Description

Starts a notebook sync in Amazon SageMaker Unified Studio. This operation syncs a notebook from a Git repository into a project.

Usage

datazone_start_notebook_sync(domainIdentifier, owningProjectIdentifier,
  sourceLocation, gitMetadata, notebookId, name, description, clientToken)

Arguments

  • domainIdentifier

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

  • owningProjectIdentifier

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

  • sourceLocation

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

  • gitMetadata

The Git metadata for the notebook sync, including repository, branch, and commit information.

  • notebookId

The identifier of an existing notebook to sync. If not specified, a new notebook is created.

  • name

The name of the notebook. The name must be between 1 and 256 characters.

  • description

The description of 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(
  notebookId = "string",
  status = "ACTIVE"|"ARCHIVED"|"SYNC_IN_PROGRESS"|"SYNC_FAILED",
  domainId = "string",
  owningProjectId = "string",
  sourceLocation = list(
    s3 = "string"
  ),
  gitMetadata = list(
    connectionId = "string",
    repository = "string",
    branch = "string",
    commitHash = "string",
    fileName = "string",
    committedAt = as.POSIXct(
      "2015-01-01"
    ),
    commitMessage = "string"
  ),
  name = "string",
  description = "string",
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  createdBy = "string"
)

Request syntax

svc$start_notebook_sync(
  domainIdentifier = "string",
  owningProjectIdentifier = "string",
  sourceLocation = list(
    s3 = "string"
  ),
  gitMetadata = list(
    connectionId = "string",
    repository = "string",
    branch = "string",
    commitHash = "string",
    fileName = "string",
    committedAt = as.POSIXct(
      "2015-01-01"
    ),
    commitMessage = "string"
  ),
  notebookId = "string",
  name = "string",
  description = "string",
  clientToken = "string"
)