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 |
Creates a session for running calculations within a workgroup. The
session is ready when it reaches an IDLE
state.
Synopsis
- data StartSession = StartSession' {}
- newStartSession :: Text -> EngineConfiguration -> StartSession
- startSession_clientRequestToken :: Lens' StartSession (Maybe Text)
- startSession_description :: Lens' StartSession (Maybe Text)
- startSession_notebookVersion :: Lens' StartSession (Maybe Text)
- startSession_sessionIdleTimeoutInMinutes :: Lens' StartSession (Maybe Natural)
- startSession_workGroup :: Lens' StartSession Text
- startSession_engineConfiguration :: Lens' StartSession EngineConfiguration
- data StartSessionResponse = StartSessionResponse' {
- sessionId :: Maybe Text
- state :: Maybe SessionState
- httpStatus :: Int
- newStartSessionResponse :: Int -> StartSessionResponse
- startSessionResponse_sessionId :: Lens' StartSessionResponse (Maybe Text)
- startSessionResponse_state :: Lens' StartSessionResponse (Maybe SessionState)
- startSessionResponse_httpStatus :: Lens' StartSessionResponse Int
Creating a Request
data StartSession Source #
See: newStartSession
smart constructor.
StartSession' | |
|
Instances
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) Source #
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) Source #
The session description.
startSession_notebookVersion :: Lens' StartSession (Maybe Text) Source #
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) Source #
The idle timeout in minutes for the session.
startSession_workGroup :: Lens' StartSession Text Source #
The workgroup to which the session belongs.
startSession_engineConfiguration :: Lens' StartSession EngineConfiguration Source #
Contains engine data processing unit (DPU) configuration settings and parameter mappings.
Destructuring the Response
data StartSessionResponse Source #
See: newStartSessionResponse
smart constructor.
StartSessionResponse' | |
|
Instances
newStartSessionResponse Source #
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) Source #
The session ID.
startSessionResponse_state :: Lens' StartSessionResponse (Maybe SessionState) Source #
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 Source #
The response's http status code.