aws_sdk_sagemaker/operation/create_presigned_domain_url/

builders.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::create_presigned_domain_url::_create_presigned_domain_url_output::CreatePresignedDomainUrlOutputBuilder;

pub use crate::operation::create_presigned_domain_url::_create_presigned_domain_url_input::CreatePresignedDomainUrlInputBuilder;

impl crate::operation::create_presigned_domain_url::builders::CreatePresignedDomainUrlInputBuilder {
    /// Sends a request with this input using the given client.
    pub async fn send_with(
        self,
        client: &crate::Client,
    ) -> ::std::result::Result<
        crate::operation::create_presigned_domain_url::CreatePresignedDomainUrlOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::create_presigned_domain_url::CreatePresignedDomainUrlError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.create_presigned_domain_url();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `CreatePresignedDomainUrl`.
///
/// <p>Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the user will be automatically signed in to the domain, and granted access to all of the Apps and files associated with the Domain's Amazon Elastic File System volume. This operation can only be called when the authentication mode equals IAM.</p>
/// <p>The IAM role or user passed to this API defines the permissions to access the app. 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 app.</p>
/// <p>You can restrict access to this API and to the URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/studio-interface-endpoint.html">Connect to Amazon SageMaker AI Studio Through an Interface VPC Endpoint</a> .</p><note>
/// <ul>
/// <li>
/// <p>The URL that you get from a call to <code>CreatePresignedDomainUrl</code> has a default timeout of 5 minutes. You can configure this value using <code>ExpiresInSeconds</code>. If you try to use the URL after the timeout limit expires, you are directed to the Amazon Web Services console sign-in page.</p></li>
/// <li>
/// <p>The JupyterLab session default expiration time is 12 hours. You can configure this value using SessionExpirationDurationInSeconds.</p></li>
/// </ul>
/// </note>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct CreatePresignedDomainUrlFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::create_presigned_domain_url::builders::CreatePresignedDomainUrlInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::create_presigned_domain_url::CreatePresignedDomainUrlOutput,
        crate::operation::create_presigned_domain_url::CreatePresignedDomainUrlError,
    > for CreatePresignedDomainUrlFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::create_presigned_domain_url::CreatePresignedDomainUrlOutput,
            crate::operation::create_presigned_domain_url::CreatePresignedDomainUrlError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl CreatePresignedDomainUrlFluentBuilder {
    /// Creates a new `CreatePresignedDomainUrlFluentBuilder`.
    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
        Self {
            handle,
            inner: ::std::default::Default::default(),
            config_override: ::std::option::Option::None,
        }
    }
    /// Access the CreatePresignedDomainUrl as a reference.
    pub fn as_input(&self) -> &crate::operation::create_presigned_domain_url::builders::CreatePresignedDomainUrlInputBuilder {
        &self.inner
    }
    /// Sends the request and returns the response.
    ///
    /// If an error occurs, an `SdkError` will be returned with additional details that
    /// can be matched against.
    ///
    /// By default, any retryable failures will be retried twice. Retry behavior
    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
    /// set when configuring the client.
    pub async fn send(
        self,
    ) -> ::std::result::Result<
        crate::operation::create_presigned_domain_url::CreatePresignedDomainUrlOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::create_presigned_domain_url::CreatePresignedDomainUrlError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let input = self
            .inner
            .build()
            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
        let runtime_plugins = crate::operation::create_presigned_domain_url::CreatePresignedDomainUrl::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::create_presigned_domain_url::CreatePresignedDomainUrl::orchestrate(&runtime_plugins, input).await
    }

    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
    pub fn customize(
        self,
    ) -> crate::client::customize::CustomizableOperation<
        crate::operation::create_presigned_domain_url::CreatePresignedDomainUrlOutput,
        crate::operation::create_presigned_domain_url::CreatePresignedDomainUrlError,
        Self,
    > {
        crate::client::customize::CustomizableOperation::new(self)
    }
    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
        self.set_config_override(::std::option::Option::Some(config_override.into()));
        self
    }

    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
        self.config_override = config_override;
        self
    }
    /// <p>The domain ID.</p>
    pub fn domain_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.domain_id(input.into());
        self
    }
    /// <p>The domain ID.</p>
    pub fn set_domain_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_domain_id(input);
        self
    }
    /// <p>The domain ID.</p>
    pub fn get_domain_id(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_domain_id()
    }
    /// <p>The name of the UserProfile to sign-in as.</p>
    pub fn user_profile_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.user_profile_name(input.into());
        self
    }
    /// <p>The name of the UserProfile to sign-in as.</p>
    pub fn set_user_profile_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_user_profile_name(input);
        self
    }
    /// <p>The name of the UserProfile to sign-in as.</p>
    pub fn get_user_profile_name(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_user_profile_name()
    }
    /// <p>The session expiration duration in seconds. This value defaults to 43200.</p>
    pub fn session_expiration_duration_in_seconds(mut self, input: i32) -> Self {
        self.inner = self.inner.session_expiration_duration_in_seconds(input);
        self
    }
    /// <p>The session expiration duration in seconds. This value defaults to 43200.</p>
    pub fn set_session_expiration_duration_in_seconds(mut self, input: ::std::option::Option<i32>) -> Self {
        self.inner = self.inner.set_session_expiration_duration_in_seconds(input);
        self
    }
    /// <p>The session expiration duration in seconds. This value defaults to 43200.</p>
    pub fn get_session_expiration_duration_in_seconds(&self) -> &::std::option::Option<i32> {
        self.inner.get_session_expiration_duration_in_seconds()
    }
    /// <p>The number of seconds until the pre-signed URL expires. This value defaults to 300.</p>
    pub fn expires_in_seconds(mut self, input: i32) -> Self {
        self.inner = self.inner.expires_in_seconds(input);
        self
    }
    /// <p>The number of seconds until the pre-signed URL expires. This value defaults to 300.</p>
    pub fn set_expires_in_seconds(mut self, input: ::std::option::Option<i32>) -> Self {
        self.inner = self.inner.set_expires_in_seconds(input);
        self
    }
    /// <p>The number of seconds until the pre-signed URL expires. This value defaults to 300.</p>
    pub fn get_expires_in_seconds(&self) -> &::std::option::Option<i32> {
        self.inner.get_expires_in_seconds()
    }
    /// <p>The name of the space.</p>
    pub fn space_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.space_name(input.into());
        self
    }
    /// <p>The name of the space.</p>
    pub fn set_space_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_space_name(input);
        self
    }
    /// <p>The name of the space.</p>
    pub fn get_space_name(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_space_name()
    }
    /// <p>The landing page that the user is directed to when accessing the presigned URL. Using this value, users can access Studio or Studio Classic, even if it is not the default experience for the domain. The supported values are:</p>
    /// <ul>
    /// <li>
    /// <p><code>studio::relative/path</code>: Directs users to the relative path in Studio.</p></li>
    /// <li>
    /// <p><code>app:JupyterServer:relative/path</code>: Directs users to the relative path in the Studio Classic application.</p></li>
    /// <li>
    /// <p><code>app:JupyterLab:relative/path</code>: Directs users to the relative path in the JupyterLab application.</p></li>
    /// <li>
    /// <p><code>app:RStudioServerPro:relative/path</code>: Directs users to the relative path in the RStudio application.</p></li>
    /// <li>
    /// <p><code>app:CodeEditor:relative/path</code>: Directs users to the relative path in the Code Editor, based on Code-OSS, Visual Studio Code - Open Source application.</p></li>
    /// <li>
    /// <p><code>app:Canvas:relative/path</code>: Directs users to the relative path in the Canvas application.</p></li>
    /// </ul>
    pub fn landing_uri(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.landing_uri(input.into());
        self
    }
    /// <p>The landing page that the user is directed to when accessing the presigned URL. Using this value, users can access Studio or Studio Classic, even if it is not the default experience for the domain. The supported values are:</p>
    /// <ul>
    /// <li>
    /// <p><code>studio::relative/path</code>: Directs users to the relative path in Studio.</p></li>
    /// <li>
    /// <p><code>app:JupyterServer:relative/path</code>: Directs users to the relative path in the Studio Classic application.</p></li>
    /// <li>
    /// <p><code>app:JupyterLab:relative/path</code>: Directs users to the relative path in the JupyterLab application.</p></li>
    /// <li>
    /// <p><code>app:RStudioServerPro:relative/path</code>: Directs users to the relative path in the RStudio application.</p></li>
    /// <li>
    /// <p><code>app:CodeEditor:relative/path</code>: Directs users to the relative path in the Code Editor, based on Code-OSS, Visual Studio Code - Open Source application.</p></li>
    /// <li>
    /// <p><code>app:Canvas:relative/path</code>: Directs users to the relative path in the Canvas application.</p></li>
    /// </ul>
    pub fn set_landing_uri(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_landing_uri(input);
        self
    }
    /// <p>The landing page that the user is directed to when accessing the presigned URL. Using this value, users can access Studio or Studio Classic, even if it is not the default experience for the domain. The supported values are:</p>
    /// <ul>
    /// <li>
    /// <p><code>studio::relative/path</code>: Directs users to the relative path in Studio.</p></li>
    /// <li>
    /// <p><code>app:JupyterServer:relative/path</code>: Directs users to the relative path in the Studio Classic application.</p></li>
    /// <li>
    /// <p><code>app:JupyterLab:relative/path</code>: Directs users to the relative path in the JupyterLab application.</p></li>
    /// <li>
    /// <p><code>app:RStudioServerPro:relative/path</code>: Directs users to the relative path in the RStudio application.</p></li>
    /// <li>
    /// <p><code>app:CodeEditor:relative/path</code>: Directs users to the relative path in the Code Editor, based on Code-OSS, Visual Studio Code - Open Source application.</p></li>
    /// <li>
    /// <p><code>app:Canvas:relative/path</code>: Directs users to the relative path in the Canvas application.</p></li>
    /// </ul>
    pub fn get_landing_uri(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_landing_uri()
    }
}