Amazonka.Athena.StartSession

Creates a session for running calculations within a workgroup. The session is ready when it reaches an IDLE state.

Creating a Request

data StartSession

See: newStartSession smart constructor.

Constructors

StartSession'

Fields

• clientRequestToken :: Maybe Text

  A unique case-sensitive string used to ensure the request to create the session is idempotent (executes only once). If another StartSessionRequest is received, the same response is returned and another session is not created. If a parameter has changed, an error is returned.

  This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

• description :: Maybe Text

  The session description.

• notebookVersion :: Maybe Text

  The notebook version. This value is required only when requesting that a notebook server be started for the session. The only valid notebook version is Jupyter1.0.

• sessionIdleTimeoutInMinutes :: Maybe Natural

  The idle timeout in minutes for the session.

• workGroup :: Text

  The workgroup to which the session belongs.

• engineConfiguration :: EngineConfiguration

  Contains engine data processing unit (DPU) configuration settings and parameter mappings.

Instances

ToJSON StartSession

Defined in Amazonka.Athena.StartSession

Methods

toJSON :: StartSession -> Value

toEncoding :: StartSession -> Encoding

toJSONList :: [StartSession] -> Value

toEncodingList :: [StartSession] -> Encoding

ToHeaders StartSession

Defined in Amazonka.Athena.StartSession

Methods

toHeaders :: StartSession -> [Header]

ToPath StartSession

Defined in Amazonka.Athena.StartSession

Methods

toPath :: StartSession -> ByteString

ToQuery StartSession

Defined in Amazonka.Athena.StartSession

Methods

toQuery :: StartSession -> QueryString

AWSRequest StartSession

Defined in Amazonka.Athena.StartSession

Associated Types

type AWSResponse StartSession

Methods

request :: (Service -> Service) -> StartSession -> Request StartSession

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartSession -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartSession)))

Generic StartSession

Defined in Amazonka.Athena.StartSession

Associated Types

type Rep StartSession :: Type -> Type

Methods

from :: StartSession -> Rep StartSession x

to :: Rep StartSession x -> StartSession

Read StartSession

Defined in Amazonka.Athena.StartSession

Methods

readsPrec :: Int -> ReadS StartSession

readList :: ReadS [StartSession]

readPrec :: ReadPrec StartSession

readListPrec :: ReadPrec [StartSession]

Show StartSession

Defined in Amazonka.Athena.StartSession

Methods

showsPrec :: Int -> StartSession -> ShowS

show :: StartSession -> String

showList :: [StartSession] -> ShowS

NFData StartSession

Defined in Amazonka.Athena.StartSession

Methods

rnf :: StartSession -> ()

Eq StartSession

Defined in Amazonka.Athena.StartSession

Methods

(==) :: StartSession -> StartSession -> Bool

(/=) :: StartSession -> StartSession -> Bool

Hashable StartSession

Defined in Amazonka.Athena.StartSession

Methods

hashWithSalt :: Int -> StartSession -> Int

hash :: StartSession -> Int

type AWSResponse StartSession

Defined in Amazonka.Athena.StartSession

type AWSResponse StartSession = StartSessionResponse

type Rep StartSession

Defined in Amazonka.Athena.StartSession

type Rep StartSession = D1 ('MetaData "StartSession" "Amazonka.Athena.StartSession" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "StartSession'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "notebookVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "sessionIdleTimeoutInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "workGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "engineConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EngineConfiguration)))))

newStartSession

Arguments

:: Text

StartSession

-> EngineConfiguration

$sel:engineConfiguration:StartSession'

-> StartSession

Create a value of StartSession 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:clientRequestToken:StartSession', startSession_clientRequestToken - A unique case-sensitive string used to ensure the request to create the session is idempotent (executes only once). If another StartSessionRequest is received, the same response is returned and another session is not created. If a parameter has changed, an error is returned.

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

StartSession, startSession_description - The session description.

StartSession, startSession_notebookVersion - The notebook version. This value is required only when requesting that a notebook server be started for the session. The only valid notebook version is Jupyter1.0.

$sel:sessionIdleTimeoutInMinutes:StartSession', startSession_sessionIdleTimeoutInMinutes - The idle timeout in minutes for the session.

StartSession, startSession_workGroup - The workgroup to which the session belongs.

$sel:engineConfiguration:StartSession', startSession_engineConfiguration - Contains engine data processing unit (DPU) configuration settings and parameter mappings.

Request Lenses

startSession_clientRequestToken :: Lens' StartSession (Maybe Text)

A unique case-sensitive string used to ensure the request to create the session is idempotent (executes only once). If another StartSessionRequest is received, the same response is returned and another session is not created. If a parameter has changed, an error is returned.

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

startSession_description :: Lens' StartSession (Maybe Text)

The session description.

startSession_notebookVersion :: Lens' StartSession (Maybe Text)

The notebook version. This value is required only when requesting that a notebook server be started for the session. The only valid notebook version is Jupyter1.0.

startSession_sessionIdleTimeoutInMinutes :: Lens' StartSession (Maybe Natural)

The idle timeout in minutes for the session.

startSession_workGroup :: Lens' StartSession Text

The workgroup to which the session belongs.

startSession_engineConfiguration :: Lens' StartSession EngineConfiguration

Contains engine data processing unit (DPU) configuration settings and parameter mappings.

Destructuring the Response

data StartSessionResponse

See: newStartSessionResponse smart constructor.

Constructors

StartSessionResponse'

Fields

• sessionId :: Maybe Text

  The session ID.

• state :: Maybe SessionState

  The state of the session. A description of each state follows.

  CREATING - The session is being started, including acquiring resources.

  CREATED - The session has been started.

  IDLE - The session is able to accept a calculation.

  BUSY - The session is processing another task and is unable to accept a calculation.

  TERMINATING - The session is in the process of shutting down.

  TERMINATED - The session and its resources are no longer running.

  DEGRADED - The session has no healthy coordinators.

  FAILED - Due to a failure, the session and its resources are no longer running.

• httpStatus :: Int

  The response's http status code.

Instances

Generic StartSessionResponse

Defined in Amazonka.Athena.StartSession

Associated Types

type Rep StartSessionResponse :: Type -> Type

Methods

from :: StartSessionResponse -> Rep StartSessionResponse x

to :: Rep StartSessionResponse x -> StartSessionResponse

Read StartSessionResponse

Defined in Amazonka.Athena.StartSession

Methods

readsPrec :: Int -> ReadS StartSessionResponse

readList :: ReadS [StartSessionResponse]

readPrec :: ReadPrec StartSessionResponse

readListPrec :: ReadPrec [StartSessionResponse]

Show StartSessionResponse

Defined in Amazonka.Athena.StartSession

Methods

showsPrec :: Int -> StartSessionResponse -> ShowS

show :: StartSessionResponse -> String

showList :: [StartSessionResponse] -> ShowS

NFData StartSessionResponse

Defined in Amazonka.Athena.StartSession

Methods

rnf :: StartSessionResponse -> ()

Eq StartSessionResponse

Defined in Amazonka.Athena.StartSession

Methods

(==) :: StartSessionResponse -> StartSessionResponse -> Bool

(/=) :: StartSessionResponse -> StartSessionResponse -> Bool

type Rep StartSessionResponse

Defined in Amazonka.Athena.StartSession

type Rep StartSessionResponse = D1 ('MetaData "StartSessionResponse" "Amazonka.Athena.StartSession" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "StartSessionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sessionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SessionState)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newStartSessionResponse

Arguments

:: Int

$sel:httpStatus:StartSessionResponse'

-> StartSessionResponse

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

StartSessionResponse, startSessionResponse_sessionId - The session ID.

StartSessionResponse, startSessionResponse_state - The state of the session. A description of each state follows.

CREATING - The session is being started, including acquiring resources.

CREATED - The session has been started.

IDLE - The session is able to accept a calculation.

BUSY - The session is processing another task and is unable to accept a calculation.

TERMINATING - The session is in the process of shutting down.

TERMINATED - The session and its resources are no longer running.

DEGRADED - The session has no healthy coordinators.

FAILED - Due to a failure, the session and its resources are no longer running.

$sel:httpStatus:StartSessionResponse', startSessionResponse_httpStatus - The response's http status code.

Response Lenses

startSessionResponse_sessionId :: Lens' StartSessionResponse (Maybe Text)

The session ID.

startSessionResponse_state :: Lens' StartSessionResponse (Maybe SessionState)

The state of the session. A description of each state follows.

CREATING - The session is being started, including acquiring resources.

CREATED - The session has been started.

IDLE - The session is able to accept a calculation.

BUSY - The session is processing another task and is unable to accept a calculation.

TERMINATING - The session is in the process of shutting down.

TERMINATED - The session and its resources are no longer running.

DEGRADED - The session has no healthy coordinators.

FAILED - Due to a failure, the session and its resources are no longer running.

startSessionResponse_httpStatus :: Lens' StartSessionResponse Int

The response's http status code.