SageMaker / Client / create_presigned_domain_url

create_presigned_domain_url#

SageMaker.Client.create_presigned_domain_url(**kwargs)#

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 .

Note

  • 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.

  • The JupyterLab session default expiration time is 12 hours. You can configure this value using SessionExpirationDurationInSeconds.

See also: AWS API Documentation

Request Syntax

response = client.create_presigned_domain_url(
    DomainId='string',
    UserProfileName='string',
    SessionExpirationDurationInSeconds=123,
    ExpiresInSeconds=123,
    SpaceName='string',
    LandingUri='string'
)
Parameters:

  • DomainId (string) –

    [REQUIRED]

    The domain ID.

  • UserProfileName (string) –

    [REQUIRED]

    The name of the UserProfile to sign-in as.

  • SessionExpirationDurationInSeconds (integer) – The session expiration duration in seconds. This value defaults to 43200.

  • ExpiresInSeconds (integer) – The number of seconds until the pre-signed URL expires. This value defaults to 300.

  • SpaceName (string) – The name of the space.

  • LandingUri (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.

Return type:

dict

Returns:

Response Syntax

{
    'AuthorizedUrl': 'string'
}

Response Structure

  • (dict) –

    • AuthorizedUrl (string) –

      The presigned URL.

Exceptions