You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SageMaker::Types::ListNotebookInstancesInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

Note:

When making an API call, you may pass ListNotebookInstancesInput data as a 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",
}

Instance Attribute Summary collapse

Instance Attribute Details

#creation_time_afterTime

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

Returns:

  • (Time)


3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 3201

class ListNotebookInstancesInput < Struct.new(
  :next_token,
  :max_results,
  :sort_by,
  :sort_order,
  :name_contains,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals,
  :notebook_instance_lifecycle_config_name_contains)
  include Aws::Structure
end

#creation_time_beforeTime

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

Returns:

  • (Time)


3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 3201

class ListNotebookInstancesInput < Struct.new(
  :next_token,
  :max_results,
  :sort_by,
  :sort_order,
  :name_contains,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals,
  :notebook_instance_lifecycle_config_name_contains)
  include Aws::Structure
end

#last_modified_time_afterTime

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

Returns:

  • (Time)


3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 3201

class ListNotebookInstancesInput < Struct.new(
  :next_token,
  :max_results,
  :sort_by,
  :sort_order,
  :name_contains,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals,
  :notebook_instance_lifecycle_config_name_contains)
  include Aws::Structure
end

#last_modified_time_beforeTime

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

Returns:

  • (Time)


3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 3201

class ListNotebookInstancesInput < Struct.new(
  :next_token,
  :max_results,
  :sort_by,
  :sort_order,
  :name_contains,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals,
  :notebook_instance_lifecycle_config_name_contains)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of notebook instances to return.

Returns:

  • (Integer)


3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 3201

class ListNotebookInstancesInput < Struct.new(
  :next_token,
  :max_results,
  :sort_by,
  :sort_order,
  :name_contains,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals,
  :notebook_instance_lifecycle_config_name_contains)
  include Aws::Structure
end

#name_containsString

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

Returns:

  • (String)


3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 3201

class ListNotebookInstancesInput < Struct.new(
  :next_token,
  :max_results,
  :sort_by,
  :sort_order,
  :name_contains,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals,
  :notebook_instance_lifecycle_config_name_contains)
  include Aws::Structure
end

#next_tokenString

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.

Returns:

  • (String)


3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 3201

class ListNotebookInstancesInput < Struct.new(
  :next_token,
  :max_results,
  :sort_by,
  :sort_order,
  :name_contains,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals,
  :notebook_instance_lifecycle_config_name_contains)
  include Aws::Structure
end

#notebook_instance_lifecycle_config_name_containsString

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.

Returns:

  • (String)


3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 3201

class ListNotebookInstancesInput < Struct.new(
  :next_token,
  :max_results,
  :sort_by,
  :sort_order,
  :name_contains,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals,
  :notebook_instance_lifecycle_config_name_contains)
  include Aws::Structure
end

#sort_byString

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

Returns:

  • (String)


3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 3201

class ListNotebookInstancesInput < Struct.new(
  :next_token,
  :max_results,
  :sort_by,
  :sort_order,
  :name_contains,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals,
  :notebook_instance_lifecycle_config_name_contains)
  include Aws::Structure
end

#sort_orderString

The sort order for results.

Returns:

  • (String)


3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 3201

class ListNotebookInstancesInput < Struct.new(
  :next_token,
  :max_results,
  :sort_by,
  :sort_order,
  :name_contains,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals,
  :notebook_instance_lifecycle_config_name_contains)
  include Aws::Structure
end

#status_equalsString

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

Returns:

  • (String)


3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 3201

class ListNotebookInstancesInput < Struct.new(
  :next_token,
  :max_results,
  :sort_by,
  :sort_order,
  :name_contains,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals,
  :notebook_instance_lifecycle_config_name_contains)
  include Aws::Structure
end