aws_sdk_sagemaker/client/create_presigned_domain_url.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 [`CreatePresignedDomainUrl`](crate::operation::create_presigned_domain_url::builders::CreatePresignedDomainUrlFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`domain_id(impl Into<String>)`](crate::operation::create_presigned_domain_url::builders::CreatePresignedDomainUrlFluentBuilder::domain_id) / [`set_domain_id(Option<String>)`](crate::operation::create_presigned_domain_url::builders::CreatePresignedDomainUrlFluentBuilder::set_domain_id):<br>required: **true**<br><p>The domain ID.</p><br>
7 /// - [`user_profile_name(impl Into<String>)`](crate::operation::create_presigned_domain_url::builders::CreatePresignedDomainUrlFluentBuilder::user_profile_name) / [`set_user_profile_name(Option<String>)`](crate::operation::create_presigned_domain_url::builders::CreatePresignedDomainUrlFluentBuilder::set_user_profile_name):<br>required: **true**<br><p>The name of the UserProfile to sign-in as.</p><br>
8 /// - [`session_expiration_duration_in_seconds(i32)`](crate::operation::create_presigned_domain_url::builders::CreatePresignedDomainUrlFluentBuilder::session_expiration_duration_in_seconds) / [`set_session_expiration_duration_in_seconds(Option<i32>)`](crate::operation::create_presigned_domain_url::builders::CreatePresignedDomainUrlFluentBuilder::set_session_expiration_duration_in_seconds):<br>required: **false**<br><p>The session expiration duration in seconds. This value defaults to 43200.</p><br>
9 /// - [`expires_in_seconds(i32)`](crate::operation::create_presigned_domain_url::builders::CreatePresignedDomainUrlFluentBuilder::expires_in_seconds) / [`set_expires_in_seconds(Option<i32>)`](crate::operation::create_presigned_domain_url::builders::CreatePresignedDomainUrlFluentBuilder::set_expires_in_seconds):<br>required: **false**<br><p>The number of seconds until the pre-signed URL expires. This value defaults to 300.</p><br>
10 /// - [`space_name(impl Into<String>)`](crate::operation::create_presigned_domain_url::builders::CreatePresignedDomainUrlFluentBuilder::space_name) / [`set_space_name(Option<String>)`](crate::operation::create_presigned_domain_url::builders::CreatePresignedDomainUrlFluentBuilder::set_space_name):<br>required: **false**<br><p>The name of the space.</p><br>
11 /// - [`landing_uri(impl Into<String>)`](crate::operation::create_presigned_domain_url::builders::CreatePresignedDomainUrlFluentBuilder::landing_uri) / [`set_landing_uri(Option<String>)`](crate::operation::create_presigned_domain_url::builders::CreatePresignedDomainUrlFluentBuilder::set_landing_uri):<br>required: **false**<br><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><br>
12 /// - On success, responds with [`CreatePresignedDomainUrlOutput`](crate::operation::create_presigned_domain_url::CreatePresignedDomainUrlOutput) with field(s):
13 /// - [`authorized_url(Option<String>)`](crate::operation::create_presigned_domain_url::CreatePresignedDomainUrlOutput::authorized_url): <p>The presigned URL.</p>
14 /// - On failure, responds with [`SdkError<CreatePresignedDomainUrlError>`](crate::operation::create_presigned_domain_url::CreatePresignedDomainUrlError)
15 pub fn create_presigned_domain_url(&self) -> crate::operation::create_presigned_domain_url::builders::CreatePresignedDomainUrlFluentBuilder {
16 crate::operation::create_presigned_domain_url::builders::CreatePresignedDomainUrlFluentBuilder::new(self.handle.clone())
17 }
18}