Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Athena.CreatePresignedNotebookUrl

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets an authentication token and the URL at which the notebook can be accessed. During programmatic access, CreatePresignedNotebookUrl must be called every 10 minutes to refresh the authentication token.

Synopsis

data CreatePresignedNotebookUrl = CreatePresignedNotebookUrl' {
- sessionId :: Text
}
newCreatePresignedNotebookUrl :: Text -> CreatePresignedNotebookUrl
createPresignedNotebookUrl_sessionId :: Lens' CreatePresignedNotebookUrl Text
data CreatePresignedNotebookUrlResponse = CreatePresignedNotebookUrlResponse' {
- httpStatus :: Int
- notebookUrl :: Text
- authToken :: Text
- authTokenExpirationTime :: Integer
}
newCreatePresignedNotebookUrlResponse :: Int -> Text -> Text -> Integer -> CreatePresignedNotebookUrlResponse
createPresignedNotebookUrlResponse_httpStatus :: Lens' CreatePresignedNotebookUrlResponse Int
createPresignedNotebookUrlResponse_notebookUrl :: Lens' CreatePresignedNotebookUrlResponse Text
createPresignedNotebookUrlResponse_authToken :: Lens' CreatePresignedNotebookUrlResponse Text
createPresignedNotebookUrlResponse_authTokenExpirationTime :: Lens' CreatePresignedNotebookUrlResponse Integer

Creating a Request

data CreatePresignedNotebookUrl Source #

See: newCreatePresignedNotebookUrl smart constructor.

Constructors

CreatePresignedNotebookUrl'
Fields sessionId :: Text The session ID.

Instances

Instances details

ToJSON CreatePresignedNotebookUrl Source #
Instance details Defined in Amazonka.Athena.CreatePresignedNotebookUrl Methods toJSON :: CreatePresignedNotebookUrl -> Value # toEncoding :: CreatePresignedNotebookUrl -> Encoding # toJSONList :: [CreatePresignedNotebookUrl] -> Value # toEncodingList :: [CreatePresignedNotebookUrl] -> Encoding #
ToHeaders CreatePresignedNotebookUrl Source #
Instance details Defined in Amazonka.Athena.CreatePresignedNotebookUrl Methods toHeaders :: CreatePresignedNotebookUrl -> [Header] #
ToPath CreatePresignedNotebookUrl Source #
Instance details Defined in Amazonka.Athena.CreatePresignedNotebookUrl Methods toPath :: CreatePresignedNotebookUrl -> ByteString #
ToQuery CreatePresignedNotebookUrl Source #
Instance details Defined in Amazonka.Athena.CreatePresignedNotebookUrl Methods toQuery :: CreatePresignedNotebookUrl -> QueryString #
AWSRequest CreatePresignedNotebookUrl Source #
Instance details Defined in Amazonka.Athena.CreatePresignedNotebookUrl Associated Types type AWSResponse CreatePresignedNotebookUrl # Methods request :: (Service -> Service) -> CreatePresignedNotebookUrl -> Request CreatePresignedNotebookUrl # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreatePresignedNotebookUrl -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreatePresignedNotebookUrl))) #
Generic CreatePresignedNotebookUrl Source #
Instance details Defined in Amazonka.Athena.CreatePresignedNotebookUrl Associated Types type Rep CreatePresignedNotebookUrl :: Type -> Type # Methods from :: CreatePresignedNotebookUrl -> Rep CreatePresignedNotebookUrl x # to :: Rep CreatePresignedNotebookUrl x -> CreatePresignedNotebookUrl #
Read CreatePresignedNotebookUrl Source #
Instance details Defined in Amazonka.Athena.CreatePresignedNotebookUrl Methods readsPrec :: Int -> ReadS CreatePresignedNotebookUrl # readList :: ReadS [CreatePresignedNotebookUrl] # readPrec :: ReadPrec CreatePresignedNotebookUrl # readListPrec :: ReadPrec [CreatePresignedNotebookUrl] #
Show CreatePresignedNotebookUrl Source #
Instance details Defined in Amazonka.Athena.CreatePresignedNotebookUrl Methods showsPrec :: Int -> CreatePresignedNotebookUrl -> ShowS # show :: CreatePresignedNotebookUrl -> String # showList :: [CreatePresignedNotebookUrl] -> ShowS #
NFData CreatePresignedNotebookUrl Source #
Instance details Defined in Amazonka.Athena.CreatePresignedNotebookUrl Methods rnf :: CreatePresignedNotebookUrl -> () #
Eq CreatePresignedNotebookUrl Source #
Instance details Defined in Amazonka.Athena.CreatePresignedNotebookUrl Methods (==) :: CreatePresignedNotebookUrl -> CreatePresignedNotebookUrl -> Bool # (/=) :: CreatePresignedNotebookUrl -> CreatePresignedNotebookUrl -> Bool #
Hashable CreatePresignedNotebookUrl Source #
Instance details Defined in Amazonka.Athena.CreatePresignedNotebookUrl Methods hashWithSalt :: Int -> CreatePresignedNotebookUrl -> Int # hash :: CreatePresignedNotebookUrl -> Int #
type AWSResponse CreatePresignedNotebookUrl Source #
Instance details Defined in Amazonka.Athena.CreatePresignedNotebookUrl type AWSResponse CreatePresignedNotebookUrl = CreatePresignedNotebookUrlResponse
type Rep CreatePresignedNotebookUrl Source #
Instance details Defined in Amazonka.Athena.CreatePresignedNotebookUrl type Rep CreatePresignedNotebookUrl = D1 ('MetaData "CreatePresignedNotebookUrl" "Amazonka.Athena.CreatePresignedNotebookUrl" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "CreatePresignedNotebookUrl'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sessionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreatePresignedNotebookUrl Source #

Arguments

:: Text	`CreatePresignedNotebookUrl`
-> CreatePresignedNotebookUrl

Create a value of CreatePresignedNotebookUrl 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:

CreatePresignedNotebookUrl, createPresignedNotebookUrl_sessionId - The session ID.

Request Lenses

createPresignedNotebookUrl_sessionId :: Lens' CreatePresignedNotebookUrl Text Source #

The session ID.

Destructuring the Response

data CreatePresignedNotebookUrlResponse Source #

See: newCreatePresignedNotebookUrlResponse smart constructor.

Constructors

CreatePresignedNotebookUrlResponse'
Fields httpStatus :: Int The response's http status code. notebookUrl :: Text The URL of the notebook. The URL includes the authentication token and notebook file name and points directly to the opened notebook. authToken :: Text The authentication token for the notebook. authTokenExpirationTime :: Integer The UTC epoch time when the authentication token expires.

Instances

Instances details

Generic CreatePresignedNotebookUrlResponse Source #
Instance details Defined in Amazonka.Athena.CreatePresignedNotebookUrl Associated Types type Rep CreatePresignedNotebookUrlResponse :: Type -> Type # Methods from :: CreatePresignedNotebookUrlResponse -> Rep CreatePresignedNotebookUrlResponse x # to :: Rep CreatePresignedNotebookUrlResponse x -> CreatePresignedNotebookUrlResponse #
Read CreatePresignedNotebookUrlResponse Source #
Instance details Defined in Amazonka.Athena.CreatePresignedNotebookUrl Methods readsPrec :: Int -> ReadS CreatePresignedNotebookUrlResponse # readList :: ReadS [CreatePresignedNotebookUrlResponse] # readPrec :: ReadPrec CreatePresignedNotebookUrlResponse # readListPrec :: ReadPrec [CreatePresignedNotebookUrlResponse] #
Show CreatePresignedNotebookUrlResponse Source #
Instance details Defined in Amazonka.Athena.CreatePresignedNotebookUrl Methods showsPrec :: Int -> CreatePresignedNotebookUrlResponse -> ShowS # show :: CreatePresignedNotebookUrlResponse -> String # showList :: [CreatePresignedNotebookUrlResponse] -> ShowS #
NFData CreatePresignedNotebookUrlResponse Source #
Instance details Defined in Amazonka.Athena.CreatePresignedNotebookUrl Methods rnf :: CreatePresignedNotebookUrlResponse -> () #
Eq CreatePresignedNotebookUrlResponse Source #
Instance details Defined in Amazonka.Athena.CreatePresignedNotebookUrl Methods (==) :: CreatePresignedNotebookUrlResponse -> CreatePresignedNotebookUrlResponse -> Bool # (/=) :: CreatePresignedNotebookUrlResponse -> CreatePresignedNotebookUrlResponse -> Bool #
type Rep CreatePresignedNotebookUrlResponse Source #
Instance details Defined in Amazonka.Athena.CreatePresignedNotebookUrl type Rep CreatePresignedNotebookUrlResponse = D1 ('MetaData "CreatePresignedNotebookUrlResponse" "Amazonka.Athena.CreatePresignedNotebookUrl" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "CreatePresignedNotebookUrlResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "notebookUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "authToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "authTokenExpirationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer))))

newCreatePresignedNotebookUrlResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreatePresignedNotebookUrlResponse'`
-> Text	`$sel:notebookUrl:CreatePresignedNotebookUrlResponse'`
-> Text	`$sel:authToken:CreatePresignedNotebookUrlResponse'`
-> Integer	`$sel:authTokenExpirationTime:CreatePresignedNotebookUrlResponse'`
-> CreatePresignedNotebookUrlResponse

Create a value of CreatePresignedNotebookUrlResponse 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:httpStatus:CreatePresignedNotebookUrlResponse', createPresignedNotebookUrlResponse_httpStatus - The response's http status code.

$sel:notebookUrl:CreatePresignedNotebookUrlResponse', createPresignedNotebookUrlResponse_notebookUrl - The URL of the notebook. The URL includes the authentication token and notebook file name and points directly to the opened notebook.

$sel:authToken:CreatePresignedNotebookUrlResponse', createPresignedNotebookUrlResponse_authToken - The authentication token for the notebook.

$sel:authTokenExpirationTime:CreatePresignedNotebookUrlResponse', createPresignedNotebookUrlResponse_authTokenExpirationTime - The UTC epoch time when the authentication token expires.

Response Lenses

createPresignedNotebookUrlResponse_httpStatus :: Lens' CreatePresignedNotebookUrlResponse Int Source #

The response's http status code.

createPresignedNotebookUrlResponse_notebookUrl :: Lens' CreatePresignedNotebookUrlResponse Text Source #

The URL of the notebook. The URL includes the authentication token and notebook file name and points directly to the opened notebook.

createPresignedNotebookUrlResponse_authToken :: Lens' CreatePresignedNotebookUrlResponse Text Source #

The authentication token for the notebook.

createPresignedNotebookUrlResponse_authTokenExpirationTime :: Lens' CreatePresignedNotebookUrlResponse Integer Source #

The UTC epoch time when the authentication token expires.