AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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
show all
Defined in:
(unknown)

Overview

Note:

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

Instance Attribute Details

#additional_code_repository_equalsString

A filter that returns only notebook instances with associated with the specified git repository.

Returns:

  • (String)

    A filter that returns only notebook instances with associated with the specified git repository.

#creation_time_afterTime

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

Returns:

  • (Time)

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

#creation_time_beforeTime

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

Returns:

  • (Time)

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

#default_code_repository_containsString

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.

Returns:

  • (String)

    A string in the name or URL of a Git repository associated with this notebook instance.

#last_modified_time_afterTime

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

Returns:

  • (Time)

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

#last_modified_time_beforeTime

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

Returns:

  • (Time)

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

#max_resultsInteger

The maximum number of notebook instances to return.

Returns:

  • (Integer)

    The maximum number of notebook instances to return.

#name_containsString

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

Returns:

  • (String)

    A string in the notebook instances\' name.

#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)

    If the previous call to the ListNotebookInstances is truncated, the response includes a NextToken.

#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)

    A string in the name of a notebook instances lifecycle configuration associated with this notebook instance.

#sort_byString

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

Possible values:

  • Name
  • CreationTime
  • Status

Returns:

  • (String)

    The field to sort results by.

#sort_orderString

The sort order for results.

Possible values:

  • Ascending
  • Descending

Returns:

  • (String)

    The sort order for results.

#status_equalsString

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

Possible values:

  • Pending
  • InService
  • Stopping
  • Stopped
  • Failed
  • Deleting
  • Updating

Returns:

  • (String)

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