Starts a notebook run in Amazon SageMaker Unified Studio¶

Description¶

Starts a notebook run in Amazon SageMaker Unified Studio. A notebook run represents the execution of an Amazon SageMaker notebook within a project. You can configure compute, network, timeout, and environment settings for the run.

Usage¶

datazone_start_notebook_run(domainIdentifier, owningProjectIdentifier,
  notebookIdentifier, scheduleIdentifier, computeConfiguration,
  networkConfiguration, timeoutConfiguration, notificationConfiguration,
  triggerSource, metadata, parameters, clientToken)

Arguments¶

domainIdentifier

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

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

[required] The identifier of the notebook to run.
scheduleIdentifier

The identifier of the schedule associated with the notebook run.
computeConfiguration

The compute configuration for the notebook run, including instance type and environment version.
networkConfiguration

The network configuration for the notebook run, including network access type and optional VPC settings.
timeoutConfiguration

The timeout configuration for the notebook run. The default timeout is 720 minutes (12 hours) and the maximum is 1440 minutes (24 hours).
notificationConfiguration

The notification configuration for the notebook run. Use this to specify the notebook run states that trigger notifications.
triggerSource

The source that triggered the notebook run.
metadata

The metadata for the notebook run, 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 run, 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",
  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"
  ),
  notificationConfiguration = list(
    notifyOn = list(
      "SUCCEEDED"|"FAILED"|"STOPPED"|"QUEUED"|"STARTING"|"RUNNING"|"STOPPING"
    )
  ),
  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$start_notebook_run(
  domainIdentifier = "string",
  owningProjectIdentifier = "string",
  notebookIdentifier = "string",
  scheduleIdentifier = "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
  ),
  notificationConfiguration = list(
    notifyOn = list(
      "SUCCEEDED"|"FAILED"|"STOPPED"|"QUEUED"|"STARTING"|"RUNNING"|"STOPPING"
    )
  ),
  triggerSource = list(
    type = "MANUAL"|"SCHEDULED"|"WORKFLOW",
    name = "string"
  ),
  metadata = list(
    "string"
  ),
  parameters = list(
    "string"
  ),
  clientToken = "string"
)