#[non_exhaustive]pub struct DescribeNotebookInstanceOutput {Show 22 fields
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)§
This struct is marked as non-exhaustive
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 AI 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 AI 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 AI 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 AI 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 AI 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>>This parameter is no longer supported. Elastic Inference (EI) is no longer available.
This parameter was used to specify a list of the EI instance types associated with this 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.
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§
Source§impl DescribeNotebookInstanceOutput
impl DescribeNotebookInstanceOutput
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_name(&self) -> Option<&str>
pub fn notebook_instance_name(&self) -> Option<&str>
The name of the SageMaker AI notebook instance.
Sourcepub fn notebook_instance_status(&self) -> Option<&NotebookInstanceStatus>
pub fn notebook_instance_status(&self) -> Option<&NotebookInstanceStatus>
The status of the notebook instance.
Sourcepub fn failure_reason(&self) -> Option<&str>
pub fn failure_reason(&self) -> Option<&str>
If status is Failed, the reason it failed.
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 instance_type(&self) -> Option<&InstanceType>
pub fn instance_type(&self) -> Option<&InstanceType>
The type of ML compute instance running on the notebook instance.
Sourcepub fn security_groups(&self) -> &[String]
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().
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 kms_key_id(&self) -> Option<&str>
pub fn kms_key_id(&self) -> Option<&str>
The Amazon Web Services KMS key ID SageMaker AI uses to encrypt data when storing it on the ML storage volume attached to the instance.
Sourcepub fn network_interface_id(&self) -> Option<&str>
pub fn network_interface_id(&self) -> Option<&str>
The network interface IDs that SageMaker AI created at the time of creating the instance.
Sourcepub fn last_modified_time(&self) -> Option<&DateTime>
pub fn last_modified_time(&self) -> Option<&DateTime>
A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.
Sourcepub fn creation_time(&self) -> Option<&DateTime>
pub fn creation_time(&self) -> Option<&DateTime>
A timestamp. Use this parameter to return the time when the notebook instance was created
Sourcepub fn notebook_instance_lifecycle_config_name(&self) -> Option<&str>
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
Sourcepub fn direct_internet_access(&self) -> Option<&DirectInternetAccess>
pub fn direct_internet_access(&self) -> Option<&DirectInternetAccess>
Describes whether SageMaker AI 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 AI training and endpoint services.
For more information, see Notebook Instances Are Internet-Enabled by Default.
Sourcepub fn volume_size_in_gb(&self) -> Option<i32>
pub fn volume_size_in_gb(&self) -> Option<i32>
The size, in GB, of the ML storage volume attached to the notebook instance.
Sourcepub fn accelerator_types(&self) -> &[NotebookInstanceAcceleratorType]
pub fn accelerator_types(&self) -> &[NotebookInstanceAcceleratorType]
This parameter is no longer supported. Elastic Inference (EI) is no longer available.
This parameter was used to specify a list of the EI instance types associated with this notebook instance.
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().
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 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.
Sourcepub fn additional_code_repositories(&self) -> &[String]
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().
Sourcepub fn root_access(&self) -> Option<&RootAccess>
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.
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 instance_metadata_service_configuration(
&self,
) -> Option<&InstanceMetadataServiceConfiguration>
pub fn instance_metadata_service_configuration( &self, ) -> Option<&InstanceMetadataServiceConfiguration>
Information on the IMDS configuration of the notebook instance
Source§impl DescribeNotebookInstanceOutput
impl DescribeNotebookInstanceOutput
Sourcepub fn builder() -> DescribeNotebookInstanceOutputBuilder
pub fn builder() -> DescribeNotebookInstanceOutputBuilder
Creates a new builder-style object to manufacture DescribeNotebookInstanceOutput.
Trait Implementations§
Source§impl Clone for DescribeNotebookInstanceOutput
impl Clone for DescribeNotebookInstanceOutput
Source§fn clone(&self) -> DescribeNotebookInstanceOutput
fn clone(&self) -> DescribeNotebookInstanceOutput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl PartialEq for DescribeNotebookInstanceOutput
impl PartialEq for DescribeNotebookInstanceOutput
Source§fn eq(&self, other: &DescribeNotebookInstanceOutput) -> bool
fn eq(&self, other: &DescribeNotebookInstanceOutput) -> bool
self and other values to be equal, and is used by ==.Source§impl RequestId for DescribeNotebookInstanceOutput
impl RequestId for DescribeNotebookInstanceOutput
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None if the service could not be reached.impl StructuralPartialEq for DescribeNotebookInstanceOutput
Auto Trait Implementations§
impl Freeze for DescribeNotebookInstanceOutput
impl RefUnwindSafe for DescribeNotebookInstanceOutput
impl Send for DescribeNotebookInstanceOutput
impl Sync for DescribeNotebookInstanceOutput
impl Unpin for DescribeNotebookInstanceOutput
impl UnwindSafe for DescribeNotebookInstanceOutput
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);