Start Notebook Export

datazone_start_notebook_export

R Documentation

Starts a notebook export in Amazon SageMaker Unified Studio¶

Description¶

Starts a notebook export in Amazon SageMaker Unified Studio. This operation exports a notebook to a specified file format and stores the output in Amazon Simple Storage Service.

Usage¶

datazone_start_notebook_export(domainIdentifier, notebookIdentifier,
  owningProjectIdentifier, fileFormat, clientToken)

Arguments¶

domainIdentifier

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

notebookIdentifier

[required] The identifier of the notebook to export.

owningProjectIdentifier

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

fileFormat

[required] The file format for the notebook export. Valid values are PDF and IPYNB.

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",
  domainId = "string",
  owningProjectId = "string",
  notebookId = "string",
  fileFormat = "PDF"|"IPYNB",
  status = "IN_PROGRESS"|"SUCCEEDED"|"FAILED",
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  createdBy = "string"
)

Request syntax¶

svc$start_notebook_export(
  domainIdentifier = "string",
  notebookIdentifier = "string",
  owningProjectIdentifier = "string",
  fileFormat = "PDF"|"IPYNB",
  clientToken = "string"
)