Lists notebooks in Amazon SageMaker Unified Studio¶

Description¶

Lists notebooks in Amazon SageMaker Unified Studio.

Usage¶

datazone_list_notebooks(domainIdentifier, owningProjectIdentifier,
  maxResults, sortOrder, sortBy, status, type, nextToken)

Arguments¶

domainIdentifier

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

[required] The identifier of the project that owns the notebooks.
maxResults

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

The sort order for the results.
sortBy

The field to sort the results by.
status

The status to filter notebooks by.
type

The type to filter notebooks by.
nextToken

When the number of notebooks 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 notebooks, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to list_notebooks to list the next set of notebooks.

Value¶

A list with the following syntax:

list(
  items = list(
    list(
      id = "string",
      name = "string",
      owningProjectId = "string",
      domainId = "string",
      status = "ACTIVE"|"ARCHIVED"|"SYNC_IN_PROGRESS"|"SYNC_FAILED",
      type = "DATA"|"SQL",
      description = "string",
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      createdBy = "string",
      updatedAt = as.POSIXct(
        "2015-01-01"
      ),
      updatedBy = "string"
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_notebooks(
  domainIdentifier = "string",
  owningProjectIdentifier = "string",
  maxResults = 123,
  sortOrder = "ASCENDING"|"DESCENDING",
  sortBy = "CREATED_AT"|"UPDATED_AT",
  status = "ACTIVE"|"ARCHIVED"|"SYNC_IN_PROGRESS"|"SYNC_FAILED",
  type = "DATA"|"SQL",
  nextToken = "string"
)