AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreatePresignedDomainUrl operation. 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.

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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SageMaker.AmazonSageMakerRequest
      Amazon.SageMaker.Model.CreatePresignedDomainUrlRequest

Namespace: Amazon.SageMaker.Model
Assembly: AWSSDK.SageMaker.dll
Version: 3.x.y.z

Syntax

C# 
public class CreatePresignedDomainUrlRequest : AmazonSageMakerRequest
         IAmazonWebServiceRequest

The CreatePresignedDomainUrlRequest type exposes the following members

Constructors

NameDescription
Public Method CreatePresignedDomainUrlRequest()

Properties

NameTypeDescription
Public Property DomainId System.String

Gets and sets the property DomainId.

The domain ID.

Public Property ExpiresInSeconds System.Int32

Gets and sets the property ExpiresInSeconds.

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

Public Property LandingUri System.String

Gets and sets the property LandingUri.

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.

Public Property SessionExpirationDurationInSeconds System.Int32

Gets and sets the property SessionExpirationDurationInSeconds.

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

Public Property SpaceName System.String

Gets and sets the property SpaceName.

The name of the space.

Public Property UserProfileName System.String

Gets and sets the property UserProfileName.

The name of the UserProfile to sign-in as.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5