Skip to content

Get Notebook Run

datazone_get_notebook_run R Documentation

Gets the details of a notebook run in Amazon SageMaker Unified Studio

Description

Gets the details of a notebook run in Amazon SageMaker Unified Studio.

Usage

datazone_get_notebook_run(domainIdentifier, identifier)

Arguments

domainIdentifier

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

identifier

[required] The identifier of the notebook run.

Value

A list with the following syntax:

list(
  id = "string",
  domainId = "string",
  owningProjectId = "string",
  notebookId = "string",
  scheduleId = "string",
  status = "QUEUED"|"STARTING"|"RUNNING"|"STOPPING"|"STOPPED"|"SUCCEEDED"|"FAILED",
  cellOrder = list(
    list()
  ),
  metadata = list(
    "string"
  ),
  parameters = list(
    "string"
  ),
  computeConfiguration = list(
    instanceType = "string",
    environmentVersion = "string"
  ),
  networkConfiguration = list(
    networkAccessType = "PUBLIC_INTERNET_ONLY"|"VPC_ONLY",
    vpcId = "string",
    subnetIds = list(
      "string"
    ),
    securityGroupIds = list(
      "string"
    )
  ),
  timeoutConfiguration = list(
    runTimeoutInMinutes = 123
  ),
  environmentConfiguration = list(
    imageVersion = "string",
    packageConfig = list(
      packageManager = "UV",
      packageSpecification = "string"
    )
  ),
  storageConfiguration = list(
    projectS3Path = "string",
    kmsKeyArn = "string"
  ),
  triggerSource = list(
    type = "MANUAL"|"SCHEDULED"|"WORKFLOW",
    name = "string"
  ),
  error = list(
    message = "string"
  ),
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  createdBy = "string",
  updatedAt = as.POSIXct(
    "2015-01-01"
  ),
  updatedBy = "string",
  startedAt = as.POSIXct(
    "2015-01-01"
  ),
  completedAt = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$get_notebook_run(
  domainIdentifier = "string",
  identifier = "string"
)