#[non_exhaustive]pub struct AwsSageMakerNotebookInstanceDetails {Show 20 fields
pub accelerator_types: Option<Vec<String>>,
pub additional_code_repositories: Option<Vec<String>>,
pub default_code_repository: Option<String>,
pub direct_internet_access: Option<String>,
pub failure_reason: Option<String>,
pub instance_metadata_service_configuration: Option<AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails>,
pub instance_type: Option<String>,
pub kms_key_id: Option<String>,
pub network_interface_id: Option<String>,
pub notebook_instance_arn: Option<String>,
pub notebook_instance_lifecycle_config_name: Option<String>,
pub notebook_instance_name: Option<String>,
pub notebook_instance_status: Option<String>,
pub platform_identifier: Option<String>,
pub role_arn: Option<String>,
pub root_access: Option<String>,
pub security_groups: Option<Vec<String>>,
pub subnet_id: Option<String>,
pub url: Option<String>,
pub volume_size_in_gb: Option<i32>,
}Expand description
Provides details about an Amazon SageMaker AI notebook instance.
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.accelerator_types: Option<Vec<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.
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 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 in the Amazon SageMaker AI Developer Guide.
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 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 in the Amazon SageMaker AI Developer Guide.
direct_internet_access: Option<String>Sets whether SageMaker AI 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 AI training and endpoint services unless you configure a Network Address Translation (NAT) Gateway in your VPC.
failure_reason: Option<String>If status of the instance is Failed, the reason it failed.
instance_metadata_service_configuration: Option<AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails>Information on the IMDS configuration of the notebook instance.
instance_type: Option<String>The type of machine learning (ML) compute instance to launch for the notebook instance.
kms_key_id: Option<String>The Amazon Resource Name (ARN) of an Key Management Service (KMS) key that SageMaker AI 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.
network_interface_id: Option<String>The network interface ID that SageMaker AI created when the instance was created.
notebook_instance_arn: Option<String>The Amazon Resource Name (ARN) of the notebook instance.
notebook_instance_lifecycle_config_name: Option<String>The name of a notebook instance lifecycle configuration.
notebook_instance_name: Option<String>The name of the new notebook instance.
notebook_instance_status: Option<String>The status of the notebook instance.
platform_identifier: Option<String>The platform identifier of the notebook instance runtime environment.
role_arn: Option<String>The Amazon Resource Name (ARN) of the IAM role associated with the instance.
root_access: Option<String>Whether root access is enabled or disabled for users of the notebook instance.
security_groups: Option<Vec<String>>The VPC security group IDs.
subnet_id: Option<String>The ID of the VPC subnet to which you have a connectivity from your ML compute instance.
url: Option<String>The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
volume_size_in_gb: Option<i32>The size, in GB, of the ML storage volume to attach to the notebook instance.
Implementations§
Source§impl AwsSageMakerNotebookInstanceDetails
impl AwsSageMakerNotebookInstanceDetails
Sourcepub fn accelerator_types(&self) -> &[String]
pub fn accelerator_types(&self) -> &[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.
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 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 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 in the Amazon SageMaker AI Developer Guide.
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 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 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 in the Amazon SageMaker AI Developer Guide.
Sourcepub fn direct_internet_access(&self) -> Option<&str>
pub fn direct_internet_access(&self) -> Option<&str>
Sets whether SageMaker AI 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 AI 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 AI 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 AI 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) -> &[String]
pub fn security_groups(&self) -> &[String]
The VPC security group IDs.
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 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) -> Option<i32>
pub fn volume_size_in_gb(&self) -> Option<i32>
The size, in GB, of the ML storage volume to attach to the notebook instance.
Source§impl AwsSageMakerNotebookInstanceDetails
impl AwsSageMakerNotebookInstanceDetails
Sourcepub fn builder() -> AwsSageMakerNotebookInstanceDetailsBuilder
pub fn builder() -> AwsSageMakerNotebookInstanceDetailsBuilder
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 for AwsSageMakerNotebookInstanceDetails
impl PartialEq 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 ==.impl StructuralPartialEq for AwsSageMakerNotebookInstanceDetails
Auto Trait Implementations§
impl Freeze for AwsSageMakerNotebookInstanceDetails
impl RefUnwindSafe for AwsSageMakerNotebookInstanceDetails
impl Send for AwsSageMakerNotebookInstanceDetails
impl Sync for AwsSageMakerNotebookInstanceDetails
impl Unpin for AwsSageMakerNotebookInstanceDetails
impl UnwindSafe for AwsSageMakerNotebookInstanceDetails
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);