DescribeNotebookInstanceOutput

public struct DescribeNotebookInstanceOutput : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

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

    Declaration

    Swift

    public let acceleratorTypes: [NotebookInstanceAcceleratorType]?

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

    Declaration

    Swift

    public let additionalCodeRepositories: [String]?

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

    Declaration

    Swift

    public let creationTime: TimeStamp?

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

    Declaration

    Swift

    public let defaultCodeRepository: 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.

    Declaration

    Swift

    public let directInternetAccess: DirectInternetAccess?

  • If status is Failed, the reason it failed.

    Declaration

    Swift

    public let failureReason: String?

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

    Declaration

    Swift

    public let instanceType: InstanceType?

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

    Declaration

    Swift

    public let kmsKeyId: String?

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

    Declaration

    Swift

    public let lastModifiedTime: TimeStamp?

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

    Declaration

    Swift

    public let networkInterfaceId: String?

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

    Declaration

    Swift

    public let notebookInstanceArn: 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

    Declaration

    Swift

    public let notebookInstanceLifecycleConfigName: String?

  • The name of the Amazon SageMaker notebook instance.

    Declaration

    Swift

    public let notebookInstanceName: String?

  • The status of the notebook instance.

    Declaration

    Swift

    public let notebookInstanceStatus: NotebookInstanceStatus?

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

    Declaration

    Swift

    public let roleArn: String?

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

    Declaration

    Swift

    public let rootAccess: RootAccess?

  • The IDs of the VPC security groups.

    Declaration

    Swift

    public let securityGroups: [String]?

  • The ID of the VPC subnet.

    Declaration

    Swift

    public let subnetId: String?
  • url

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

    Declaration

    Swift

    public let url: String?

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

    Declaration

    Swift

    public let volumeSizeInGB: Int?

  • Undocumented

    Declaration

    Swift

    public init(acceleratorTypes: [NotebookInstanceAcceleratorType]? = nil, additionalCodeRepositories: [String]? = nil, creationTime: TimeStamp? = nil, defaultCodeRepository: String? = nil, directInternetAccess: DirectInternetAccess? = nil, failureReason: String? = nil, instanceType: InstanceType? = nil, kmsKeyId: String? = nil, lastModifiedTime: TimeStamp? = nil, networkInterfaceId: String? = nil, notebookInstanceArn: String? = nil, notebookInstanceLifecycleConfigName: String? = nil, notebookInstanceName: String? = nil, notebookInstanceStatus: NotebookInstanceStatus? = nil, roleArn: String? = nil, rootAccess: RootAccess? = nil, securityGroups: [String]? = nil, subnetId: String? = nil, url: String? = nil, volumeSizeInGB: Int? = nil)