Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . sagemaker ]

list-notebook-instances

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

list-notebook-instances is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: NotebookInstances

Synopsis

  list-notebook-instances
[--sort-by <value>]
[--sort-order <value>]
[--name-contains <value>]
[--creation-time-before <value>]
[--creation-time-after <value>]
[--last-modified-time-before <value>]
[--last-modified-time-after <value>]
[--status-equals <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--sort-by (string)

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

Possible values:

  • Name
  • CreationTime
  • Status

--sort-order (string)

The sort order for results.

Possible values:

  • Ascending
  • Descending

--name-contains (string)

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

--creation-time-before (timestamp)

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

--creation-time-after (timestamp)

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

--last-modified-time-before (timestamp)

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

--last-modified-time-after (timestamp)

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

--status-equals (string)

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

Possible values:

  • Pending
  • InService
  • Stopping
  • Stopped
  • Failed
  • Deleting

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--starting-token (string)

A token to specify where to start paginating. This is the next-token from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a next-token is provided in the command's output. To resume pagination, provide the next-token value in the starting-token argument of a subsequent command. Do not use the next-token response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

NextToken -> (string)

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

NotebookInstances -> (list)

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

(structure)

Provides summary information for an Amazon SageMaker notebook instance.

NotebookInstanceName -> (string)

The name of the notebook instance that you want a summary for.

NotebookInstanceArn -> (string)

The Amazon Resource Name (ARN) of the notebook instance.

NotebookInstanceStatus -> (string)

The status of the notebook instance.

Url -> (string)

The URL that you use to connect to the Jupyter instance running in your notebook instance.

InstanceType -> (string)

The type of ML compute instance that the notebook instance is running on.

CreationTime -> (timestamp)

A timestamp that shows when the notebook instance was created.

LastModifiedTime -> (timestamp)

A timestamp that shows when the notebook instance was last modified.