amazonka-athena-2.0: Amazon Athena SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Athena.Types.SessionStatus

Description

 
Synopsis

Documentation

data SessionStatus Source #

Contains information about the status of a notebook session.

See: newSessionStatus smart constructor.

Constructors

SessionStatus' 

Fields

  • endDateTime :: Maybe POSIX

    The date and time that the session ended.

  • idleSinceDateTime :: Maybe POSIX

    The date and time starting at which the session became idle. Can be empty if the session is not currently idle.

  • lastModifiedDateTime :: Maybe POSIX

    The most recent date and time that the session was modified.

  • startDateTime :: Maybe POSIX

    The date and time that the session started.

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

  • stateChangeReason :: Maybe Text

    The reason for the session state change (for example, canceled because the session was terminated).

Instances

Instances details
FromJSON SessionStatus Source # 
Instance details

Defined in Amazonka.Athena.Types.SessionStatus

Generic SessionStatus Source # 
Instance details

Defined in Amazonka.Athena.Types.SessionStatus

Associated Types

type Rep SessionStatus :: Type -> Type #

Read SessionStatus Source # 
Instance details

Defined in Amazonka.Athena.Types.SessionStatus

Show SessionStatus Source # 
Instance details

Defined in Amazonka.Athena.Types.SessionStatus

NFData SessionStatus Source # 
Instance details

Defined in Amazonka.Athena.Types.SessionStatus

Methods

rnf :: SessionStatus -> () #

Eq SessionStatus Source # 
Instance details

Defined in Amazonka.Athena.Types.SessionStatus

Hashable SessionStatus Source # 
Instance details

Defined in Amazonka.Athena.Types.SessionStatus

type Rep SessionStatus Source # 
Instance details

Defined in Amazonka.Athena.Types.SessionStatus

type Rep SessionStatus = D1 ('MetaData "SessionStatus" "Amazonka.Athena.Types.SessionStatus" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "SessionStatus'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "endDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "idleSinceDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "lastModifiedDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: (S1 ('MetaSel ('Just "startDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SessionState)) :*: S1 ('MetaSel ('Just "stateChangeReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newSessionStatus :: SessionStatus Source #

Create a value of SessionStatus 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:endDateTime:SessionStatus', sessionStatus_endDateTime - The date and time that the session ended.

$sel:idleSinceDateTime:SessionStatus', sessionStatus_idleSinceDateTime - The date and time starting at which the session became idle. Can be empty if the session is not currently idle.

$sel:lastModifiedDateTime:SessionStatus', sessionStatus_lastModifiedDateTime - The most recent date and time that the session was modified.

$sel:startDateTime:SessionStatus', sessionStatus_startDateTime - The date and time that the session started.

$sel:state:SessionStatus', sessionStatus_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:stateChangeReason:SessionStatus', sessionStatus_stateChangeReason - The reason for the session state change (for example, canceled because the session was terminated).

sessionStatus_endDateTime :: Lens' SessionStatus (Maybe UTCTime) Source #

The date and time that the session ended.

sessionStatus_idleSinceDateTime :: Lens' SessionStatus (Maybe UTCTime) Source #

The date and time starting at which the session became idle. Can be empty if the session is not currently idle.

sessionStatus_lastModifiedDateTime :: Lens' SessionStatus (Maybe UTCTime) Source #

The most recent date and time that the session was modified.

sessionStatus_startDateTime :: Lens' SessionStatus (Maybe UTCTime) Source #

The date and time that the session started.

sessionStatus_state :: Lens' SessionStatus (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.

sessionStatus_stateChangeReason :: Lens' SessionStatus (Maybe Text) Source #

The reason for the session state change (for example, canceled because the session was terminated).