Struct aws_sdk_sagemaker::client::fluent_builders::CreatePresignedNotebookInstanceUrl

pub struct CreatePresignedNotebookInstanceUrl<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to CreatePresignedNotebookInstanceUrl.

Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the Amazon SageMaker console, when you choose Open next to a notebook instance, Amazon SageMaker 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.

Implementations

impl<C, M, R> CreatePresignedNotebookInstanceUrl<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<CreatePresignedNotebookInstanceUrlOutput, SdkError<CreatePresignedNotebookInstanceUrlError>> where
    R::Policy: SmithyRetryPolicy<CreatePresignedNotebookInstanceUrlInputOperationOutputAlias, CreatePresignedNotebookInstanceUrlOutput, CreatePresignedNotebookInstanceUrlError, CreatePresignedNotebookInstanceUrlInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn notebook_instance_name(self, inp: impl Into<String>) -> Self

The name of the notebook instance.

pub fn set_notebook_instance_name(self, input: Option<String>) -> Self

The name of the notebook instance.

pub fn session_expiration_duration_in_seconds(self, inp: i32) -> Self

The duration of the session, in seconds. The default is 12 hours.

pub fn set_session_expiration_duration_in_seconds(
    self,
    input: Option<i32>
) -> Self

The duration of the session, in seconds. The default is 12 hours.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for CreatePresignedNotebookInstanceUrl<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.