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

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

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#creation_timeTime

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

Returns:

  • (Time)


1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 1807

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)
  include Aws::Structure
end

#direct_internet_accessString

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

For more information, see appendix-notebook-and-internet-access.

Returns:

  • (String)


1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 1807

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)
  include Aws::Structure
end

#failure_reasonString

If status is failed, the reason it failed.

Returns:

  • (String)


1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 1807

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)
  include Aws::Structure
end

#instance_typeString

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

Returns:

  • (String)


1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 1807

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)
  include Aws::Structure
end

#kms_key_idString

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

Returns:

  • (String)


1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 1807

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)
  include Aws::Structure
end

#last_modified_timeTime

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

Returns:

  • (Time)


1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 1807

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)
  include Aws::Structure
end

#network_interface_idString

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

Returns:

  • (String)


1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 1807

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)
  include Aws::Structure
end

#notebook_instance_arnString

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

Returns:

  • (String)


1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 1807

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)
  include Aws::Structure
end

#notebook_instance_lifecycle_config_nameString

Returns the name of a notebook instance lifecycle configuration.

For information about notebook instance lifestyle configurations, see notebook-lifecycle-config.

Returns:

  • (String)


1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 1807

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)
  include Aws::Structure
end

#notebook_instance_nameString

Name of the Amazon SageMaker notebook instance.

Returns:

  • (String)


1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 1807

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)
  include Aws::Structure
end

#notebook_instance_statusString

The status of the notebook instance.

Returns:

  • (String)


1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 1807

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)
  include Aws::Structure
end

#role_arnString

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

Returns:

  • (String)


1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 1807

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)
  include Aws::Structure
end

#security_groupsArray<String>

The IDs of the VPC security groups.

Returns:

  • (Array<String>)


1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 1807

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)
  include Aws::Structure
end

#subnet_idString

The ID of the VPC subnet.

Returns:

  • (String)


1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 1807

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)
  include Aws::Structure
end

#urlString

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

Returns:

  • (String)


1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 1807

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)
  include Aws::Structure
end