ListNotebookInstances
Returns a list of the SageMaker AI notebook instances in the requester's account in an AWS Region.
Request Syntax
{
"AdditionalCodeRepositoryEquals": "string",
"CreationTimeAfter": number,
"CreationTimeBefore": number,
"DefaultCodeRepositoryContains": "string",
"LastModifiedTimeAfter": number,
"LastModifiedTimeBefore": number,
"MaxResults": number,
"NameContains": "string",
"NextToken": "string",
"NotebookInstanceLifecycleConfigNameContains": "string",
"SortBy": "string",
"SortOrder": "string",
"StatusEquals": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- AdditionalCodeRepositoryEquals
-
A filter that returns only notebook instances with associated with the specified git repository.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
^https://([^/]+)/?(.*)$|^[a-zA-Z0-9](-*[a-zA-Z0-9])*Required: No
- CreationTimeAfter
-
A filter that returns only notebook instances that were created after the specified time (timestamp).
Type: Timestamp
Required: No
- CreationTimeBefore
-
A filter that returns only notebook instances that were created before the specified time (timestamp).
Type: Timestamp
Required: No
- DefaultCodeRepositoryContains
-
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.
Type: String
Length Constraints: Maximum length of 1024.
Pattern:
[a-zA-Z0-9-]+Required: No
- LastModifiedTimeAfter
-
A filter that returns only notebook instances that were modified after the specified time (timestamp).
Type: Timestamp
Required: No
- LastModifiedTimeBefore
-
A filter that returns only notebook instances that were modified before the specified time (timestamp).
Type: Timestamp
Required: No
- MaxResults
-
The maximum number of notebook instances to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NameContains
-
A string in the notebook instances' name. This filter returns only notebook instances whose name contains the specified string.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
[a-zA-Z0-9-]+Required: No
- NextToken
-
If the previous call to the
ListNotebookInstancesis truncated, the response includes aNextToken. You can use this token in your subsequentListNotebookInstancesrequest to fetch the next set of notebook instances.Note
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.
Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.*Required: No
- NotebookInstanceLifecycleConfigNameContains
-
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.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9])*Required: No
- SortBy
-
The field to sort results by. The default is
Name.Type: String
Valid Values:
Name | CreationTime | StatusRequired: No
- SortOrder
-
The sort order for results.
Type: String
Valid Values:
Ascending | DescendingRequired: No
- StatusEquals
-
A filter that returns only notebook instances with the specified status.
Type: String
Valid Values:
Pending | InService | Stopping | Stopped | Failed | Deleting | UpdatingRequired: No
Response Syntax
{
"NextToken": "string",
"NotebookInstances": [
{
"AdditionalCodeRepositories": [ "string" ],
"CreationTime": number,
"DefaultCodeRepository": "string",
"InstanceType": "string",
"LastModifiedTime": number,
"NotebookInstanceArn": "string",
"NotebookInstanceLifecycleConfigName": "string",
"NotebookInstanceName": "string",
"NotebookInstanceStatus": "string",
"Url": "string"
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- NextToken
-
If the response to the previous
ListNotebookInstancesrequest was truncated, SageMaker AI returns this token. To retrieve the next set of notebook instances, use the token in the next request.Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.* - NotebookInstances
-
An array of
NotebookInstanceSummaryobjects, one for each notebook instance.Type: Array of NotebookInstanceSummary objects
Errors
For information about the errors that are common to all actions, see Common Errors.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
