Struct NotebookInstanceSummary

#[non_exhaustive]
pub struct NotebookInstanceSummary {
    pub notebook_instance_name: Option<String>,
    pub notebook_instance_arn: Option<String>,
    pub notebook_instance_status: Option<NotebookInstanceStatus>,
    pub url: Option<String>,
    pub instance_type: Option<InstanceType>,
    pub creation_time: Option<DateTime>,
    pub last_modified_time: Option<DateTime>,
    pub notebook_instance_lifecycle_config_name: Option<String>,
    pub default_code_repository: Option<String>,
    pub additional_code_repositories: Option<Vec<String>>,
}

Provides summary information for an SageMaker AI notebook instance.

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_name: Option<String>

The name of the notebook instance that you want a summary for.

notebook_instance_arn: Option<String>

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

notebook_instance_status: Option<NotebookInstanceStatus>

The status of the notebook instance.

url: Option<String>

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

instance_type: Option<InstanceType>

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

creation_time: Option<DateTime>

A timestamp that shows when the notebook instance was created.

last_modified_time: Option<DateTime>

A timestamp that shows when the notebook instance was last modified.

notebook_instance_lifecycle_config_name: Option<String>

The name of a notebook instance lifecycle configuration associated with this notebook instance.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

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 AI 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 AI Notebook Instances.

Implementations

impl NotebookInstanceSummary

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

The name of the notebook instance that you want a summary for.

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

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

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

The status of the notebook instance.

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

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

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

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

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

A timestamp that shows when the notebook instance was created.

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

A timestamp that shows when the notebook instance was last modified.

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

The name of a notebook instance lifecycle configuration associated with this notebook instance.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

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 AI 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 AI 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().

impl NotebookInstanceSummary

pub fn builder() -> NotebookInstanceSummaryBuilder

Creates a new builder-style object to manufacture NotebookInstanceSummary.

Trait Implementations

impl Clone for NotebookInstanceSummary

fn clone(&self) -> NotebookInstanceSummary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NotebookInstanceSummary

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

Formats the value using the given formatter.

impl PartialEq for NotebookInstanceSummary

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for NotebookInstanceSummary