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

Description

 
Synopsis

Documentation

data CalculationStatus Source #

Contains information about the status of a notebook calculation.

See: newCalculationStatus smart constructor.

Constructors

CalculationStatus' 

Fields

  • completionDateTime :: Maybe POSIX

    The date and time the calculation completed processing.

  • state :: Maybe CalculationExecutionState

    The state of the calculation execution. A description of each state follows.

    CREATING - The calculation is in the process of being created.

    CREATED - The calculation has been created and is ready to run.

    QUEUED - The calculation has been queued for processing.

    RUNNING - The calculation is running.

    CANCELING - A request to cancel the calculation has been received and the system is working to stop it.

    CANCELED - The calculation is no longer running as the result of a cancel request.

    COMPLETED - The calculation has completed without error.

    FAILED - The calculation failed and is no longer running.

  • stateChangeReason :: Maybe Text

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

  • submissionDateTime :: Maybe POSIX

    The date and time the calculation was submitted for processing.

Instances

Instances details
FromJSON CalculationStatus Source # 
Instance details

Defined in Amazonka.Athena.Types.CalculationStatus

Generic CalculationStatus Source # 
Instance details

Defined in Amazonka.Athena.Types.CalculationStatus

Associated Types

type Rep CalculationStatus :: Type -> Type #

Read CalculationStatus Source # 
Instance details

Defined in Amazonka.Athena.Types.CalculationStatus

Show CalculationStatus Source # 
Instance details

Defined in Amazonka.Athena.Types.CalculationStatus

NFData CalculationStatus Source # 
Instance details

Defined in Amazonka.Athena.Types.CalculationStatus

Methods

rnf :: CalculationStatus -> () #

Eq CalculationStatus Source # 
Instance details

Defined in Amazonka.Athena.Types.CalculationStatus

Hashable CalculationStatus Source # 
Instance details

Defined in Amazonka.Athena.Types.CalculationStatus

type Rep CalculationStatus Source # 
Instance details

Defined in Amazonka.Athena.Types.CalculationStatus

type Rep CalculationStatus = D1 ('MetaData "CalculationStatus" "Amazonka.Athena.Types.CalculationStatus" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "CalculationStatus'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "completionDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CalculationExecutionState))) :*: (S1 ('MetaSel ('Just "stateChangeReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "submissionDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))

newCalculationStatus :: CalculationStatus Source #

Create a value of CalculationStatus 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:completionDateTime:CalculationStatus', calculationStatus_completionDateTime - The date and time the calculation completed processing.

$sel:state:CalculationStatus', calculationStatus_state - The state of the calculation execution. A description of each state follows.

CREATING - The calculation is in the process of being created.

CREATED - The calculation has been created and is ready to run.

QUEUED - The calculation has been queued for processing.

RUNNING - The calculation is running.

CANCELING - A request to cancel the calculation has been received and the system is working to stop it.

CANCELED - The calculation is no longer running as the result of a cancel request.

COMPLETED - The calculation has completed without error.

FAILED - The calculation failed and is no longer running.

$sel:stateChangeReason:CalculationStatus', calculationStatus_stateChangeReason - The reason for the calculation state change (for example, the calculation was canceled because the session was terminated).

$sel:submissionDateTime:CalculationStatus', calculationStatus_submissionDateTime - The date and time the calculation was submitted for processing.

calculationStatus_completionDateTime :: Lens' CalculationStatus (Maybe UTCTime) Source #

The date and time the calculation completed processing.

calculationStatus_state :: Lens' CalculationStatus (Maybe CalculationExecutionState) Source #

The state of the calculation execution. A description of each state follows.

CREATING - The calculation is in the process of being created.

CREATED - The calculation has been created and is ready to run.

QUEUED - The calculation has been queued for processing.

RUNNING - The calculation is running.

CANCELING - A request to cancel the calculation has been received and the system is working to stop it.

CANCELED - The calculation is no longer running as the result of a cancel request.

COMPLETED - The calculation has completed without error.

FAILED - The calculation failed and is no longer running.

calculationStatus_stateChangeReason :: Lens' CalculationStatus (Maybe Text) Source #

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

calculationStatus_submissionDateTime :: Lens' CalculationStatus (Maybe UTCTime) Source #

The date and time the calculation was submitted for processing.