Struct aws_sdk_sagemaker::operation::describe_notebook_instance::DescribeNotebookInstanceOutput

#[non_exhaustive]
pub struct DescribeNotebookInstanceOutput {

    pub notebook_instance_arn: Option<String>,
    pub notebook_instance_name: Option<String>,
    pub notebook_instance_status: Option<NotebookInstanceStatus>,
    pub failure_reason: Option<String>,
    pub url: Option<String>,
    pub instance_type: Option<InstanceType>,
    pub subnet_id: Option<String>,
    pub security_groups: Option<Vec<String>>,
    pub role_arn: Option<String>,
    pub kms_key_id: Option<String>,
    pub network_interface_id: Option<String>,
    pub last_modified_time: Option<DateTime>,
    pub creation_time: Option<DateTime>,
    pub notebook_instance_lifecycle_config_name: Option<String>,
    pub direct_internet_access: Option<DirectInternetAccess>,
    pub volume_size_in_gb: Option<i32>,
    pub accelerator_types: Option<Vec<NotebookInstanceAcceleratorType>>,
    pub default_code_repository: Option<String>,
    pub additional_code_repositories: Option<Vec<String>>,
    pub root_access: Option<RootAccess>,
    pub platform_identifier: Option<String>,
    pub instance_metadata_service_configuration: Option<InstanceMetadataServiceConfiguration>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

notebook_instance_arn: Option<String>

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

notebook_instance_name: Option<String>

The name of the SageMaker notebook instance.

notebook_instance_status: Option<NotebookInstanceStatus>

The status of the notebook instance.

failure_reason: Option<String>

If status is Failed, the reason it failed.

url: Option<String>

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

instance_type: Option<InstanceType>

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

subnet_id: Option<String>

The ID of the VPC subnet.

security_groups: Option<Vec<String>>

The IDs of the VPC security groups.

role_arn: Option<String>

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

kms_key_id: Option<String>

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

network_interface_id: Option<String>

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

last_modified_time: Option<DateTime>

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

creation_time: Option<DateTime>

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

notebook_instance_lifecycle_config_name: Option<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

direct_internet_access: Option<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.

volume_size_in_gb: Option<i32>

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

accelerator_types: Option<Vec<NotebookInstanceAcceleratorType>>

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.

default_code_repository: Option<String>

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.

additional_code_repositories: Option<Vec<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 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.

root_access: Option<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.

platform_identifier: Option<String>

The platform identifier of the notebook instance runtime environment.

instance_metadata_service_configuration: Option<InstanceMetadataServiceConfiguration>

Information on the IMDS configuration of the notebook instance

Implementations

impl DescribeNotebookInstanceOutput

pub fn notebook_instance_arn(&self) -> Option<&str>

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

pub fn notebook_instance_name(&self) -> Option<&str>

The name of the SageMaker notebook instance.

pub fn notebook_instance_status(&self) -> Option<&NotebookInstanceStatus>

The status of the notebook instance.

pub fn failure_reason(&self) -> Option<&str>

If status is Failed, the reason it failed.

pub fn url(&self) -> Option<&str>

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

pub fn instance_type(&self) -> Option<&InstanceType>

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

pub fn subnet_id(&self) -> Option<&str>

The ID of the VPC subnet.

pub fn security_groups(&self) -> &[String]

The IDs of the VPC security groups.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .security_groups.is_none().

pub fn role_arn(&self) -> Option<&str>

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

pub fn kms_key_id(&self) -> Option<&str>

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

pub fn network_interface_id(&self) -> Option<&str>

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

pub fn last_modified_time(&self) -> Option<&DateTime>

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

pub fn creation_time(&self) -> Option<&DateTime>

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

pub fn notebook_instance_lifecycle_config_name(&self) -> Option<&str>

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

pub fn direct_internet_access(&self) -> Option<&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.

pub fn volume_size_in_gb(&self) -> Option<i32>

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

pub fn accelerator_types(&self) -> &[NotebookInstanceAcceleratorType]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .accelerator_types.is_none().

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

pub fn additional_code_repositories(&self) -> &[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 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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .additional_code_repositories.is_none().

pub fn root_access(&self) -> Option<&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.

pub fn platform_identifier(&self) -> Option<&str>

The platform identifier of the notebook instance runtime environment.

pub fn instance_metadata_service_configuration( &self ) -> Option<&InstanceMetadataServiceConfiguration>

Information on the IMDS configuration of the notebook instance

impl DescribeNotebookInstanceOutput

pub fn builder() -> DescribeNotebookInstanceOutputBuilder

Creates a new builder-style object to manufacture DescribeNotebookInstanceOutput.

Trait Implementations

impl Clone for DescribeNotebookInstanceOutput

fn clone(&self) -> DescribeNotebookInstanceOutput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeNotebookInstanceOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for DescribeNotebookInstanceOutput

fn eq(&self, other: &DescribeNotebookInstanceOutput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for DescribeNotebookInstanceOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for DescribeNotebookInstanceOutput