Skip to content

Lists notebook runs in Amazon SageMaker Unified Studio

Description

Lists notebook runs in Amazon SageMaker Unified Studio.

Usage

datazone_list_notebook_runs(domainIdentifier, owningProjectIdentifier,
  notebookIdentifier, status, scheduleIdentifier, maxResults, sortOrder,
  nextToken)

Arguments

  • domainIdentifier

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

  • owningProjectIdentifier

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

  • notebookIdentifier

    The identifier of the notebook to filter runs by.

  • status

    The status to filter notebook runs by.

  • scheduleIdentifier

    The identifier of the schedule to filter notebook runs by.

  • maxResults

    The maximum number of notebook runs to return in a single call. When the number of notebook runs exceeds the value of MaxResults, the response contains a NextToken value.

  • sortOrder

    The sort order for the results.

  • nextToken

    When the number of notebook runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of notebook runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to list_notebook_runs to list the next set of notebook runs.

Value

A list with the following syntax:

list(
  items = list(
    list(
      id = "string",
      domainId = "string",
      owningProjectId = "string",
      notebookId = "string",
      scheduleId = "string",
      status = "QUEUED"|"STARTING"|"RUNNING"|"STOPPING"|"STOPPED"|"SUCCEEDED"|"FAILED",
      triggerSource = list(
        type = "MANUAL"|"SCHEDULED"|"WORKFLOW",
        name = "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"
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_notebook_runs(
  domainIdentifier = "string",
  owningProjectIdentifier = "string",
  notebookIdentifier = "string",
  status = "QUEUED"|"STARTING"|"RUNNING"|"STOPPING"|"STOPPED"|"SUCCEEDED"|"FAILED",
  scheduleIdentifier = "string",
  maxResults = 123,
  sortOrder = "ASCENDING"|"DESCENDING",
  nextToken = "string"
)