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::DescribeNotebookInstanceOutput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#accelerator_typesArray<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.

Returns:

  • (Array<String>)

    A list of the Elastic Inference (EI) instance types associated with this notebook instance.

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

    An array of up to three Git repositories associated with the notebook instance.

#creation_timeTime

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

Returns:

  • (Time)

    A timestamp.

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

    The Git repository associated with the notebook instance as its default code repository.

#direct_internet_accessString

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.

Returns:

  • (String)

    Describes whether Amazon SageMaker provides internet access to the notebook instance.

#failure_reasonString

If status is Failed, the reason it failed.

Returns:

  • (String)

    If status is Failed, the reason it failed.

#instance_typeString

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

Possible values:

  • ml.t2.medium
  • ml.t2.large
  • ml.t2.xlarge
  • ml.t2.2xlarge
  • ml.t3.medium
  • ml.t3.large
  • ml.t3.xlarge
  • ml.t3.2xlarge
  • ml.m4.xlarge
  • ml.m4.2xlarge
  • ml.m4.4xlarge
  • ml.m4.10xlarge
  • ml.m4.16xlarge
  • ml.m5.xlarge
  • ml.m5.2xlarge
  • ml.m5.4xlarge
  • ml.m5.12xlarge
  • ml.m5.24xlarge
  • ml.c4.xlarge
  • ml.c4.2xlarge
  • ml.c4.4xlarge
  • ml.c4.8xlarge
  • ml.c5.xlarge
  • ml.c5.2xlarge
  • ml.c5.4xlarge
  • ml.c5.9xlarge
  • ml.c5.18xlarge
  • ml.c5d.xlarge
  • ml.c5d.2xlarge
  • ml.c5d.4xlarge
  • ml.c5d.9xlarge
  • ml.c5d.18xlarge
  • ml.p2.xlarge
  • ml.p2.8xlarge
  • ml.p2.16xlarge
  • ml.p3.2xlarge
  • ml.p3.8xlarge
  • ml.p3.16xlarge

Returns:

  • (String)

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

#kms_key_idString

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)

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

#last_modified_timeTime

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

Returns:

  • (Time)

    A timestamp.

#network_interface_idString

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

Returns:

  • (String)

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

#notebook_instance_arnString

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

Returns:

  • (String)

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

#notebook_instance_lifecycle_config_nameString

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

Returns:

  • (String)

    Returns the name of a notebook instance lifecycle configuration.

#notebook_instance_nameString

The name of the Amazon SageMaker notebook instance.

Returns:

  • (String)

    The name of the Amazon SageMaker notebook instance.

#notebook_instance_statusString

The status of the notebook instance.

Possible values:

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

Returns:

  • (String)

    The status of the notebook instance.

#role_arnString

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

Returns:

  • (String)

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

#root_accessString

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

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.

Possible values:

  • Enabled
  • Disabled

Returns:

  • (String)

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

#security_groupsArray<String>

The IDs of the VPC security groups.

Returns:

  • (Array<String>)

    The IDs of the VPC security groups.

#subnet_idString

The ID of the VPC subnet.

Returns:

  • (String)

    The ID of the VPC subnet.

#urlString

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

Returns:

  • (String)

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

#volume_size_in_gbInteger

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

Returns:

  • (Integer)

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