ListNotebookInstanceLifecycleConfigs
Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.
Request Syntax
{
"CreationTimeAfter": number
,
"CreationTimeBefore": number
,
"LastModifiedTimeAfter": number
,
"LastModifiedTimeBefore": number
,
"MaxResults": number
,
"NameContains": "string
",
"NextToken": "string
",
"SortBy": "string
",
"SortOrder": "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.
- CreationTimeAfter
-
A filter that returns only lifecycle configurations that were created after the specified time (timestamp).
Type: Timestamp
Required: No
- CreationTimeBefore
-
A filter that returns only lifecycle configurations that were created before the specified time (timestamp).
Type: Timestamp
Required: No
- LastModifiedTimeAfter
-
A filter that returns only lifecycle configurations that were modified after the specified time (timestamp).
Type: Timestamp
Required: No
- LastModifiedTimeBefore
-
A filter that returns only lifecycle configurations that were modified before the specified time (timestamp).
Type: Timestamp
Required: No
- MaxResults
-
The maximum number of lifecycle configurations to return in the response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NameContains
-
A string in the lifecycle configuration name. This filter returns only lifecycle configurations whose name contains the specified string.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
[a-zA-Z0-9-]+
Required: No
- NextToken
-
If the result of a
ListNotebookInstanceLifecycleConfigs
request was truncated, the response includes aNextToken
. To get the next set of lifecycle configurations, use the token in the next request.Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.*
Required: No
- SortBy
-
Sorts the list of results. The default is
CreationTime
.Type: String
Valid Values:
Name | CreationTime | LastModifiedTime
Required: No
- SortOrder
-
The sort order for results.
Type: String
Valid Values:
Ascending | Descending
Required: No
Response Syntax
{
"NextToken": "string",
"NotebookInstanceLifecycleConfigs": [
{
"CreationTime": number,
"LastModifiedTime": number,
"NotebookInstanceLifecycleConfigArn": "string",
"NotebookInstanceLifecycleConfigName": "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 is truncated, SageMaker returns this token. To get the next set of lifecycle configurations, use it in the next request.
Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.*
- NotebookInstanceLifecycleConfigs
-
An array of
NotebookInstanceLifecycleConfiguration
objects, each listing a lifecycle configuration.Type: Array of NotebookInstanceLifecycleConfigSummary 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 Amazon SDKs, see the following: