AwsSageMakerNotebookInstanceDetails - AWS Security Hub

AwsSageMakerNotebookInstanceDetails

Provides details about an Amazon SageMaker notebook instance.

Contents

AcceleratorTypes

A list of Amazon Elastic Inference instance types to associate with the notebook instance. Currently, only one instance type can be associated with a notebook instance.

Type: Array of strings

Pattern: .*\S.*

Required: No

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 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 SageMaker notebook instances in the Amazon SageMaker Developer Guide.

Type: Array of strings

Pattern: .*\S.*

Required: No

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 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 SageMaker notebook instances in the Amazon SageMaker Developer Guide.

Type: String

Pattern: .*\S.*

Required: No

DirectInternetAccess

Sets whether SageMaker provides internet access to the notebook instance. If you set this to Disabled, this notebook instance is able to access resources only in your VPC, and is not be able to connect to SageMaker training and endpoint services unless you configure a Network Address Translation (NAT) Gateway in your VPC.

Type: String

Pattern: .*\S.*

Required: No

FailureReason

If status of the instance is Failed, the reason it failed.

Type: String

Pattern: .*\S.*

Required: No

InstanceMetadataServiceConfiguration

Information on the IMDS configuration of the notebook instance.

Type: AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails object

Required: No

InstanceType

The type of machine learning (ML) compute instance to launch for the notebook instance.

Type: String

Pattern: .*\S.*

Required: No

KmsKeyId

The Amazon Resource Name (ARN) of an AWS Key Management Service (AWS KMS) key that SageMaker uses to encrypt data on the storage volume attached to your notebook instance. The KMS key you provide must be enabled. For information, see Enabling and disabling keys in the AWS Key Management Service Developer Guide.

Type: String

Pattern: .*\S.*

Required: No

NetworkInterfaceId

The network interface ID that SageMaker created when the instance was created.

Type: String

Pattern: .*\S.*

Required: No

NotebookInstanceArn

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

Type: String

Pattern: .*\S.*

Required: No

NotebookInstanceLifecycleConfigName

The name of a notebook instance lifecycle configuration.

Type: String

Pattern: .*\S.*

Required: No

NotebookInstanceName

The name of the new notebook instance.

Type: String

Pattern: .*\S.*

Required: No

NotebookInstanceStatus

The status of the notebook instance.

Type: String

Pattern: .*\S.*

Required: No

PlatformIdentifier

The platform identifier of the notebook instance runtime environment.

Type: String

Pattern: .*\S.*

Required: No

RoleArn

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

Type: String

Pattern: .*\S.*

Required: No

RootAccess

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

Type: String

Pattern: .*\S.*

Required: No

SecurityGroups

The VPC security group IDs.

Type: Array of strings

Pattern: .*\S.*

Required: No

SubnetId

The ID of the VPC subnet to which you have a connectivity from your ML compute instance.

Type: String

Pattern: .*\S.*

Required: No

Url

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

Type: String

Pattern: .*\S.*

Required: No

VolumeSizeInGB

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

Type: Integer

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: