AWS SDK Version 3 for .NET
API Reference

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.

This is the response object from the DescribeNotebookInstance operation.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.SageMaker.Model.DescribeNotebookInstanceResponse

Namespace: Amazon.SageMaker.Model
Assembly: AWSSDK.SageMaker.dll
Version: 3.x.y.z

Syntax

C#
public class DescribeNotebookInstanceResponse : AmazonWebServiceResponse

The DescribeNotebookInstanceResponse type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AcceleratorTypes System.Collections.Generic.List<System.String>

Gets and sets the property AcceleratorTypes.

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.

Public Property AdditionalCodeRepositories System.Collections.Generic.List<System.String>

Gets and sets the property AdditionalCodeRepositories.

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 Amazon Web Services 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 SageMaker Notebook Instances.

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property CreationTime System.DateTime

Gets and sets the property CreationTime.

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

Public Property DefaultCodeRepository System.String

Gets and sets the property DefaultCodeRepository.

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 Amazon Web Services 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 SageMaker Notebook Instances.

Public Property DirectInternetAccess Amazon.SageMaker.DirectInternetAccess

Gets and sets the property DirectInternetAccess.

Describes whether 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 SageMaker training and endpoint services.

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

Public Property FailureReason System.String

Gets and sets the property FailureReason.

If status is Failed, the reason it failed.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property InstanceMetadataServiceConfiguration Amazon.SageMaker.Model.InstanceMetadataServiceConfiguration

Gets and sets the property InstanceMetadataServiceConfiguration.

Information on the IMDS configuration of the notebook instance

Public Property InstanceType Amazon.SageMaker.InstanceType

Gets and sets the property InstanceType.

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

Public Property KmsKeyId System.String

Gets and sets the property KmsKeyId.

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

Public Property LastModifiedTime System.DateTime

Gets and sets the property LastModifiedTime.

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

Public Property NetworkInterfaceId System.String

Gets and sets the property NetworkInterfaceId.

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

Public Property NotebookInstanceArn System.String

Gets and sets the property NotebookInstanceArn.

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

Public Property NotebookInstanceLifecycleConfigName System.String

Gets and sets the property NotebookInstanceLifecycleConfigName.

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

Public Property NotebookInstanceName System.String

Gets and sets the property NotebookInstanceName.

The name of the SageMaker notebook instance.

Public Property NotebookInstanceStatus Amazon.SageMaker.NotebookInstanceStatus

Gets and sets the property NotebookInstanceStatus.

The status of the notebook instance.

Public Property PlatformIdentifier System.String

Gets and sets the property PlatformIdentifier.

The platform identifier of the notebook instance runtime environment.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property RoleArn System.String

Gets and sets the property RoleArn.

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

Public Property RootAccess Amazon.SageMaker.RootAccess

Gets and sets the property RootAccess.

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.

Public Property SecurityGroups System.Collections.Generic.List<System.String>

Gets and sets the property SecurityGroups.

The IDs of the VPC security groups.

Public Property SubnetId System.String

Gets and sets the property SubnetId.

The ID of the VPC subnet.

Public Property Url System.String

Gets and sets the property Url.

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

Public Property VolumeSizeInGB System.Int32

Gets and sets the property VolumeSizeInGB.

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

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5