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.GetSession

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the full details of a previously created session, including the session status and configuration.

Synopsis

data GetSession = GetSession' {
- sessionId :: Text
}
newGetSession :: Text -> GetSession
getSession_sessionId :: Lens' GetSession Text
data GetSessionResponse = GetSessionResponse' {
- description :: Maybe Text
- engineConfiguration :: Maybe EngineConfiguration
- engineVersion :: Maybe Text
- notebookVersion :: Maybe Text
- sessionConfiguration :: Maybe SessionConfiguration
- sessionId :: Maybe Text
- statistics :: Maybe SessionStatistics
- status :: Maybe SessionStatus
- workGroup :: Maybe Text
- httpStatus :: Int
}
newGetSessionResponse :: Int -> GetSessionResponse
getSessionResponse_description :: Lens' GetSessionResponse (Maybe Text)
getSessionResponse_engineConfiguration :: Lens' GetSessionResponse (Maybe EngineConfiguration)
getSessionResponse_engineVersion :: Lens' GetSessionResponse (Maybe Text)
getSessionResponse_notebookVersion :: Lens' GetSessionResponse (Maybe Text)
getSessionResponse_sessionConfiguration :: Lens' GetSessionResponse (Maybe SessionConfiguration)
getSessionResponse_sessionId :: Lens' GetSessionResponse (Maybe Text)
getSessionResponse_statistics :: Lens' GetSessionResponse (Maybe SessionStatistics)
getSessionResponse_status :: Lens' GetSessionResponse (Maybe SessionStatus)
getSessionResponse_workGroup :: Lens' GetSessionResponse (Maybe Text)
getSessionResponse_httpStatus :: Lens' GetSessionResponse Int

Creating a Request

data GetSession Source #

See: newGetSession smart constructor.

Constructors

GetSession'
Fields sessionId :: Text The session ID.

Instances

Instances details

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

newGetSession Source #

Arguments

:: Text	`GetSession`
-> GetSession

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

GetSession, getSession_sessionId - The session ID.

Request Lenses

getSession_sessionId :: Lens' GetSession Text Source #

The session ID.

Destructuring the Response

data GetSessionResponse Source #

See: newGetSessionResponse smart constructor.

Constructors

GetSessionResponse'

Fields

description :: Maybe Text
The session description.
engineConfiguration :: Maybe EngineConfiguration
Contains engine configuration information like DPU usage.
engineVersion :: Maybe Text
The engine version used by the session (for example, PySpark engine version 3). You can get a list of engine versions by calling ListEngineVersions.
notebookVersion :: Maybe Text
The notebook version.
sessionConfiguration :: Maybe SessionConfiguration
Contains the workgroup configuration information used by the session.
sessionId :: Maybe Text
The session ID.
statistics :: Maybe SessionStatistics
Contains the DPU execution time.
status :: Maybe SessionStatus
Contains information about the status of the session.
workGroup :: Maybe Text
The workgroup to which the session belongs.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetSessionResponse Source #
Instance details Defined in Amazonka.Athena.GetSession Associated Types type Rep GetSessionResponse :: Type -> Type # Methods from :: GetSessionResponse -> Rep GetSessionResponse x # to :: Rep GetSessionResponse x -> GetSessionResponse #
Read GetSessionResponse Source #
Instance details Defined in Amazonka.Athena.GetSession Methods readsPrec :: Int -> ReadS GetSessionResponse # readList :: ReadS [GetSessionResponse] # readPrec :: ReadPrec GetSessionResponse # readListPrec :: ReadPrec [GetSessionResponse] #
Show GetSessionResponse Source #
Instance details Defined in Amazonka.Athena.GetSession Methods showsPrec :: Int -> GetSessionResponse -> ShowS # show :: GetSessionResponse -> String # showList :: [GetSessionResponse] -> ShowS #
NFData GetSessionResponse Source #
Instance details Defined in Amazonka.Athena.GetSession Methods rnf :: GetSessionResponse -> () #
Eq GetSessionResponse Source #
Instance details Defined in Amazonka.Athena.GetSession Methods (==) :: GetSessionResponse -> GetSessionResponse -> Bool # (/=) :: GetSessionResponse -> GetSessionResponse -> Bool #
type Rep GetSessionResponse Source #
Instance details Defined in Amazonka.Athena.GetSession type Rep GetSessionResponse = D1 ('MetaData "GetSessionResponse" "Amazonka.Athena.GetSession" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "GetSessionResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "engineConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EngineConfiguration))) :: (S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "notebookVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "sessionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SessionConfiguration))))) :: ((S1 ('MetaSel ('Just "sessionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "statistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SessionStatistics))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SessionStatus)) :: (S1 ('MetaSel ('Just "workGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newGetSessionResponse Source #

Arguments

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

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

GetSessionResponse, getSessionResponse_description - The session description.

$sel:engineConfiguration:GetSessionResponse', getSessionResponse_engineConfiguration - Contains engine configuration information like DPU usage.

GetSessionResponse, getSessionResponse_engineVersion - The engine version used by the session (for example, PySpark engine version 3). You can get a list of engine versions by calling ListEngineVersions.

GetSessionResponse, getSessionResponse_notebookVersion - The notebook version.

$sel:sessionConfiguration:GetSessionResponse', getSessionResponse_sessionConfiguration - Contains the workgroup configuration information used by the session.

GetSession, getSessionResponse_sessionId - The session ID.

GetSessionResponse, getSessionResponse_statistics - Contains the DPU execution time.

GetSessionResponse, getSessionResponse_status - Contains information about the status of the session.

GetSessionResponse, getSessionResponse_workGroup - The workgroup to which the session belongs.

$sel:httpStatus:GetSessionResponse', getSessionResponse_httpStatus - The response's http status code.

Response Lenses

getSessionResponse_description :: Lens' GetSessionResponse (Maybe Text) Source #

The session description.

getSessionResponse_engineConfiguration :: Lens' GetSessionResponse (Maybe EngineConfiguration) Source #

Contains engine configuration information like DPU usage.

getSessionResponse_engineVersion :: Lens' GetSessionResponse (Maybe Text) Source #

The engine version used by the session (for example, PySpark engine version 3). You can get a list of engine versions by calling ListEngineVersions.

getSessionResponse_notebookVersion :: Lens' GetSessionResponse (Maybe Text) Source #

The notebook version.

getSessionResponse_sessionConfiguration :: Lens' GetSessionResponse (Maybe SessionConfiguration) Source #

Contains the workgroup configuration information used by the session.

getSessionResponse_sessionId :: Lens' GetSessionResponse (Maybe Text) Source #

The session ID.

getSessionResponse_statistics :: Lens' GetSessionResponse (Maybe SessionStatistics) Source #

Contains the DPU execution time.

getSessionResponse_status :: Lens' GetSessionResponse (Maybe SessionStatus) Source #

Contains information about the status of the session.

getSessionResponse_workGroup :: Lens' GetSessionResponse (Maybe Text) Source #

The workgroup to which the session belongs.

getSessionResponse_httpStatus :: Lens' GetSessionResponse Int Source #

The response's http status code.