Struct aws_sdk_sagemaker::client::fluent_builders::CreatePresignedDomainUrl

pub struct CreatePresignedDomainUrl<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

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 Amazon SageMaker Studio, 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 used to call 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 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<C, M, R> CreatePresignedDomainUrl<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<CreatePresignedDomainUrlOutput, SdkError<CreatePresignedDomainUrlError>> where
    R::Policy: SmithyRetryPolicy<CreatePresignedDomainUrlInputOperationOutputAlias, CreatePresignedDomainUrlOutput, CreatePresignedDomainUrlError, CreatePresignedDomainUrlInputOperationRetryAlias>, 

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 domain_id(self, inp: impl Into<String>) -> Self

The domain ID.

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

The domain ID.

pub fn user_profile_name(self, inp: 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 session_expiration_duration_in_seconds(self, inp: 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 expires_in_seconds(self, inp: 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.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for CreatePresignedDomainUrl<C, M, R>

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

Formats the value using the given formatter.