Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-143021,9861.6 MB

Returns a list of the SageMaker notebook instances in the requester's account in an Amazon Web Services Region.

post/#X-Amz-Target=SageMaker.ListNotebookInstances

Query parameters

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

Headers

X-Amz-Target'SageMaker.ListNotebookInstances' required

Request body

NextTokenstring
<p> If the previous call to the <code>ListNotebookInstances</code> is truncated, the response includes a <code>NextToken</code>. You can use this token in your subsequent <code>ListNotebookInstances</code> request to fetch the next set of notebook instances. </p> <note> <p>You might specify a filter or a sort order in your request. When response is truncated, you must use the same values for the filer and sort order in the next request. </p> </note>
MaxResultsinteger

The maximum number of notebook instances to return.

SortBy'Name' | 'CreationTime' | 'Status'

The field to sort results by. The default is <code>Name</code>.

SortOrder'Ascending' | 'Descending'

The sort order for results.

NameContainsstring

A string in the notebook instances' name. This filter returns only notebook instances whose name contains the specified string.

CreationTimeBeforestring date-time

A filter that returns only notebook instances that were created before the specified time (timestamp).

CreationTimeAfterstring date-time

A filter that returns only notebook instances that were created after the specified time (timestamp).

LastModifiedTimeBeforestring date-time

A filter that returns only notebook instances that were modified before the specified time (timestamp).

LastModifiedTimeAfterstring date-time

A filter that returns only notebook instances that were modified after the specified time (timestamp).

StatusEquals'Pending' | 'InService' | 'Stopping' | 'Stopped' | 'Failed' | 'Deleting' | 'Updating'

A filter that returns only notebook instances with the specified status.

NotebookInstanceLifecycleConfigNameContainsstring

A string in the name of a notebook instances lifecycle configuration associated with this notebook instance. This filter returns only notebook instances associated with a lifecycle configuration with a name that contains the specified string.

DefaultCodeRepositoryContainsstring

A string in the name or URL of a Git repository associated with this notebook instance. This filter returns only notebook instances associated with a git repository with a name that contains the specified string.

AdditionalCodeRepositoryEqualsstring

A filter that returns only notebook instances with associated with the specified git repository.

Response

Success

NextTokenstring

If the response to the previous <code>ListNotebookInstances</code> request was truncated, SageMaker returns this token. To retrieve the next set of notebook instances, use the token in the next request.