#[non_exhaustive]pub struct AwsSageMakerNotebookInstanceDetails { /* private fields */ }
Expand description
Provides details about an Amazon SageMaker notebook instance.
Implementations§
source§impl AwsSageMakerNotebookInstanceDetails
impl AwsSageMakerNotebookInstanceDetails
sourcepub fn accelerator_types(&self) -> Option<&[String]>
pub fn accelerator_types(&self) -> Option<&[String]>
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.
sourcepub fn additional_code_repositories(&self) -> Option<&[String]>
pub fn additional_code_repositories(&self) -> Option<&[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 SageMaker notebook instances in the Amazon SageMaker Developer Guide.
sourcepub fn default_code_repository(&self) -> Option<&str>
pub fn default_code_repository(&self) -> Option<&str>
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.
sourcepub fn direct_internet_access(&self) -> Option<&str>
pub fn direct_internet_access(&self) -> Option<&str>
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.
sourcepub fn failure_reason(&self) -> Option<&str>
pub fn failure_reason(&self) -> Option<&str>
If status of the instance is Failed
, the reason it failed.
sourcepub fn instance_metadata_service_configuration(
&self
) -> Option<&AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails>
pub fn instance_metadata_service_configuration(
&self
) -> Option<&AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails>
Information on the IMDS configuration of the notebook instance.
sourcepub fn instance_type(&self) -> Option<&str>
pub fn instance_type(&self) -> Option<&str>
The type of machine learning (ML) compute instance to launch for the notebook instance.
sourcepub fn kms_key_id(&self) -> Option<&str>
pub fn kms_key_id(&self) -> Option<&str>
The Amazon Resource Name (ARN) of an Key Management Service (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 Key Management Service Developer Guide.
sourcepub fn network_interface_id(&self) -> Option<&str>
pub fn network_interface_id(&self) -> Option<&str>
The network interface ID that SageMaker created when the instance was created.
sourcepub fn notebook_instance_arn(&self) -> Option<&str>
pub fn notebook_instance_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the notebook instance.
sourcepub fn notebook_instance_lifecycle_config_name(&self) -> Option<&str>
pub fn notebook_instance_lifecycle_config_name(&self) -> Option<&str>
The name of a notebook instance lifecycle configuration.
sourcepub fn notebook_instance_name(&self) -> Option<&str>
pub fn notebook_instance_name(&self) -> Option<&str>
The name of the new notebook instance.
sourcepub fn notebook_instance_status(&self) -> Option<&str>
pub fn notebook_instance_status(&self) -> Option<&str>
The status of the notebook instance.
sourcepub fn platform_identifier(&self) -> Option<&str>
pub fn platform_identifier(&self) -> Option<&str>
The platform identifier of the notebook instance runtime environment.
sourcepub fn role_arn(&self) -> Option<&str>
pub fn role_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the IAM role associated with the instance.
sourcepub fn root_access(&self) -> Option<&str>
pub fn root_access(&self) -> Option<&str>
Whether root access is enabled or disabled for users of the notebook instance.
sourcepub fn security_groups(&self) -> Option<&[String]>
pub fn security_groups(&self) -> Option<&[String]>
The VPC security group IDs.
sourcepub fn subnet_id(&self) -> Option<&str>
pub fn subnet_id(&self) -> Option<&str>
The ID of the VPC subnet to which you have a connectivity from your ML compute instance.
sourcepub fn url(&self) -> Option<&str>
pub fn url(&self) -> Option<&str>
The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
sourcepub fn volume_size_in_gb(&self) -> i32
pub fn volume_size_in_gb(&self) -> i32
The size, in GB, of the ML storage volume to attach to the notebook instance.
source§impl AwsSageMakerNotebookInstanceDetails
impl AwsSageMakerNotebookInstanceDetails
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture AwsSageMakerNotebookInstanceDetails
.
Trait Implementations§
source§impl Clone for AwsSageMakerNotebookInstanceDetails
impl Clone for AwsSageMakerNotebookInstanceDetails
source§fn clone(&self) -> AwsSageMakerNotebookInstanceDetails
fn clone(&self) -> AwsSageMakerNotebookInstanceDetails
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl PartialEq<AwsSageMakerNotebookInstanceDetails> for AwsSageMakerNotebookInstanceDetails
impl PartialEq<AwsSageMakerNotebookInstanceDetails> for AwsSageMakerNotebookInstanceDetails
source§fn eq(&self, other: &AwsSageMakerNotebookInstanceDetails) -> bool
fn eq(&self, other: &AwsSageMakerNotebookInstanceDetails) -> bool
self
and other
values to be equal, and is used
by ==
.