aws_sdk_sagemaker/operation/create_presigned_notebook_instance_url/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_presigned_notebook_instance_url::_create_presigned_notebook_instance_url_output::CreatePresignedNotebookInstanceUrlOutputBuilder;
3
4pub use crate::operation::create_presigned_notebook_instance_url::_create_presigned_notebook_instance_url_input::CreatePresignedNotebookInstanceUrlInputBuilder;
5
6impl crate::operation::create_presigned_notebook_instance_url::builders::CreatePresignedNotebookInstanceUrlInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::create_presigned_notebook_instance_url::CreatePresignedNotebookInstanceUrlOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_presigned_notebook_instance_url::CreatePresignedNotebookInstanceUrlError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_presigned_notebook_instance_url();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreatePresignedNotebookInstanceUrl`.
24///
25/// <p>Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the SageMaker AI console, when you choose <code>Open</code> next to a notebook instance, SageMaker AI opens a new tab showing the Jupyter server home page from the notebook instance. The console uses this API to get the URL and show the page.</p>
26/// <p>The IAM role or user used to call this API defines the permissions to access the notebook instance. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance.</p>
27/// <p>You can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. Use the <code>NotIpAddress</code> condition operator and the <code>aws:SourceIP</code> condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/security_iam_id-based-policy-examples.html#nbi-ip-filter">Limit Access to a Notebook Instance by IP Address</a>.</p><note>
28/// <p>The URL that you get from a call to <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreatePresignedNotebookInstanceUrl.html">CreatePresignedNotebookInstanceUrl</a> is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the Amazon Web Services console sign-in page.</p>
29/// </note>
30#[derive(::std::clone::Clone, ::std::fmt::Debug)]
31pub struct CreatePresignedNotebookInstanceUrlFluentBuilder {
32    handle: ::std::sync::Arc<crate::client::Handle>,
33    inner: crate::operation::create_presigned_notebook_instance_url::builders::CreatePresignedNotebookInstanceUrlInputBuilder,
34    config_override: ::std::option::Option<crate::config::Builder>,
35}
36impl
37    crate::client::customize::internal::CustomizableSend<
38        crate::operation::create_presigned_notebook_instance_url::CreatePresignedNotebookInstanceUrlOutput,
39        crate::operation::create_presigned_notebook_instance_url::CreatePresignedNotebookInstanceUrlError,
40    > for CreatePresignedNotebookInstanceUrlFluentBuilder
41{
42    fn send(
43        self,
44        config_override: crate::config::Builder,
45    ) -> crate::client::customize::internal::BoxFuture<
46        crate::client::customize::internal::SendResult<
47            crate::operation::create_presigned_notebook_instance_url::CreatePresignedNotebookInstanceUrlOutput,
48            crate::operation::create_presigned_notebook_instance_url::CreatePresignedNotebookInstanceUrlError,
49        >,
50    > {
51        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
52    }
53}
54impl CreatePresignedNotebookInstanceUrlFluentBuilder {
55    /// Creates a new `CreatePresignedNotebookInstanceUrlFluentBuilder`.
56    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
57        Self {
58            handle,
59            inner: ::std::default::Default::default(),
60            config_override: ::std::option::Option::None,
61        }
62    }
63    /// Access the CreatePresignedNotebookInstanceUrl as a reference.
64    pub fn as_input(&self) -> &crate::operation::create_presigned_notebook_instance_url::builders::CreatePresignedNotebookInstanceUrlInputBuilder {
65        &self.inner
66    }
67    /// Sends the request and returns the response.
68    ///
69    /// If an error occurs, an `SdkError` will be returned with additional details that
70    /// can be matched against.
71    ///
72    /// By default, any retryable failures will be retried twice. Retry behavior
73    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
74    /// set when configuring the client.
75    pub async fn send(
76        self,
77    ) -> ::std::result::Result<
78        crate::operation::create_presigned_notebook_instance_url::CreatePresignedNotebookInstanceUrlOutput,
79        ::aws_smithy_runtime_api::client::result::SdkError<
80            crate::operation::create_presigned_notebook_instance_url::CreatePresignedNotebookInstanceUrlError,
81            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
82        >,
83    > {
84        let input = self
85            .inner
86            .build()
87            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
88        let runtime_plugins = crate::operation::create_presigned_notebook_instance_url::CreatePresignedNotebookInstanceUrl::operation_runtime_plugins(
89            self.handle.runtime_plugins.clone(),
90            &self.handle.conf,
91            self.config_override,
92        );
93        crate::operation::create_presigned_notebook_instance_url::CreatePresignedNotebookInstanceUrl::orchestrate(&runtime_plugins, input).await
94    }
95
96    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
97    pub fn customize(
98        self,
99    ) -> crate::client::customize::CustomizableOperation<
100        crate::operation::create_presigned_notebook_instance_url::CreatePresignedNotebookInstanceUrlOutput,
101        crate::operation::create_presigned_notebook_instance_url::CreatePresignedNotebookInstanceUrlError,
102        Self,
103    > {
104        crate::client::customize::CustomizableOperation::new(self)
105    }
106    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
107        self.set_config_override(::std::option::Option::Some(config_override.into()));
108        self
109    }
110
111    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
112        self.config_override = config_override;
113        self
114    }
115    /// <p>The name of the notebook instance.</p>
116    pub fn notebook_instance_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
117        self.inner = self.inner.notebook_instance_name(input.into());
118        self
119    }
120    /// <p>The name of the notebook instance.</p>
121    pub fn set_notebook_instance_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
122        self.inner = self.inner.set_notebook_instance_name(input);
123        self
124    }
125    /// <p>The name of the notebook instance.</p>
126    pub fn get_notebook_instance_name(&self) -> &::std::option::Option<::std::string::String> {
127        self.inner.get_notebook_instance_name()
128    }
129    /// <p>The duration of the session, in seconds. The default is 12 hours.</p>
130    pub fn session_expiration_duration_in_seconds(mut self, input: i32) -> Self {
131        self.inner = self.inner.session_expiration_duration_in_seconds(input);
132        self
133    }
134    /// <p>The duration of the session, in seconds. The default is 12 hours.</p>
135    pub fn set_session_expiration_duration_in_seconds(mut self, input: ::std::option::Option<i32>) -> Self {
136        self.inner = self.inner.set_session_expiration_duration_in_seconds(input);
137        self
138    }
139    /// <p>The duration of the session, in seconds. The default is 12 hours.</p>
140    pub fn get_session_expiration_duration_in_seconds(&self) -> &::std::option::Option<i32> {
141        self.inner.get_session_expiration_duration_in_seconds()
142    }
143}
aws_sdk_sagemaker/operation/create_presigned_notebook_instance_url/builders.rs

aws_sdk_sagemaker/operation/create_presigned_notebook_instance_url/
builders.rs
