You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::SageMaker::Types::ListNotebookInstancesInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::SageMaker::Types::ListNotebookInstancesInput
- Defined in:
- (unknown)
Overview
When passing ListNotebookInstancesInput as input to an Aws::Client method, you can use a vanilla Hash:
{
next_token: "NextToken",
max_results: 1,
sort_by: "Name", # accepts Name, CreationTime, Status
sort_order: "Ascending", # accepts Ascending, Descending
name_contains: "NotebookInstanceNameContains",
creation_time_before: Time.now,
creation_time_after: Time.now,
last_modified_time_before: Time.now,
last_modified_time_after: Time.now,
status_equals: "Pending", # accepts Pending, InService, Stopping, Stopped, Failed, Deleting, Updating
notebook_instance_lifecycle_config_name_contains: "NotebookInstanceLifecycleConfigName",
default_code_repository_contains: "CodeRepositoryContains",
additional_code_repository_equals: "CodeRepositoryNameOrUrl",
}
Instance Attribute Summary collapse
-
#additional_code_repository_equals ⇒ String
A filter that returns only notebook instances with associated with the specified git repository.
-
#creation_time_after ⇒ Time
A filter that returns only notebook instances that were created after the specified time (timestamp).
-
#creation_time_before ⇒ Time
A filter that returns only notebook instances that were created before the specified time (timestamp).
-
#default_code_repository_contains ⇒ String
A string in the name or URL of a Git repository associated with this notebook instance.
-
#last_modified_time_after ⇒ Time
A filter that returns only notebook instances that were modified after the specified time (timestamp).
-
#last_modified_time_before ⇒ Time
A filter that returns only notebook instances that were modified before the specified time (timestamp).
-
#max_results ⇒ Integer
The maximum number of notebook instances to return.
-
#name_contains ⇒ String
A string in the notebook instances\' name.
-
#next_token ⇒ String
If the previous call to the
ListNotebookInstances
is truncated, the response includes aNextToken
. -
#notebook_instance_lifecycle_config_name_contains ⇒ String
A string in the name of a notebook instances lifecycle configuration associated with this notebook instance.
-
#sort_by ⇒ String
The field to sort results by.
-
#sort_order ⇒ String
The sort order for results.
-
#status_equals ⇒ String
A filter that returns only notebook instances with the specified status.
Instance Attribute Details
#additional_code_repository_equals ⇒ String
A filter that returns only notebook instances with associated with the specified git repository.
#creation_time_after ⇒ Time
A filter that returns only notebook instances that were created after the specified time (timestamp).
#creation_time_before ⇒ Time
A filter that returns only notebook instances that were created before the specified time (timestamp).
#default_code_repository_contains ⇒ 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.
#last_modified_time_after ⇒ Time
A filter that returns only notebook instances that were modified after the specified time (timestamp).
#last_modified_time_before ⇒ Time
A filter that returns only notebook instances that were modified before the specified time (timestamp).
#max_results ⇒ Integer
The maximum number of notebook instances to return.
#name_contains ⇒ String
A string in the notebook instances\' name. This filter returns only notebook instances whose name contains the specified string.
#next_token ⇒ 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.
#notebook_instance_lifecycle_config_name_contains ⇒ 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.
#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
#status_equals ⇒ String
A filter that returns only notebook instances with the specified status.
Possible values:
- Pending
- InService
- Stopping
- Stopped
- Failed
- Deleting
- Updating