Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SageMaker.CreatePresignedDomainUrl

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the user will be automatically signed in to Amazon SageMaker Studio, and granted access to all of the Apps and files associated with the Domain's Amazon Elastic File System (EFS) volume. This operation can only be called when the authentication mode equals IAM.

The IAM role or user used to call this API defines the permissions to access the app. 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 app.

You can restrict access to this API and to the URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more information, see Connect to SageMaker Studio Through an Interface VPC Endpoint .

The URL that you get from a call to CreatePresignedDomainUrl has a default timeout of 5 minutes. You can configure this value using ExpiresInSeconds. If you try to use the URL after the timeout limit expires, you are directed to the Amazon Web Services console sign-in page.

Synopsis

data CreatePresignedDomainUrl = CreatePresignedDomainUrl' {
- sessionExpirationDurationInSeconds :: Maybe Natural
- expiresInSeconds :: Maybe Natural
- domainId :: Text
- userProfileName :: Text
}
newCreatePresignedDomainUrl :: Text -> Text -> CreatePresignedDomainUrl
createPresignedDomainUrl_sessionExpirationDurationInSeconds :: Lens' CreatePresignedDomainUrl (Maybe Natural)
createPresignedDomainUrl_expiresInSeconds :: Lens' CreatePresignedDomainUrl (Maybe Natural)
createPresignedDomainUrl_domainId :: Lens' CreatePresignedDomainUrl Text
createPresignedDomainUrl_userProfileName :: Lens' CreatePresignedDomainUrl Text
data CreatePresignedDomainUrlResponse = CreatePresignedDomainUrlResponse' {
- authorizedUrl :: Maybe Text
- httpStatus :: Int
}
newCreatePresignedDomainUrlResponse :: Int -> CreatePresignedDomainUrlResponse
createPresignedDomainUrlResponse_authorizedUrl :: Lens' CreatePresignedDomainUrlResponse (Maybe Text)
createPresignedDomainUrlResponse_httpStatus :: Lens' CreatePresignedDomainUrlResponse Int

Creating a Request

data CreatePresignedDomainUrl Source #

See: newCreatePresignedDomainUrl smart constructor.

Constructors

CreatePresignedDomainUrl'
Fields sessionExpirationDurationInSeconds :: Maybe Natural The session expiration duration in seconds. This value defaults to 43200. expiresInSeconds :: Maybe Natural The number of seconds until the pre-signed URL expires. This value defaults to 300. domainId :: Text The domain ID. userProfileName :: Text The name of the UserProfile to sign-in as.

Instances

Instances details

Eq CreatePresignedDomainUrl Source #
Instance details Defined in Amazonka.SageMaker.CreatePresignedDomainUrl Methods (==) :: CreatePresignedDomainUrl -> CreatePresignedDomainUrl -> Bool # (/=) :: CreatePresignedDomainUrl -> CreatePresignedDomainUrl -> Bool #
Read CreatePresignedDomainUrl Source #
Instance details Defined in Amazonka.SageMaker.CreatePresignedDomainUrl Methods readsPrec :: Int -> ReadS CreatePresignedDomainUrl # readList :: ReadS [CreatePresignedDomainUrl] # readPrec :: ReadPrec CreatePresignedDomainUrl # readListPrec :: ReadPrec [CreatePresignedDomainUrl] #
Show CreatePresignedDomainUrl Source #
Instance details Defined in Amazonka.SageMaker.CreatePresignedDomainUrl Methods showsPrec :: Int -> CreatePresignedDomainUrl -> ShowS # show :: CreatePresignedDomainUrl -> String # showList :: [CreatePresignedDomainUrl] -> ShowS #
Generic CreatePresignedDomainUrl Source #
Instance details Defined in Amazonka.SageMaker.CreatePresignedDomainUrl Associated Types type Rep CreatePresignedDomainUrl :: Type -> Type # Methods from :: CreatePresignedDomainUrl -> Rep CreatePresignedDomainUrl x # to :: Rep CreatePresignedDomainUrl x -> CreatePresignedDomainUrl #
NFData CreatePresignedDomainUrl Source #
Instance details Defined in Amazonka.SageMaker.CreatePresignedDomainUrl Methods rnf :: CreatePresignedDomainUrl -> () #
Hashable CreatePresignedDomainUrl Source #
Instance details Defined in Amazonka.SageMaker.CreatePresignedDomainUrl Methods hashWithSalt :: Int -> CreatePresignedDomainUrl -> Int # hash :: CreatePresignedDomainUrl -> Int #
ToJSON CreatePresignedDomainUrl Source #
Instance details Defined in Amazonka.SageMaker.CreatePresignedDomainUrl Methods toJSON :: CreatePresignedDomainUrl -> Value # toEncoding :: CreatePresignedDomainUrl -> Encoding # toJSONList :: [CreatePresignedDomainUrl] -> Value # toEncodingList :: [CreatePresignedDomainUrl] -> Encoding #
AWSRequest CreatePresignedDomainUrl Source #
Instance details Defined in Amazonka.SageMaker.CreatePresignedDomainUrl Associated Types type AWSResponse CreatePresignedDomainUrl # Methods request :: CreatePresignedDomainUrl -> Request CreatePresignedDomainUrl # response :: MonadResource m => Logger -> Service -> Proxy CreatePresignedDomainUrl -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreatePresignedDomainUrl))) #
ToHeaders CreatePresignedDomainUrl Source #
Instance details Defined in Amazonka.SageMaker.CreatePresignedDomainUrl Methods toHeaders :: CreatePresignedDomainUrl -> [Header] #
ToPath CreatePresignedDomainUrl Source #
Instance details Defined in Amazonka.SageMaker.CreatePresignedDomainUrl Methods toPath :: CreatePresignedDomainUrl -> ByteString #
ToQuery CreatePresignedDomainUrl Source #
Instance details Defined in Amazonka.SageMaker.CreatePresignedDomainUrl Methods toQuery :: CreatePresignedDomainUrl -> QueryString #
type Rep CreatePresignedDomainUrl Source #
Instance details Defined in Amazonka.SageMaker.CreatePresignedDomainUrl type Rep CreatePresignedDomainUrl = D1 ('MetaData "CreatePresignedDomainUrl" "Amazonka.SageMaker.CreatePresignedDomainUrl" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "CreatePresignedDomainUrl'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sessionExpirationDurationInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "expiresInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "domainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userProfileName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse CreatePresignedDomainUrl Source #
Instance details Defined in Amazonka.SageMaker.CreatePresignedDomainUrl type AWSResponse CreatePresignedDomainUrl = CreatePresignedDomainUrlResponse

newCreatePresignedDomainUrl Source #

Arguments

:: Text	`$sel:domainId:CreatePresignedDomainUrl'`
-> Text	`$sel:userProfileName:CreatePresignedDomainUrl'`
-> CreatePresignedDomainUrl

Create a value of CreatePresignedDomainUrl 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:CreatePresignedDomainUrl', createPresignedDomainUrl_sessionExpirationDurationInSeconds - The session expiration duration in seconds. This value defaults to 43200.

$sel:expiresInSeconds:CreatePresignedDomainUrl', createPresignedDomainUrl_expiresInSeconds - The number of seconds until the pre-signed URL expires. This value defaults to 300.

$sel:domainId:CreatePresignedDomainUrl', createPresignedDomainUrl_domainId - The domain ID.

$sel:userProfileName:CreatePresignedDomainUrl', createPresignedDomainUrl_userProfileName - The name of the UserProfile to sign-in as.

Request Lenses

createPresignedDomainUrl_sessionExpirationDurationInSeconds :: Lens' CreatePresignedDomainUrl (Maybe Natural) Source #

The session expiration duration in seconds. This value defaults to 43200.

createPresignedDomainUrl_expiresInSeconds :: Lens' CreatePresignedDomainUrl (Maybe Natural) Source #

The number of seconds until the pre-signed URL expires. This value defaults to 300.

createPresignedDomainUrl_domainId :: Lens' CreatePresignedDomainUrl Text Source #

The domain ID.

createPresignedDomainUrl_userProfileName :: Lens' CreatePresignedDomainUrl Text Source #

The name of the UserProfile to sign-in as.

Destructuring the Response

data CreatePresignedDomainUrlResponse Source #

See: newCreatePresignedDomainUrlResponse smart constructor.

Constructors

CreatePresignedDomainUrlResponse'
Fields authorizedUrl :: Maybe Text The presigned URL. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreatePresignedDomainUrlResponse Source #
Instance details Defined in Amazonka.SageMaker.CreatePresignedDomainUrl Methods (==) :: CreatePresignedDomainUrlResponse -> CreatePresignedDomainUrlResponse -> Bool # (/=) :: CreatePresignedDomainUrlResponse -> CreatePresignedDomainUrlResponse -> Bool #
Read CreatePresignedDomainUrlResponse Source #
Instance details Defined in Amazonka.SageMaker.CreatePresignedDomainUrl Methods readsPrec :: Int -> ReadS CreatePresignedDomainUrlResponse # readList :: ReadS [CreatePresignedDomainUrlResponse] # readPrec :: ReadPrec CreatePresignedDomainUrlResponse # readListPrec :: ReadPrec [CreatePresignedDomainUrlResponse] #
Show CreatePresignedDomainUrlResponse Source #
Instance details Defined in Amazonka.SageMaker.CreatePresignedDomainUrl Methods showsPrec :: Int -> CreatePresignedDomainUrlResponse -> ShowS # show :: CreatePresignedDomainUrlResponse -> String # showList :: [CreatePresignedDomainUrlResponse] -> ShowS #
Generic CreatePresignedDomainUrlResponse Source #
Instance details Defined in Amazonka.SageMaker.CreatePresignedDomainUrl Associated Types type Rep CreatePresignedDomainUrlResponse :: Type -> Type # Methods from :: CreatePresignedDomainUrlResponse -> Rep CreatePresignedDomainUrlResponse x # to :: Rep CreatePresignedDomainUrlResponse x -> CreatePresignedDomainUrlResponse #
NFData CreatePresignedDomainUrlResponse Source #
Instance details Defined in Amazonka.SageMaker.CreatePresignedDomainUrl Methods rnf :: CreatePresignedDomainUrlResponse -> () #
type Rep CreatePresignedDomainUrlResponse Source #
Instance details Defined in Amazonka.SageMaker.CreatePresignedDomainUrl type Rep CreatePresignedDomainUrlResponse = D1 ('MetaData "CreatePresignedDomainUrlResponse" "Amazonka.SageMaker.CreatePresignedDomainUrl" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "CreatePresignedDomainUrlResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "authorizedUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreatePresignedDomainUrlResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreatePresignedDomainUrlResponse'`
-> CreatePresignedDomainUrlResponse

Create a value of CreatePresignedDomainUrlResponse 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:CreatePresignedDomainUrlResponse', createPresignedDomainUrlResponse_authorizedUrl - The presigned URL.

$sel:httpStatus:CreatePresignedDomainUrlResponse', createPresignedDomainUrlResponse_httpStatus - The response's http status code.

Response Lenses

createPresignedDomainUrlResponse_authorizedUrl :: Lens' CreatePresignedDomainUrlResponse (Maybe Text) Source #

The presigned URL.

createPresignedDomainUrlResponse_httpStatus :: Lens' CreatePresignedDomainUrlResponse Int Source #

The response's http status code.