ListNotebookInstancesCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SageMakerClient, ListNotebookInstancesCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import
// const { SageMakerClient, ListNotebookInstancesCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import
const client = new SageMakerClient(config);
const input = { // ListNotebookInstancesInput
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
  SortBy: "Name" || "CreationTime" || "Status",
  SortOrder: "Ascending" || "Descending",
  NameContains: "STRING_VALUE",
  CreationTimeBefore: new Date("TIMESTAMP"),
  CreationTimeAfter: new Date("TIMESTAMP"),
  LastModifiedTimeBefore: new Date("TIMESTAMP"),
  LastModifiedTimeAfter: new Date("TIMESTAMP"),
  StatusEquals: "Pending" || "InService" || "Stopping" || "Stopped" || "Failed" || "Deleting" || "Updating",
  NotebookInstanceLifecycleConfigNameContains: "STRING_VALUE",
  DefaultCodeRepositoryContains: "STRING_VALUE",
  AdditionalCodeRepositoryEquals: "STRING_VALUE",
};
const command = new ListNotebookInstancesCommand(input);
const response = await client.send(command);
// { // ListNotebookInstancesOutput
//   NextToken: "STRING_VALUE",
//   NotebookInstances: [ // NotebookInstanceSummaryList
//     { // NotebookInstanceSummary
//       NotebookInstanceName: "STRING_VALUE", // required
//       NotebookInstanceArn: "STRING_VALUE", // required
//       NotebookInstanceStatus: "Pending" || "InService" || "Stopping" || "Stopped" || "Failed" || "Deleting" || "Updating",
//       Url: "STRING_VALUE",
//       InstanceType: "ml.t2.medium" || "ml.t2.large" || "ml.t2.xlarge" || "ml.t2.2xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5d.xlarge" || "ml.c5d.2xlarge" || "ml.c5d.4xlarge" || "ml.c5d.9xlarge" || "ml.c5d.18xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.inf1.xlarge" || "ml.inf1.2xlarge" || "ml.inf1.6xlarge" || "ml.inf1.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.inf2.xlarge" || "ml.inf2.8xlarge" || "ml.inf2.24xlarge" || "ml.inf2.48xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.m7i.large" || "ml.m7i.xlarge" || "ml.m7i.2xlarge" || "ml.m7i.4xlarge" || "ml.m7i.8xlarge" || "ml.m7i.12xlarge" || "ml.m7i.16xlarge" || "ml.m7i.24xlarge" || "ml.m7i.48xlarge" || "ml.c6i.large" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.4xlarge" || "ml.c6i.8xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.c7i.large" || "ml.c7i.xlarge" || "ml.c7i.2xlarge" || "ml.c7i.4xlarge" || "ml.c7i.8xlarge" || "ml.c7i.12xlarge" || "ml.c7i.16xlarge" || "ml.c7i.24xlarge" || "ml.c7i.48xlarge" || "ml.r6i.large" || "ml.r6i.xlarge" || "ml.r6i.2xlarge" || "ml.r6i.4xlarge" || "ml.r6i.8xlarge" || "ml.r6i.12xlarge" || "ml.r6i.16xlarge" || "ml.r6i.24xlarge" || "ml.r6i.32xlarge" || "ml.r7i.large" || "ml.r7i.xlarge" || "ml.r7i.2xlarge" || "ml.r7i.4xlarge" || "ml.r7i.8xlarge" || "ml.r7i.12xlarge" || "ml.r7i.16xlarge" || "ml.r7i.24xlarge" || "ml.r7i.48xlarge" || "ml.m6id.large" || "ml.m6id.xlarge" || "ml.m6id.2xlarge" || "ml.m6id.4xlarge" || "ml.m6id.8xlarge" || "ml.m6id.12xlarge" || "ml.m6id.16xlarge" || "ml.m6id.24xlarge" || "ml.m6id.32xlarge" || "ml.c6id.large" || "ml.c6id.xlarge" || "ml.c6id.2xlarge" || "ml.c6id.4xlarge" || "ml.c6id.8xlarge" || "ml.c6id.12xlarge" || "ml.c6id.16xlarge" || "ml.c6id.24xlarge" || "ml.c6id.32xlarge" || "ml.r6id.large" || "ml.r6id.xlarge" || "ml.r6id.2xlarge" || "ml.r6id.4xlarge" || "ml.r6id.8xlarge" || "ml.r6id.12xlarge" || "ml.r6id.16xlarge" || "ml.r6id.24xlarge" || "ml.r6id.32xlarge" || "ml.g6.xlarge" || "ml.g6.2xlarge" || "ml.g6.4xlarge" || "ml.g6.8xlarge" || "ml.g6.12xlarge" || "ml.g6.16xlarge" || "ml.g6.24xlarge" || "ml.g6.48xlarge",
//       CreationTime: new Date("TIMESTAMP"),
//       LastModifiedTime: new Date("TIMESTAMP"),
//       NotebookInstanceLifecycleConfigName: "STRING_VALUE",
//       DefaultCodeRepository: "STRING_VALUE",
//       AdditionalCodeRepositories: [ // AdditionalCodeRepositoryNamesOrUrls
//         "STRING_VALUE",
//       ],
//     },
//   ],
// };

ListNotebookInstancesCommand Input

See ListNotebookInstancesCommandInput for more details

Parameter
Type
Description
AdditionalCodeRepositoryEquals
string | undefined

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

CreationTimeAfter
Date | undefined

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

CreationTimeBefore
Date | undefined

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

DefaultCodeRepositoryContains
string | undefined

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.

LastModifiedTimeAfter
Date | undefined

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

LastModifiedTimeBefore
Date | undefined

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

MaxResults
number | undefined

The maximum number of notebook instances to return.

NameContains
string | undefined

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

NextToken
string | undefined

If the previous call to the ListNotebookInstances is truncated, the response includes a NextToken. You can use this token in your subsequent ListNotebookInstances request to fetch the next set of notebook instances.

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.

NotebookInstanceLifecycleConfigNameContains
string | undefined

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.

SortBy
NotebookInstanceSortKey | undefined

The field to sort results by. The default is Name.

SortOrder
NotebookInstanceSortOrder | undefined

The sort order for results.

StatusEquals
NotebookInstanceStatus | undefined

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

ListNotebookInstancesCommand Output

See ListNotebookInstancesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
NextToken
string | undefined

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

NotebookInstances
NotebookInstanceSummary[] | undefined

An array of NotebookInstanceSummary objects, one for each notebook instance.

Throws

Name
Fault
Details
SageMakerServiceException
Base exception class for all service exceptions from SageMaker service.