Skip to content

CreatePresignedDomainUrlRequest

Source code in docs_src/capo_sagemaker/types/create_presigned_domain_url_request.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class CreatePresignedDomainUrlRequest(TypedDict, closed=True):
    domain_id: NotRequired["capo_sagemaker.types.domain_id.DomainId"]
    """<p>The domain ID.</p>"""
    user_profile_name: NotRequired[
        "capo_sagemaker.types.user_profile_name.UserProfileName"
    ]
    """<p>The name of the UserProfile to sign-in as.</p>"""
    session_expiration_duration_in_seconds: NotRequired[
        "capo_sagemaker.types.session_expiration_duration_in_seconds.SessionExpirationDurationInSeconds"
    ]
    """<p>The session expiration duration in seconds. This value defaults to 43200.</p>"""
    expires_in_seconds: NotRequired[
        "capo_sagemaker.types.expires_in_seconds.ExpiresInSeconds"
    ]
    """<p>The number of seconds until the pre-signed URL expires. This value defaults to 300.</p>"""
    space_name: NotRequired["capo_sagemaker.types.space_name.SpaceName"]
    """<p>The name of the space.</p>"""
    landing_uri: NotRequired["capo_sagemaker.types.landing_uri.LandingUri"]
    """<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>"""

domain_id instance-attribute 

domain_id: NotRequired[DomainId]

The domain ID.

expires_in_seconds instance-attribute 

expires_in_seconds: NotRequired[ExpiresInSeconds]

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

landing_uri instance-attribute 

landing_uri: NotRequired[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.

session_expiration_duration_in_seconds instance-attribute 

session_expiration_duration_in_seconds: NotRequired[SessionExpirationDurationInSeconds]

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

space_name instance-attribute 

space_name: NotRequired[SpaceName]

The name of the space.

user_profile_name instance-attribute 

user_profile_name: NotRequired[UserProfileName]

The name of the UserProfile to sign-in as.