import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { CreatePresignedNotebookInstanceUrlInput, CreatePresignedNotebookInstanceUrlOutput } from "../models/models_2"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link CreatePresignedNotebookInstanceUrlCommand}. */ export interface CreatePresignedNotebookInstanceUrlCommandInput extends CreatePresignedNotebookInstanceUrlInput { } /** * @public * * The output of {@link CreatePresignedNotebookInstanceUrlCommand}. */ export interface CreatePresignedNotebookInstanceUrlCommandOutput extends CreatePresignedNotebookInstanceUrlOutput, __MetadataBearer { } declare const CreatePresignedNotebookInstanceUrlCommand_base: { new (input: CreatePresignedNotebookInstanceUrlCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: CreatePresignedNotebookInstanceUrlCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { SageMakerClient, CreatePresignedNotebookInstanceUrlCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import * // const { SageMakerClient, CreatePresignedNotebookInstanceUrlCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import * const client = new SageMakerClient(config); * const input = { // CreatePresignedNotebookInstanceUrlInput * NotebookInstanceName: "STRING_VALUE", // required * SessionExpirationDurationInSeconds: Number("int"), * }; * const command = new CreatePresignedNotebookInstanceUrlCommand(input); * const response = await client.send(command); * // { // CreatePresignedNotebookInstanceUrlOutput * // AuthorizedUrl: "STRING_VALUE", * // }; * * ``` * * @param CreatePresignedNotebookInstanceUrlCommandInput - {@link CreatePresignedNotebookInstanceUrlCommandInput} * @returns {@link CreatePresignedNotebookInstanceUrlCommandOutput} * @see {@link CreatePresignedNotebookInstanceUrlCommandInput} for command's `input` shape. * @see {@link CreatePresignedNotebookInstanceUrlCommandOutput} for command's `response` shape. * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape. * * @throws {@link SageMakerServiceException} *

Base exception class for all service exceptions from SageMaker service.

* * * @public */ export declare class CreatePresignedNotebookInstanceUrlCommand extends CreatePresignedNotebookInstanceUrlCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: CreatePresignedNotebookInstanceUrlInput; output: CreatePresignedNotebookInstanceUrlOutput; }; sdk: { input: CreatePresignedNotebookInstanceUrlCommandInput; output: CreatePresignedNotebookInstanceUrlCommandOutput; }; }; }