aws_sdk_datazone/client/
create_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 [`CreateNotebook`](crate::operation::create_notebook::builders::CreateNotebookFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`domain_identifier(impl Into<String>)`](crate::operation::create_notebook::builders::CreateNotebookFluentBuilder::domain_identifier) / [`set_domain_identifier(Option<String>)`](crate::operation::create_notebook::builders::CreateNotebookFluentBuilder::set_domain_identifier):<br>required: **true**<br><p>The identifier of the Amazon SageMaker Unified Studio domain in which to create the notebook.</p><br>
7    ///   - [`owning_project_identifier(impl Into<String>)`](crate::operation::create_notebook::builders::CreateNotebookFluentBuilder::owning_project_identifier) / [`set_owning_project_identifier(Option<String>)`](crate::operation::create_notebook::builders::CreateNotebookFluentBuilder::set_owning_project_identifier):<br>required: **true**<br><p>The identifier of the project that owns the notebook.</p><br>
8    ///   - [`name(impl Into<String>)`](crate::operation::create_notebook::builders::CreateNotebookFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_notebook::builders::CreateNotebookFluentBuilder::set_name):<br>required: **true**<br><p>The name of the notebook. The name must be between 1 and 256 characters.</p><br>
9    ///   - [`description(impl Into<String>)`](crate::operation::create_notebook::builders::CreateNotebookFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_notebook::builders::CreateNotebookFluentBuilder::set_description):<br>required: **false**<br><p>The description of the notebook.</p><br>
10    ///   - [`metadata(impl Into<String>, impl Into<String>)`](crate::operation::create_notebook::builders::CreateNotebookFluentBuilder::metadata) / [`set_metadata(Option<HashMap::<String, String>>)`](crate::operation::create_notebook::builders::CreateNotebookFluentBuilder::set_metadata):<br>required: **false**<br><p>The metadata for the notebook, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.</p><br>
11    ///   - [`parameters(impl Into<String>, impl Into<String>)`](crate::operation::create_notebook::builders::CreateNotebookFluentBuilder::parameters) / [`set_parameters(Option<HashMap::<String, String>>)`](crate::operation::create_notebook::builders::CreateNotebookFluentBuilder::set_parameters):<br>required: **false**<br><p>The sensitive parameters for the notebook, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.</p><br>
12    ///   - [`client_token(impl Into<String>)`](crate::operation::create_notebook::builders::CreateNotebookFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_notebook::builders::CreateNotebookFluentBuilder::set_client_token):<br>required: **false**<br><p>A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.</p><br>
13    /// - On success, responds with [`CreateNotebookOutput`](crate::operation::create_notebook::CreateNotebookOutput) with field(s):
14    ///   - [`id(String)`](crate::operation::create_notebook::CreateNotebookOutput::id): <p>The identifier of the notebook.</p>
15    ///   - [`name(String)`](crate::operation::create_notebook::CreateNotebookOutput::name): <p>The name of the notebook.</p>
16    ///   - [`owning_project_id(String)`](crate::operation::create_notebook::CreateNotebookOutput::owning_project_id): <p>The identifier of the project that owns the notebook.</p>
17    ///   - [`domain_id(String)`](crate::operation::create_notebook::CreateNotebookOutput::domain_id): <p>The identifier of the Amazon SageMaker Unified Studio domain.</p>
18    ///   - [`cell_order(Vec::<CellInformation>)`](crate::operation::create_notebook::CreateNotebookOutput::cell_order): <p>The ordered list of cells in the notebook.</p>
19    ///   - [`status(NotebookStatus)`](crate::operation::create_notebook::CreateNotebookOutput::status): <p>The status of the notebook.</p>
20    ///   - [`description(Option<String>)`](crate::operation::create_notebook::CreateNotebookOutput::description): <p>The description of the notebook.</p>
21    ///   - [`created_at(Option<DateTime>)`](crate::operation::create_notebook::CreateNotebookOutput::created_at): <p>The timestamp of when the notebook was created.</p>
22    ///   - [`created_by(Option<String>)`](crate::operation::create_notebook::CreateNotebookOutput::created_by): <p>The identifier of the user who created the notebook.</p>
23    ///   - [`updated_at(Option<DateTime>)`](crate::operation::create_notebook::CreateNotebookOutput::updated_at): <p>The timestamp of when the notebook was last updated.</p>
24    ///   - [`updated_by(Option<String>)`](crate::operation::create_notebook::CreateNotebookOutput::updated_by): <p>The identifier of the user who last updated the notebook.</p>
25    ///   - [`locked_by(Option<String>)`](crate::operation::create_notebook::CreateNotebookOutput::locked_by): <p>The identifier of the user who locked the notebook.</p>
26    ///   - [`locked_at(Option<DateTime>)`](crate::operation::create_notebook::CreateNotebookOutput::locked_at): <p>The timestamp of when the notebook was locked.</p>
27    ///   - [`lock_expires_at(Option<DateTime>)`](crate::operation::create_notebook::CreateNotebookOutput::lock_expires_at): <p>The timestamp of when the notebook lock expires.</p>
28    ///   - [`compute_id(Option<String>)`](crate::operation::create_notebook::CreateNotebookOutput::compute_id): <p>The identifier of the compute associated with the notebook.</p>
29    ///   - [`metadata(Option<HashMap::<String, String>>)`](crate::operation::create_notebook::CreateNotebookOutput::metadata): <p>The metadata of the notebook.</p>
30    ///   - [`parameters(Option<HashMap::<String, String>>)`](crate::operation::create_notebook::CreateNotebookOutput::parameters): <p>The sensitive parameters of the notebook.</p>
31    ///   - [`environment_configuration(Option<EnvironmentConfig>)`](crate::operation::create_notebook::CreateNotebookOutput::environment_configuration): <p>The environment configuration of the notebook.</p>
32    ///   - [`error(Option<NotebookError>)`](crate::operation::create_notebook::CreateNotebookOutput::error): <p>The error details if the notebook creation failed.</p>
33    /// - On failure, responds with [`SdkError<CreateNotebookError>`](crate::operation::create_notebook::CreateNotebookError)
34    pub fn create_notebook(&self) -> crate::operation::create_notebook::builders::CreateNotebookFluentBuilder {
35        crate::operation::create_notebook::builders::CreateNotebookFluentBuilder::new(self.handle.clone())
36    }
37}
aws_sdk_datazone/client/create_notebook.rs

aws_sdk_datazone/client/
create_notebook.rs
