aws_sdk_datazone/client/get_notebook_run.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 [`GetNotebookRun`](crate::operation::get_notebook_run::builders::GetNotebookRunFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`domain_identifier(impl Into<String>)`](crate::operation::get_notebook_run::builders::GetNotebookRunFluentBuilder::domain_identifier) / [`set_domain_identifier(Option<String>)`](crate::operation::get_notebook_run::builders::GetNotebookRunFluentBuilder::set_domain_identifier):<br>required: **true**<br><p>The identifier of the Amazon SageMaker Unified Studio domain in which the notebook run exists.</p><br>
7 /// - [`identifier(impl Into<String>)`](crate::operation::get_notebook_run::builders::GetNotebookRunFluentBuilder::identifier) / [`set_identifier(Option<String>)`](crate::operation::get_notebook_run::builders::GetNotebookRunFluentBuilder::set_identifier):<br>required: **true**<br><p>The identifier of the notebook run.</p><br>
8 /// - On success, responds with [`GetNotebookRunOutput`](crate::operation::get_notebook_run::GetNotebookRunOutput) with field(s):
9 /// - [`id(String)`](crate::operation::get_notebook_run::GetNotebookRunOutput::id): <p>The identifier of the notebook run.</p>
10 /// - [`domain_id(String)`](crate::operation::get_notebook_run::GetNotebookRunOutput::domain_id): <p>The identifier of the Amazon SageMaker Unified Studio domain.</p>
11 /// - [`owning_project_id(String)`](crate::operation::get_notebook_run::GetNotebookRunOutput::owning_project_id): <p>The identifier of the project that owns the notebook run.</p>
12 /// - [`notebook_id(String)`](crate::operation::get_notebook_run::GetNotebookRunOutput::notebook_id): <p>The identifier of the notebook.</p>
13 /// - [`schedule_id(Option<String>)`](crate::operation::get_notebook_run::GetNotebookRunOutput::schedule_id): <p>The identifier of the schedule associated with the notebook run.</p>
14 /// - [`status(NotebookRunStatus)`](crate::operation::get_notebook_run::GetNotebookRunOutput::status): <p>The status of the notebook run.</p>
15 /// - [`cell_order(Option<Vec::<CellInformation>>)`](crate::operation::get_notebook_run::GetNotebookRunOutput::cell_order): <p>The ordered list of cells in the notebook run.</p>
16 /// - [`metadata(Option<HashMap::<String, String>>)`](crate::operation::get_notebook_run::GetNotebookRunOutput::metadata): <p>The metadata of the notebook run.</p>
17 /// - [`parameters(Option<HashMap::<String, String>>)`](crate::operation::get_notebook_run::GetNotebookRunOutput::parameters): <p>The sensitive parameters of the notebook run.</p>
18 /// - [`compute_configuration(Option<ComputeConfig>)`](crate::operation::get_notebook_run::GetNotebookRunOutput::compute_configuration): <p>The compute configuration of the notebook run.</p>
19 /// - [`network_configuration(Option<NetworkConfig>)`](crate::operation::get_notebook_run::GetNotebookRunOutput::network_configuration): <p>The network configuration of the notebook run.</p>
20 /// - [`timeout_configuration(Option<TimeoutConfig>)`](crate::operation::get_notebook_run::GetNotebookRunOutput::timeout_configuration): <p>The timeout configuration of the notebook run.</p>
21 /// - [`environment_configuration(Option<EnvironmentConfig>)`](crate::operation::get_notebook_run::GetNotebookRunOutput::environment_configuration): <p>The environment configuration of the notebook run, including image version and package settings.</p>
22 /// - [`storage_configuration(Option<StorageConfig>)`](crate::operation::get_notebook_run::GetNotebookRunOutput::storage_configuration): <p>The storage configuration of the notebook run, including the Amazon Simple Storage Service path and KMS key ARN.</p>
23 /// - [`trigger_source(Option<TriggerSource>)`](crate::operation::get_notebook_run::GetNotebookRunOutput::trigger_source): <p>The source that triggered the notebook run.</p>
24 /// - [`error(Option<NotebookRunError>)`](crate::operation::get_notebook_run::GetNotebookRunOutput::error): <p>The error details if the notebook run failed.</p>
25 /// - [`created_at(Option<DateTime>)`](crate::operation::get_notebook_run::GetNotebookRunOutput::created_at): <p>The timestamp of when the notebook run was created.</p>
26 /// - [`created_by(Option<String>)`](crate::operation::get_notebook_run::GetNotebookRunOutput::created_by): <p>The identifier of the user who created the notebook run.</p>
27 /// - [`updated_at(Option<DateTime>)`](crate::operation::get_notebook_run::GetNotebookRunOutput::updated_at): <p>The timestamp of when the notebook run was last updated.</p>
28 /// - [`updated_by(Option<String>)`](crate::operation::get_notebook_run::GetNotebookRunOutput::updated_by): <p>The identifier of the user who last updated the notebook run.</p>
29 /// - [`started_at(Option<DateTime>)`](crate::operation::get_notebook_run::GetNotebookRunOutput::started_at): <p>The timestamp of when the notebook run started executing.</p>
30 /// - [`completed_at(Option<DateTime>)`](crate::operation::get_notebook_run::GetNotebookRunOutput::completed_at): <p>The timestamp of when the notebook run completed.</p>
31 /// - On failure, responds with [`SdkError<GetNotebookRunError>`](crate::operation::get_notebook_run::GetNotebookRunError)
32 pub fn get_notebook_run(&self) -> crate::operation::get_notebook_run::builders::GetNotebookRunFluentBuilder {
33 crate::operation::get_notebook_run::builders::GetNotebookRunFluentBuilder::new(self.handle.clone())
34 }
35}