CreatePresignedNotebookInstanceUrl
Returns a URL that you can use to connect to the Jupyter server from a notebook
instance. In the SageMaker AI console, when you choose Open next to a
notebook instance, SageMaker AI opens a new tab showing the Jupyter server home
page from the notebook instance. The console uses this API to get the URL and show the
page.
The IAM role or user used to call this API defines the permissions to access the notebook instance. 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 notebook instance.
You can restrict access to this API and to the URL that it returns to a list of IP
addresses that you specify. Use the NotIpAddress condition operator and the
aws:SourceIP condition context key to specify the list of IP addresses
that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.
Note
The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the AWS console sign-in page.
Request Syntax
{
"NotebookInstanceName": "string",
"SessionExpirationDurationInSeconds": number
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- NotebookInstanceName
-
The name of the notebook instance.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9])*Required: Yes
- SessionExpirationDurationInSeconds
-
The duration of the session, in seconds. The default is 12 hours.
Type: Integer
Valid Range: Minimum value of 1800. Maximum value of 43200.
Required: No
Response Syntax
{
"AuthorizedUrl": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- AuthorizedUrl
-
A JSON object that contains the URL string.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
