aws_sdk_datazone/client/
get_notebook.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetNotebook`](crate::operation::get_notebook::builders::GetNotebookFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`domain_identifier(impl Into<String>)`](crate::operation::get_notebook::builders::GetNotebookFluentBuilder::domain_identifier) / [`set_domain_identifier(Option<String>)`](crate::operation::get_notebook::builders::GetNotebookFluentBuilder::set_domain_identifier):<br>required: **true**<br><p>The identifier of the Amazon SageMaker Unified Studio domain in which the notebook exists.</p><br>
7    ///   - [`identifier(impl Into<String>)`](crate::operation::get_notebook::builders::GetNotebookFluentBuilder::identifier) / [`set_identifier(Option<String>)`](crate::operation::get_notebook::builders::GetNotebookFluentBuilder::set_identifier):<br>required: **true**<br><p>The identifier of the notebook.</p><br>
8    /// - On success, responds with [`GetNotebookOutput`](crate::operation::get_notebook::GetNotebookOutput) with field(s):
9    ///   - [`id(String)`](crate::operation::get_notebook::GetNotebookOutput::id): <p>The identifier of the notebook.</p>
10    ///   - [`name(String)`](crate::operation::get_notebook::GetNotebookOutput::name): <p>The name of the notebook.</p>
11    ///   - [`owning_project_id(String)`](crate::operation::get_notebook::GetNotebookOutput::owning_project_id): <p>The identifier of the project that owns the notebook.</p>
12    ///   - [`domain_id(String)`](crate::operation::get_notebook::GetNotebookOutput::domain_id): <p>The identifier of the Amazon SageMaker Unified Studio domain.</p>
13    ///   - [`cell_order(Vec::<CellInformation>)`](crate::operation::get_notebook::GetNotebookOutput::cell_order): <p>The ordered list of cells in the notebook.</p>
14    ///   - [`status(NotebookStatus)`](crate::operation::get_notebook::GetNotebookOutput::status): <p>The status of the notebook.</p>
15    ///   - [`description(Option<String>)`](crate::operation::get_notebook::GetNotebookOutput::description): <p>The description of the notebook.</p>
16    ///   - [`created_at(Option<DateTime>)`](crate::operation::get_notebook::GetNotebookOutput::created_at): <p>The timestamp of when the notebook was created.</p>
17    ///   - [`created_by(Option<String>)`](crate::operation::get_notebook::GetNotebookOutput::created_by): <p>The identifier of the user who created the notebook.</p>
18    ///   - [`updated_at(Option<DateTime>)`](crate::operation::get_notebook::GetNotebookOutput::updated_at): <p>The timestamp of when the notebook was last updated.</p>
19    ///   - [`updated_by(Option<String>)`](crate::operation::get_notebook::GetNotebookOutput::updated_by): <p>The identifier of the user who last updated the notebook.</p>
20    ///   - [`locked_by(Option<String>)`](crate::operation::get_notebook::GetNotebookOutput::locked_by): <p>The identifier of the user who locked the notebook.</p>
21    ///   - [`locked_at(Option<DateTime>)`](crate::operation::get_notebook::GetNotebookOutput::locked_at): <p>The timestamp of when the notebook was locked.</p>
22    ///   - [`lock_expires_at(Option<DateTime>)`](crate::operation::get_notebook::GetNotebookOutput::lock_expires_at): <p>The timestamp of when the notebook lock expires.</p>
23    ///   - [`compute_id(Option<String>)`](crate::operation::get_notebook::GetNotebookOutput::compute_id): <p>The identifier of the compute associated with the notebook.</p>
24    ///   - [`metadata(Option<HashMap::<String, String>>)`](crate::operation::get_notebook::GetNotebookOutput::metadata): <p>The metadata of the notebook.</p>
25    ///   - [`parameters(Option<HashMap::<String, String>>)`](crate::operation::get_notebook::GetNotebookOutput::parameters): <p>The sensitive parameters of the notebook.</p>
26    ///   - [`environment_configuration(Option<EnvironmentConfig>)`](crate::operation::get_notebook::GetNotebookOutput::environment_configuration): <p>The environment configuration of the notebook.</p>
27    ///   - [`error(Option<NotebookError>)`](crate::operation::get_notebook::GetNotebookOutput::error): <p>The error details if the notebook is in a failed state.</p>
28    /// - On failure, responds with [`SdkError<GetNotebookError>`](crate::operation::get_notebook::GetNotebookError)
29    pub fn get_notebook(&self) -> crate::operation::get_notebook::builders::GetNotebookFluentBuilder {
30        crate::operation::get_notebook::builders::GetNotebookFluentBuilder::new(self.handle.clone())
31    }
32}
aws_sdk_datazone/client/get_notebook.rs

aws_sdk_datazone/client/
get_notebook.rs
