libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SageMaker.CreatePresignedNotebookInstanceUrl

Description

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.

Synopsis

Creating a Request

data CreatePresignedNotebookInstanceUrl Source #

Constructors

CreatePresignedNotebookInstanceUrl' 

Fields

Instances

Instances details
Eq CreatePresignedNotebookInstanceUrl Source # 
Instance details

Defined in Amazonka.SageMaker.CreatePresignedNotebookInstanceUrl

Read CreatePresignedNotebookInstanceUrl Source # 
Instance details

Defined in Amazonka.SageMaker.CreatePresignedNotebookInstanceUrl

Show CreatePresignedNotebookInstanceUrl Source # 
Instance details

Defined in Amazonka.SageMaker.CreatePresignedNotebookInstanceUrl

Generic CreatePresignedNotebookInstanceUrl Source # 
Instance details

Defined in Amazonka.SageMaker.CreatePresignedNotebookInstanceUrl

Associated Types

type Rep CreatePresignedNotebookInstanceUrl :: Type -> Type #

NFData CreatePresignedNotebookInstanceUrl Source # 
Instance details

Defined in Amazonka.SageMaker.CreatePresignedNotebookInstanceUrl

Hashable CreatePresignedNotebookInstanceUrl Source # 
Instance details

Defined in Amazonka.SageMaker.CreatePresignedNotebookInstanceUrl

ToJSON CreatePresignedNotebookInstanceUrl Source # 
Instance details

Defined in Amazonka.SageMaker.CreatePresignedNotebookInstanceUrl

AWSRequest CreatePresignedNotebookInstanceUrl Source # 
Instance details

Defined in Amazonka.SageMaker.CreatePresignedNotebookInstanceUrl

ToHeaders CreatePresignedNotebookInstanceUrl Source # 
Instance details

Defined in Amazonka.SageMaker.CreatePresignedNotebookInstanceUrl

ToPath CreatePresignedNotebookInstanceUrl Source # 
Instance details

Defined in Amazonka.SageMaker.CreatePresignedNotebookInstanceUrl

ToQuery CreatePresignedNotebookInstanceUrl Source # 
Instance details

Defined in Amazonka.SageMaker.CreatePresignedNotebookInstanceUrl

type Rep CreatePresignedNotebookInstanceUrl Source # 
Instance details

Defined in Amazonka.SageMaker.CreatePresignedNotebookInstanceUrl

type Rep CreatePresignedNotebookInstanceUrl = D1 ('MetaData "CreatePresignedNotebookInstanceUrl" "Amazonka.SageMaker.CreatePresignedNotebookInstanceUrl" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "CreatePresignedNotebookInstanceUrl'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sessionExpirationDurationInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "notebookInstanceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse CreatePresignedNotebookInstanceUrl Source # 
Instance details

Defined in Amazonka.SageMaker.CreatePresignedNotebookInstanceUrl

newCreatePresignedNotebookInstanceUrl Source #

Create a value of CreatePresignedNotebookInstanceUrl with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:sessionExpirationDurationInSeconds:CreatePresignedNotebookInstanceUrl', createPresignedNotebookInstanceUrl_sessionExpirationDurationInSeconds - The duration of the session, in seconds. The default is 12 hours.

$sel:notebookInstanceName:CreatePresignedNotebookInstanceUrl', createPresignedNotebookInstanceUrl_notebookInstanceName - The name of the notebook instance.

Request Lenses

Destructuring the Response

data CreatePresignedNotebookInstanceUrlResponse Source #

Constructors

CreatePresignedNotebookInstanceUrlResponse' 

Fields

Instances

Instances details
Eq CreatePresignedNotebookInstanceUrlResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreatePresignedNotebookInstanceUrl

Read CreatePresignedNotebookInstanceUrlResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreatePresignedNotebookInstanceUrl

Show CreatePresignedNotebookInstanceUrlResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreatePresignedNotebookInstanceUrl

Generic CreatePresignedNotebookInstanceUrlResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreatePresignedNotebookInstanceUrl

NFData CreatePresignedNotebookInstanceUrlResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreatePresignedNotebookInstanceUrl

type Rep CreatePresignedNotebookInstanceUrlResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreatePresignedNotebookInstanceUrl

type Rep CreatePresignedNotebookInstanceUrlResponse = D1 ('MetaData "CreatePresignedNotebookInstanceUrlResponse" "Amazonka.SageMaker.CreatePresignedNotebookInstanceUrl" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "CreatePresignedNotebookInstanceUrlResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "authorizedUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreatePresignedNotebookInstanceUrlResponse Source #

Create a value of CreatePresignedNotebookInstanceUrlResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:authorizedUrl:CreatePresignedNotebookInstanceUrlResponse', createPresignedNotebookInstanceUrlResponse_authorizedUrl - A JSON object that contains the URL string.

$sel:httpStatus:CreatePresignedNotebookInstanceUrlResponse', createPresignedNotebookInstanceUrlResponse_httpStatus - The response's http status code.

Response Lenses