class Aws::SageMaker::Types::DescribeNotebookInstanceOutput

@!attribute [rw] notebook_instance_arn

The Amazon Resource Name (ARN) of the notebook instance.
@return [String]

@!attribute [rw] notebook_instance_name

The name of the Amazon SageMaker notebook instance.
@return [String]

@!attribute [rw] notebook_instance_status

The status of the notebook instance.
@return [String]

@!attribute [rw] failure_reason

If status is `Failed`, the reason it failed.
@return [String]

@!attribute [rw] url

The URL that you use to connect to the Jupyter notebook that is
running in your notebook instance.
@return [String]

@!attribute [rw] instance_type

The type of ML compute instance running on the notebook instance.
@return [String]

@!attribute [rw] subnet_id

The ID of the VPC subnet.
@return [String]

@!attribute [rw] security_groups

The IDs of the VPC security groups.
@return [Array<String>]

@!attribute [rw] role_arn

The Amazon Resource Name (ARN) of the IAM role associated with the
instance.
@return [String]

@!attribute [rw] kms_key_id

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

@!attribute [rw] network_interface_id

The network interface IDs that Amazon SageMaker created at the time
of creating the instance.
@return [String]

@!attribute [rw] last_modified_time

A timestamp. Use this parameter to retrieve the time when the
notebook instance was last modified.
@return [Time]

@!attribute [rw] creation_time

A timestamp. Use this parameter to return the time when the notebook
instance was created
@return [Time]

@!attribute [rw] notebook_instance_lifecycle_config_name

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]

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

@!attribute [rw] direct_internet_access

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

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

@!attribute [rw] volume_size_in_gb

The size, in GB, of the ML storage volume attached to the notebook
instance.
@return [Integer]

@!attribute [rw] accelerator_types

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

[1]: https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html
@return [Array<String>]

@!attribute [rw] default_code_repository

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][1] 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][2].

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

@!attribute [rw] additional_code_repositories

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][1] 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][2].

[1]: https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html
[2]: https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html
@return [Array<String>]

@!attribute [rw] root_access

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>
@return [String]

@!attribute [rw] platform_identifier

The platform identifier of the notebook instance runtime
environment.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeNotebookInstanceOutput AWS API Documentation

Constants

SENSITIVE