Class: Aws::SageMaker::Types::DescribeNotebookInstanceOutput

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

Overview

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#accelerator_types ⇒ Array<String>

A list of the Elastic Inference (EI) instance types associated with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see [Using Elastic Inference in Amazon SageMaker].

[1]: docs.aws.amazon.com/sagemaker/latest/dg/ei.html

Returns:

  • (Array<String>) 


7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 7671

class DescribeNotebookInstanceOutput < Struct.new(
  :notebook_instance_arn,
  :notebook_instance_name,
  :notebook_instance_status,
  :failure_reason,
  :url,
  :instance_type,
  :subnet_id,
  :security_groups,
  :role_arn,
  :kms_key_id,
  :network_interface_id,
  :last_modified_time,
  :creation_time,
  :notebook_instance_lifecycle_config_name,
  :direct_internet_access,
  :volume_size_in_gb,
  :accelerator_types,
  :default_code_repository,
  :additional_code_repositories,
  :root_access)
  include Aws::Structure
end

#additional_code_repositories ⇒ Array<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].

[1]: docs.aws.amazon.com/codecommit/latest/userguide/welcome.html [2]: docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html

Returns:

  • (Array<String>) 


7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 7671

class DescribeNotebookInstanceOutput < Struct.new(
  :notebook_instance_arn,
  :notebook_instance_name,
  :notebook_instance_status,
  :failure_reason,
  :url,
  :instance_type,
  :subnet_id,
  :security_groups,
  :role_arn,
  :kms_key_id,
  :network_interface_id,
  :last_modified_time,
  :creation_time,
  :notebook_instance_lifecycle_config_name,
  :direct_internet_access,
  :volume_size_in_gb,
  :accelerator_types,
  :default_code_repository,
  :additional_code_repositories,
  :root_access)
  include Aws::Structure
end

#creation_time ⇒ Time

A timestamp. Use this parameter to return the time when the notebook instance was created

Returns:

  • (Time) 


7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 7671

class DescribeNotebookInstanceOutput < Struct.new(
  :notebook_instance_arn,
  :notebook_instance_name,
  :notebook_instance_status,
  :failure_reason,
  :url,
  :instance_type,
  :subnet_id,
  :security_groups,
  :role_arn,
  :kms_key_id,
  :network_interface_id,
  :last_modified_time,
  :creation_time,
  :notebook_instance_lifecycle_config_name,
  :direct_internet_access,
  :volume_size_in_gb,
  :accelerator_types,
  :default_code_repository,
  :additional_code_repositories,
  :root_access)
  include Aws::Structure
end

#default_code_repository ⇒ String

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].

[1]: docs.aws.amazon.com/codecommit/latest/userguide/welcome.html [2]: docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html

Returns:

  • (String) 


7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 7671

class DescribeNotebookInstanceOutput < Struct.new(
  :notebook_instance_arn,
  :notebook_instance_name,
  :notebook_instance_status,
  :failure_reason,
  :url,
  :instance_type,
  :subnet_id,
  :security_groups,
  :role_arn,
  :kms_key_id,
  :network_interface_id,
  :last_modified_time,
  :creation_time,
  :notebook_instance_lifecycle_config_name,
  :direct_internet_access,
  :volume_size_in_gb,
  :accelerator_types,
  :default_code_repository,
  :additional_code_repositories,
  :root_access)
  include Aws::Structure
end

#direct_internet_access ⇒ String

Describes whether Amazon SageMaker provides internet access to the notebook instance. If this value is set to Disabled, the notebook instance does not have internet access, and cannot connect to Amazon SageMaker training and endpoint services.

For more information, see [Notebook Instances Are Internet-Enabled by Default].

[1]: docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access

Returns:

  • (String) 


7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 7671

class DescribeNotebookInstanceOutput < Struct.new(
  :notebook_instance_arn,
  :notebook_instance_name,
  :notebook_instance_status,
  :failure_reason,
  :url,
  :instance_type,
  :subnet_id,
  :security_groups,
  :role_arn,
  :kms_key_id,
  :network_interface_id,
  :last_modified_time,
  :creation_time,
  :notebook_instance_lifecycle_config_name,
  :direct_internet_access,
  :volume_size_in_gb,
  :accelerator_types,
  :default_code_repository,
  :additional_code_repositories,
  :root_access)
  include Aws::Structure
end

#failure_reason ⇒ String

If status is ‘Failed`, the reason it failed.

Returns:

  • (String) 


7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 7671

class DescribeNotebookInstanceOutput < Struct.new(
  :notebook_instance_arn,
  :notebook_instance_name,
  :notebook_instance_status,
  :failure_reason,
  :url,
  :instance_type,
  :subnet_id,
  :security_groups,
  :role_arn,
  :kms_key_id,
  :network_interface_id,
  :last_modified_time,
  :creation_time,
  :notebook_instance_lifecycle_config_name,
  :direct_internet_access,
  :volume_size_in_gb,
  :accelerator_types,
  :default_code_repository,
  :additional_code_repositories,
  :root_access)
  include Aws::Structure
end

#instance_type ⇒ String

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

Returns:

  • (String) 


7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 7671

class DescribeNotebookInstanceOutput < Struct.new(
  :notebook_instance_arn,
  :notebook_instance_name,
  :notebook_instance_status,
  :failure_reason,
  :url,
  :instance_type,
  :subnet_id,
  :security_groups,
  :role_arn,
  :kms_key_id,
  :network_interface_id,
  :last_modified_time,
  :creation_time,
  :notebook_instance_lifecycle_config_name,
  :direct_internet_access,
  :volume_size_in_gb,
  :accelerator_types,
  :default_code_repository,
  :additional_code_repositories,
  :root_access)
  include Aws::Structure
end

#kms_key_id ⇒ String

The AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.

Returns:

  • (String) 


7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 7671

class DescribeNotebookInstanceOutput < Struct.new(
  :notebook_instance_arn,
  :notebook_instance_name,
  :notebook_instance_status,
  :failure_reason,
  :url,
  :instance_type,
  :subnet_id,
  :security_groups,
  :role_arn,
  :kms_key_id,
  :network_interface_id,
  :last_modified_time,
  :creation_time,
  :notebook_instance_lifecycle_config_name,
  :direct_internet_access,
  :volume_size_in_gb,
  :accelerator_types,
  :default_code_repository,
  :additional_code_repositories,
  :root_access)
  include Aws::Structure
end

#last_modified_time ⇒ Time

A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.

Returns:

  • (Time) 


7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 7671

class DescribeNotebookInstanceOutput < Struct.new(
  :notebook_instance_arn,
  :notebook_instance_name,
  :notebook_instance_status,
  :failure_reason,
  :url,
  :instance_type,
  :subnet_id,
  :security_groups,
  :role_arn,
  :kms_key_id,
  :network_interface_id,
  :last_modified_time,
  :creation_time,
  :notebook_instance_lifecycle_config_name,
  :direct_internet_access,
  :volume_size_in_gb,
  :accelerator_types,
  :default_code_repository,
  :additional_code_repositories,
  :root_access)
  include Aws::Structure
end

#network_interface_id ⇒ String

The network interface IDs that Amazon SageMaker created at the time of creating the instance.

Returns:

  • (String) 


7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 7671

class DescribeNotebookInstanceOutput < Struct.new(
  :notebook_instance_arn,
  :notebook_instance_name,
  :notebook_instance_status,
  :failure_reason,
  :url,
  :instance_type,
  :subnet_id,
  :security_groups,
  :role_arn,
  :kms_key_id,
  :network_interface_id,
  :last_modified_time,
  :creation_time,
  :notebook_instance_lifecycle_config_name,
  :direct_internet_access,
  :volume_size_in_gb,
  :accelerator_types,
  :default_code_repository,
  :additional_code_repositories,
  :root_access)
  include Aws::Structure
end

#notebook_instance_arn ⇒ String

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

Returns:

  • (String) 


7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 7671

class DescribeNotebookInstanceOutput < Struct.new(
  :notebook_instance_arn,
  :notebook_instance_name,
  :notebook_instance_status,
  :failure_reason,
  :url,
  :instance_type,
  :subnet_id,
  :security_groups,
  :role_arn,
  :kms_key_id,
  :network_interface_id,
  :last_modified_time,
  :creation_time,
  :notebook_instance_lifecycle_config_name,
  :direct_internet_access,
  :volume_size_in_gb,
  :accelerator_types,
  :default_code_repository,
  :additional_code_repositories,
  :root_access)
  include Aws::Structure
end

#notebook_instance_lifecycle_config_name ⇒ String

Returns the name of a notebook instance lifecycle configuration.

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

[1]: docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html

Returns:

  • (String) 


7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 7671

class DescribeNotebookInstanceOutput < Struct.new(
  :notebook_instance_arn,
  :notebook_instance_name,
  :notebook_instance_status,
  :failure_reason,
  :url,
  :instance_type,
  :subnet_id,
  :security_groups,
  :role_arn,
  :kms_key_id,
  :network_interface_id,
  :last_modified_time,
  :creation_time,
  :notebook_instance_lifecycle_config_name,
  :direct_internet_access,
  :volume_size_in_gb,
  :accelerator_types,
  :default_code_repository,
  :additional_code_repositories,
  :root_access)
  include Aws::Structure
end

#notebook_instance_name ⇒ String

The name of the Amazon SageMaker notebook instance.

Returns:

  • (String) 


7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 7671

class DescribeNotebookInstanceOutput < Struct.new(
  :notebook_instance_arn,
  :notebook_instance_name,
  :notebook_instance_status,
  :failure_reason,
  :url,
  :instance_type,
  :subnet_id,
  :security_groups,
  :role_arn,
  :kms_key_id,
  :network_interface_id,
  :last_modified_time,
  :creation_time,
  :notebook_instance_lifecycle_config_name,
  :direct_internet_access,
  :volume_size_in_gb,
  :accelerator_types,
  :default_code_repository,
  :additional_code_repositories,
  :root_access)
  include Aws::Structure
end

#notebook_instance_status ⇒ String

The status of the notebook instance.

Returns:

  • (String) 


7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 7671

class DescribeNotebookInstanceOutput < Struct.new(
  :notebook_instance_arn,
  :notebook_instance_name,
  :notebook_instance_status,
  :failure_reason,
  :url,
  :instance_type,
  :subnet_id,
  :security_groups,
  :role_arn,
  :kms_key_id,
  :network_interface_id,
  :last_modified_time,
  :creation_time,
  :notebook_instance_lifecycle_config_name,
  :direct_internet_access,
  :volume_size_in_gb,
  :accelerator_types,
  :default_code_repository,
  :additional_code_repositories,
  :root_access)
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role associated with the instance.

Returns:

  • (String) 


7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 7671

class DescribeNotebookInstanceOutput < Struct.new(
  :notebook_instance_arn,
  :notebook_instance_name,
  :notebook_instance_status,
  :failure_reason,
  :url,
  :instance_type,
  :subnet_id,
  :security_groups,
  :role_arn,
  :kms_key_id,
  :network_interface_id,
  :last_modified_time,
  :creation_time,
  :notebook_instance_lifecycle_config_name,
  :direct_internet_access,
  :volume_size_in_gb,
  :accelerator_types,
  :default_code_repository,
  :additional_code_repositories,
  :root_access)
  include Aws::Structure
end

#root_access ⇒ String

Whether root access is enabled or disabled for users of the notebook instance.

<note markdown=“1”> Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.

</note>

Returns:

  • (String) 


7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 7671

class DescribeNotebookInstanceOutput < Struct.new(
  :notebook_instance_arn,
  :notebook_instance_name,
  :notebook_instance_status,
  :failure_reason,
  :url,
  :instance_type,
  :subnet_id,
  :security_groups,
  :role_arn,
  :kms_key_id,
  :network_interface_id,
  :last_modified_time,
  :creation_time,
  :notebook_instance_lifecycle_config_name,
  :direct_internet_access,
  :volume_size_in_gb,
  :accelerator_types,
  :default_code_repository,
  :additional_code_repositories,
  :root_access)
  include Aws::Structure
end

#security_groups ⇒ Array<String>

The IDs of the VPC security groups.

Returns:

  • (Array<String>) 


7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 7671

class DescribeNotebookInstanceOutput < Struct.new(
  :notebook_instance_arn,
  :notebook_instance_name,
  :notebook_instance_status,
  :failure_reason,
  :url,
  :instance_type,
  :subnet_id,
  :security_groups,
  :role_arn,
  :kms_key_id,
  :network_interface_id,
  :last_modified_time,
  :creation_time,
  :notebook_instance_lifecycle_config_name,
  :direct_internet_access,
  :volume_size_in_gb,
  :accelerator_types,
  :default_code_repository,
  :additional_code_repositories,
  :root_access)
  include Aws::Structure
end

#subnet_id ⇒ String

The ID of the VPC subnet.

Returns:

  • (String) 


7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 7671

class DescribeNotebookInstanceOutput < Struct.new(
  :notebook_instance_arn,
  :notebook_instance_name,
  :notebook_instance_status,
  :failure_reason,
  :url,
  :instance_type,
  :subnet_id,
  :security_groups,
  :role_arn,
  :kms_key_id,
  :network_interface_id,
  :last_modified_time,
  :creation_time,
  :notebook_instance_lifecycle_config_name,
  :direct_internet_access,
  :volume_size_in_gb,
  :accelerator_types,
  :default_code_repository,
  :additional_code_repositories,
  :root_access)
  include Aws::Structure
end

#url ⇒ String

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

Returns:

  • (String) 


7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 7671

class DescribeNotebookInstanceOutput < Struct.new(
  :notebook_instance_arn,
  :notebook_instance_name,
  :notebook_instance_status,
  :failure_reason,
  :url,
  :instance_type,
  :subnet_id,
  :security_groups,
  :role_arn,
  :kms_key_id,
  :network_interface_id,
  :last_modified_time,
  :creation_time,
  :notebook_instance_lifecycle_config_name,
  :direct_internet_access,
  :volume_size_in_gb,
  :accelerator_types,
  :default_code_repository,
  :additional_code_repositories,
  :root_access)
  include Aws::Structure
end

#volume_size_in_gb ⇒ Integer

The size, in GB, of the ML storage volume attached to the notebook instance.

Returns:

  • (Integer) 


7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 7671

class DescribeNotebookInstanceOutput < Struct.new(
  :notebook_instance_arn,
  :notebook_instance_name,
  :notebook_instance_status,
  :failure_reason,
  :url,
  :instance_type,
  :subnet_id,
  :security_groups,
  :role_arn,
  :kms_key_id,
  :network_interface_id,
  :last_modified_time,
  :creation_time,
  :notebook_instance_lifecycle_config_name,
  :direct_internet_access,
  :volume_size_in_gb,
  :accelerator_types,
  :default_code_repository,
  :additional_code_repositories,
  :root_access)
  include Aws::Structure
end