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

Class: Aws::SageMaker::Types::NotebookInstanceSummary

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

Overview

Provides summary information for an Amazon SageMaker notebook instance.

Instance Attribute Summary collapse

Instance Attribute Details

#additional_code_repositoriesArray<String>

An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

Returns:

  • (Array<String>)


9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 9359

class NotebookInstanceSummary < Struct.new(
  :notebook_instance_name,
  :notebook_instance_arn,
  :notebook_instance_status,
  :url,
  :instance_type,
  :creation_time,
  :last_modified_time,
  :notebook_instance_lifecycle_config_name,
  :default_code_repository,
  :additional_code_repositories)
  include Aws::Structure
end

#creation_timeTime

A timestamp that shows when the notebook instance was created.

Returns:

  • (Time)


9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 9359

class NotebookInstanceSummary < Struct.new(
  :notebook_instance_name,
  :notebook_instance_arn,
  :notebook_instance_status,
  :url,
  :instance_type,
  :creation_time,
  :last_modified_time,
  :notebook_instance_lifecycle_config_name,
  :default_code_repository,
  :additional_code_repositories)
  include Aws::Structure
end

#default_code_repositoryString

The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

Returns:

  • (String)


9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 9359

class NotebookInstanceSummary < Struct.new(
  :notebook_instance_name,
  :notebook_instance_arn,
  :notebook_instance_status,
  :url,
  :instance_type,
  :creation_time,
  :last_modified_time,
  :notebook_instance_lifecycle_config_name,
  :default_code_repository,
  :additional_code_repositories)
  include Aws::Structure
end

#instance_typeString

The type of ML compute instance that the notebook instance is running on.

Returns:

  • (String)


9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 9359

class NotebookInstanceSummary < Struct.new(
  :notebook_instance_name,
  :notebook_instance_arn,
  :notebook_instance_status,
  :url,
  :instance_type,
  :creation_time,
  :last_modified_time,
  :notebook_instance_lifecycle_config_name,
  :default_code_repository,
  :additional_code_repositories)
  include Aws::Structure
end

#last_modified_timeTime

A timestamp that shows when the notebook instance was last modified.

Returns:

  • (Time)


9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 9359

class NotebookInstanceSummary < Struct.new(
  :notebook_instance_name,
  :notebook_instance_arn,
  :notebook_instance_status,
  :url,
  :instance_type,
  :creation_time,
  :last_modified_time,
  :notebook_instance_lifecycle_config_name,
  :default_code_repository,
  :additional_code_repositories)
  include Aws::Structure
end

#notebook_instance_arnString

The Amazon Resource Name (ARN) of the notebook instance.

Returns:

  • (String)


9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 9359

class NotebookInstanceSummary < Struct.new(
  :notebook_instance_name,
  :notebook_instance_arn,
  :notebook_instance_status,
  :url,
  :instance_type,
  :creation_time,
  :last_modified_time,
  :notebook_instance_lifecycle_config_name,
  :default_code_repository,
  :additional_code_repositories)
  include Aws::Structure
end

#notebook_instance_lifecycle_config_nameString

The name of a notebook instance lifecycle configuration associated with this notebook instance.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

Returns:

  • (String)


9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 9359

class NotebookInstanceSummary < Struct.new(
  :notebook_instance_name,
  :notebook_instance_arn,
  :notebook_instance_status,
  :url,
  :instance_type,
  :creation_time,
  :last_modified_time,
  :notebook_instance_lifecycle_config_name,
  :default_code_repository,
  :additional_code_repositories)
  include Aws::Structure
end

#notebook_instance_nameString

The name of the notebook instance that you want a summary for.

Returns:

  • (String)


9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 9359

class NotebookInstanceSummary < Struct.new(
  :notebook_instance_name,
  :notebook_instance_arn,
  :notebook_instance_status,
  :url,
  :instance_type,
  :creation_time,
  :last_modified_time,
  :notebook_instance_lifecycle_config_name,
  :default_code_repository,
  :additional_code_repositories)
  include Aws::Structure
end

#notebook_instance_statusString

The status of the notebook instance.

Returns:

  • (String)


9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 9359

class NotebookInstanceSummary < Struct.new(
  :notebook_instance_name,
  :notebook_instance_arn,
  :notebook_instance_status,
  :url,
  :instance_type,
  :creation_time,
  :last_modified_time,
  :notebook_instance_lifecycle_config_name,
  :default_code_repository,
  :additional_code_repositories)
  include Aws::Structure
end

#urlString

The URL that you use to connect to the Jupyter instance running in your notebook instance.

Returns:

  • (String)


9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 9359

class NotebookInstanceSummary < Struct.new(
  :notebook_instance_name,
  :notebook_instance_arn,
  :notebook_instance_status,
  :url,
  :instance_type,
  :creation_time,
  :last_modified_time,
  :notebook_instance_lifecycle_config_name,
  :default_code_repository,
  :additional_code_repositories)
  include Aws::Structure
end