Struct aws_sdk_sagemaker::operation::create_presigned_domain_url::builders::CreatePresignedDomainUrlFluentBuilder

pub struct CreatePresignedDomainUrlFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreatePresignedDomainUrl.

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 (EFS) volume. This operation can only be called when the authentication mode equals IAM.

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.

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 Connect to Amazon SageMaker Studio Through an Interface VPC Endpoint .

The URL that you get from a call to CreatePresignedDomainUrl has a default timeout of 5 minutes. You can configure this value using ExpiresInSeconds. If you try to use the URL after the timeout limit expires, you are directed to the Amazon Web Services console sign-in page.

Implementations

impl CreatePresignedDomainUrlFluentBuilder

pub fn as_input(&self) -> &CreatePresignedDomainUrlInputBuilder

Access the CreatePresignedDomainUrl as a reference.

pub async fn send( self ) -> Result<CreatePresignedDomainUrlOutput, SdkError<CreatePresignedDomainUrlError, HttpResponse>>

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, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<CreatePresignedDomainUrlOutput, CreatePresignedDomainUrlError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn domain_id(self, input: impl Into<String>) -> Self

The domain ID.

pub fn set_domain_id(self, input: Option<String>) -> Self

The domain ID.

pub fn get_domain_id(&self) -> &Option<String>

The domain ID.

pub fn user_profile_name(self, input: impl Into<String>) -> Self

The name of the UserProfile to sign-in as.

pub fn set_user_profile_name(self, input: Option<String>) -> Self

The name of the UserProfile to sign-in as.

pub fn get_user_profile_name(&self) -> &Option<String>

The name of the UserProfile to sign-in as.

pub fn session_expiration_duration_in_seconds(self, input: i32) -> Self

The session expiration duration in seconds. This value defaults to 43200.

pub fn set_session_expiration_duration_in_seconds( self, input: Option<i32> ) -> Self

The session expiration duration in seconds. This value defaults to 43200.

pub fn get_session_expiration_duration_in_seconds(&self) -> &Option<i32>

The session expiration duration in seconds. This value defaults to 43200.

pub fn expires_in_seconds(self, input: i32) -> Self

The number of seconds until the pre-signed URL expires. This value defaults to 300.

pub fn set_expires_in_seconds(self, input: Option<i32>) -> Self

The number of seconds until the pre-signed URL expires. This value defaults to 300.

pub fn get_expires_in_seconds(&self) -> &Option<i32>

The number of seconds until the pre-signed URL expires. This value defaults to 300.

pub fn space_name(self, input: impl Into<String>) -> Self

The name of the space.

pub fn set_space_name(self, input: Option<String>) -> Self

The name of the space.

pub fn get_space_name(&self) -> &Option<String>

The name of the space.

pub fn landing_uri(self, input: impl Into<String>) -> Self

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:

• studio::relative/path: Directs users to the relative path in Studio.

• app:JupyterServer:relative/path: Directs users to the relative path in the Studio Classic application.

• app:JupyterLab:relative/path: Directs users to the relative path in the JupyterLab application.

• app:RStudioServerPro:relative/path: Directs users to the relative path in the RStudio application.

• app:CodeEditor:relative/path: Directs users to the relative path in the Code Editor, based on Code-OSS, Visual Studio Code - Open Source application.

• app:Canvas:relative/path: Directs users to the relative path in the Canvas application.

pub fn set_landing_uri(self, input: Option<String>) -> Self

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:

• studio::relative/path: Directs users to the relative path in Studio.

• app:JupyterServer:relative/path: Directs users to the relative path in the Studio Classic application.

• app:JupyterLab:relative/path: Directs users to the relative path in the JupyterLab application.

• app:RStudioServerPro:relative/path: Directs users to the relative path in the RStudio application.

• app:CodeEditor:relative/path: Directs users to the relative path in the Code Editor, based on Code-OSS, Visual Studio Code - Open Source application.

• app:Canvas:relative/path: Directs users to the relative path in the Canvas application.

pub fn get_landing_uri(&self) -> &Option<String>

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:

• studio::relative/path: Directs users to the relative path in Studio.

• app:JupyterServer:relative/path: Directs users to the relative path in the Studio Classic application.

• app:JupyterLab:relative/path: Directs users to the relative path in the JupyterLab application.

• app:RStudioServerPro:relative/path: Directs users to the relative path in the RStudio application.

• app:CodeEditor:relative/path: Directs users to the relative path in the Code Editor, based on Code-OSS, Visual Studio Code - Open Source application.

• app:Canvas:relative/path: Directs users to the relative path in the Canvas application.

Trait Implementations

impl Clone for CreatePresignedDomainUrlFluentBuilder

fn clone(&self) -> CreatePresignedDomainUrlFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreatePresignedDomainUrlFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.