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.
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 Amazon Web Services console sign-in page.
Parameters:
Raises:
Source code in docs_src/capo_sagemaker/_services/sage_maker.py
| def create_presigned_notebook_instance_url(
self,
*,
config_overrides: Optional[SageMakerClientConfig] = None,
notebook_instance_name: Optional[
"capo_sagemaker.types.notebook_instance_name.NotebookInstanceName"
] = None,
session_expiration_duration_in_seconds: Optional[
"capo_sagemaker.types.session_expiration_duration_in_seconds.SessionExpirationDurationInSeconds"
] = None,
) -> "capo_sagemaker.types.create_presigned_notebook_instance_url_output.CreatePresignedNotebookInstanceUrlOutput":
"""<p>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 <code>Open</code> 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.</p> <p> 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.</p> <p>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 <code>NotIpAddress</code> condition operator and the <code>aws:SourceIP</code> condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/security_iam_id-based-policy-examples.html#nbi-ip-filter">Limit Access to a Notebook Instance by IP Address</a>.</p> <note> <p>The URL that you get from a call to <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreatePresignedNotebookInstanceUrl.html">CreatePresignedNotebookInstanceUrl</a> is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the Amazon Web Services console sign-in page.</p> </note>
Args:
notebook_instance_name: <p>The name of the notebook instance.</p>
session_expiration_duration_in_seconds: <p>The duration of the session, in seconds. The default is 12 hours.</p>
Raises:
capo_sagemaker.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_sagemaker.types.create_presigned_notebook_instance_url_input.CreatePresignedNotebookInstanceUrlInput]",
) -> OperationResponse[
"capo_sagemaker.types.create_presigned_notebook_instance_url_output.CreatePresignedNotebookInstanceUrlOutput"
]:
import capo_sagemaker._operations.sage_maker.create_presigned_notebook_instance_url
output, http_response = (
capo_sagemaker._operations.sage_maker.create_presigned_notebook_instance_url.create_presigned_notebook_instance_url(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("CreatePresignedNotebookInstanceUrl")
)
input_: capo_sagemaker.types.create_presigned_notebook_instance_url_input.CreatePresignedNotebookInstanceUrlInput = {}
if notebook_instance_name is not None:
input_["notebook_instance_name"] = notebook_instance_name
if session_expiration_duration_in_seconds is not None:
input_["session_expiration_duration_in_seconds"] = (
session_expiration_duration_in_seconds
)
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|