Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

AWS Tools for Windows PowerShell
Command Reference

Synopsis

Calls the Amazon SageMaker Service ListNotebookInstances API operation.

Syntax

Get-SMNotebookInstanceList
-AdditionalCodeRepositoryEqual <String>
-CreationTimeAfter <DateTime>
-CreationTimeBefore <DateTime>
-DefaultCodeRepositoryContain <String>
-LastModifiedTimeAfter <DateTime>
-LastModifiedTimeBefore <DateTime>
-NameContain <String>
-NotebookInstanceLifecycleConfigNameContain <String>
-SortBy <NotebookInstanceSortKey>
-SortOrder <NotebookInstanceSortOrder>
-StatusEqual <NotebookInstanceStatus>
-MaxResult <Int32>
-NextToken <String>
-Select <String>
-NoAutoIteration <SwitchParameter>
-ClientConfig <AmazonSageMakerConfig>

Description

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

This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration.

Parameters

-AdditionalCodeRepositoryEqual <String>
A filter that returns only notebook instances with associated with the specified git repository.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdditionalCodeRepositoryEquals
-ClientConfig <AmazonSageMakerConfig>
Amazon.PowerShell.Cmdlets.SM.AmazonSageMakerClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CreationTimeAfter <DateTime>
A filter that returns only notebook instances that were created after the specified time (timestamp).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CreationTimeBefore <DateTime>
A filter that returns only notebook instances that were created before the specified time (timestamp).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultCodeRepositoryContain <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultCodeRepositoryContains
-LastModifiedTimeAfter <DateTime>
A filter that returns only notebook instances that were modified after the specified time (timestamp).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LastModifiedTimeBefore <DateTime>
A filter that returns only notebook instances that were modified before the specified time (timestamp).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaxResult <Int32>
The maximum number of notebook instances to return.
Note: In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet.
In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call.
Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned.If a value for this parameter is not specified the cmdlet will use a default value of '100'.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMaxItems, MaxResults
-NameContain <String>
A string in the notebook instances' name. This filter returns only notebook instances whose name contains the specified string.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNameContains
-NextToken <String>
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.
Note: This parameter is only used if you are manually controlling output pagination of the service API call.
'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NoAutoIteration <SwitchParameter>
By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NotebookInstanceLifecycleConfigNameContain <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNotebookInstanceLifecycleConfigNameContains
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'NotebookInstances'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListNotebookInstancesResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListNotebookInstancesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SortBy <NotebookInstanceSortKey>
The field to sort results by. The default is Name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SortOrder <NotebookInstanceSortOrder>
The sort order for results.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StatusEqual <NotebookInstanceStatus>
A filter that returns only notebook instances with the specified status.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStatusEquals

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.SageMaker.Model.NotebookInstanceSummary or Amazon.SageMaker.Model.ListNotebookInstancesResponse
This cmdlet returns a collection of Amazon.SageMaker.Model.NotebookInstanceSummary objects. The service call response (type Amazon.SageMaker.Model.ListNotebookInstancesResponse) can be returned by specifying '-Select *'.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 4.1.790.0