{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.Athena.Types.QueryExecutionStatus
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.Athena.Types.QueryExecutionStatus where

import Amazonka.Athena.Types.AthenaError
import Amazonka.Athena.Types.QueryExecutionState
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude

-- | The completion date, current state, submission time, and state change
-- reason (if applicable) for the query execution.
--
-- /See:/ 'newQueryExecutionStatus' smart constructor.
data QueryExecutionStatus = QueryExecutionStatus'
  { -- | Provides information about an Athena query error.
    QueryExecutionStatus -> Maybe AthenaError
athenaError :: Prelude.Maybe AthenaError,
    -- | The date and time that the query completed.
    QueryExecutionStatus -> Maybe POSIX
completionDateTime :: Prelude.Maybe Data.POSIX,
    -- | The state of query execution. @QUEUED@ indicates that the query has been
    -- submitted to the service, and Athena will execute the query as soon as
    -- resources are available. @RUNNING@ indicates that the query is in
    -- execution phase. @SUCCEEDED@ indicates that the query completed without
    -- errors. @FAILED@ indicates that the query experienced an error and did
    -- not complete processing. @CANCELLED@ indicates that a user input
    -- interrupted query execution.
    --
    -- Athena automatically retries your queries in cases of certain transient
    -- errors. As a result, you may see the query state transition from
    -- @RUNNING@ or @FAILED@ to @QUEUED@.
    QueryExecutionStatus -> Maybe QueryExecutionState
state :: Prelude.Maybe QueryExecutionState,
    -- | Further detail about the status of the query.
    QueryExecutionStatus -> Maybe Text
stateChangeReason :: Prelude.Maybe Prelude.Text,
    -- | The date and time that the query was submitted.
    QueryExecutionStatus -> Maybe POSIX
submissionDateTime :: Prelude.Maybe Data.POSIX
  }
  deriving (QueryExecutionStatus -> QueryExecutionStatus -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: QueryExecutionStatus -> QueryExecutionStatus -> Bool
$c/= :: QueryExecutionStatus -> QueryExecutionStatus -> Bool
== :: QueryExecutionStatus -> QueryExecutionStatus -> Bool
$c== :: QueryExecutionStatus -> QueryExecutionStatus -> Bool
Prelude.Eq, ReadPrec [QueryExecutionStatus]
ReadPrec QueryExecutionStatus
Int -> ReadS QueryExecutionStatus
ReadS [QueryExecutionStatus]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [QueryExecutionStatus]
$creadListPrec :: ReadPrec [QueryExecutionStatus]
readPrec :: ReadPrec QueryExecutionStatus
$creadPrec :: ReadPrec QueryExecutionStatus
readList :: ReadS [QueryExecutionStatus]
$creadList :: ReadS [QueryExecutionStatus]
readsPrec :: Int -> ReadS QueryExecutionStatus
$creadsPrec :: Int -> ReadS QueryExecutionStatus
Prelude.Read, Int -> QueryExecutionStatus -> ShowS
[QueryExecutionStatus] -> ShowS
QueryExecutionStatus -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [QueryExecutionStatus] -> ShowS
$cshowList :: [QueryExecutionStatus] -> ShowS
show :: QueryExecutionStatus -> String
$cshow :: QueryExecutionStatus -> String
showsPrec :: Int -> QueryExecutionStatus -> ShowS
$cshowsPrec :: Int -> QueryExecutionStatus -> ShowS
Prelude.Show, forall x. Rep QueryExecutionStatus x -> QueryExecutionStatus
forall x. QueryExecutionStatus -> Rep QueryExecutionStatus x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep QueryExecutionStatus x -> QueryExecutionStatus
$cfrom :: forall x. QueryExecutionStatus -> Rep QueryExecutionStatus x
Prelude.Generic)

-- |
-- Create a value of 'QueryExecutionStatus' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'athenaError', 'queryExecutionStatus_athenaError' - Provides information about an Athena query error.
--
-- 'completionDateTime', 'queryExecutionStatus_completionDateTime' - The date and time that the query completed.
--
-- 'state', 'queryExecutionStatus_state' - The state of query execution. @QUEUED@ indicates that the query has been
-- submitted to the service, and Athena will execute the query as soon as
-- resources are available. @RUNNING@ indicates that the query is in
-- execution phase. @SUCCEEDED@ indicates that the query completed without
-- errors. @FAILED@ indicates that the query experienced an error and did
-- not complete processing. @CANCELLED@ indicates that a user input
-- interrupted query execution.
--
-- Athena automatically retries your queries in cases of certain transient
-- errors. As a result, you may see the query state transition from
-- @RUNNING@ or @FAILED@ to @QUEUED@.
--
-- 'stateChangeReason', 'queryExecutionStatus_stateChangeReason' - Further detail about the status of the query.
--
-- 'submissionDateTime', 'queryExecutionStatus_submissionDateTime' - The date and time that the query was submitted.
newQueryExecutionStatus ::
  QueryExecutionStatus
newQueryExecutionStatus :: QueryExecutionStatus
newQueryExecutionStatus =
  QueryExecutionStatus'
    { $sel:athenaError:QueryExecutionStatus' :: Maybe AthenaError
athenaError =
        forall a. Maybe a
Prelude.Nothing,
      $sel:completionDateTime:QueryExecutionStatus' :: Maybe POSIX
completionDateTime = forall a. Maybe a
Prelude.Nothing,
      $sel:state:QueryExecutionStatus' :: Maybe QueryExecutionState
state = forall a. Maybe a
Prelude.Nothing,
      $sel:stateChangeReason:QueryExecutionStatus' :: Maybe Text
stateChangeReason = forall a. Maybe a
Prelude.Nothing,
      $sel:submissionDateTime:QueryExecutionStatus' :: Maybe POSIX
submissionDateTime = forall a. Maybe a
Prelude.Nothing
    }

-- | Provides information about an Athena query error.
queryExecutionStatus_athenaError :: Lens.Lens' QueryExecutionStatus (Prelude.Maybe AthenaError)
queryExecutionStatus_athenaError :: Lens' QueryExecutionStatus (Maybe AthenaError)
queryExecutionStatus_athenaError = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\QueryExecutionStatus' {Maybe AthenaError
athenaError :: Maybe AthenaError
$sel:athenaError:QueryExecutionStatus' :: QueryExecutionStatus -> Maybe AthenaError
athenaError} -> Maybe AthenaError
athenaError) (\s :: QueryExecutionStatus
s@QueryExecutionStatus' {} Maybe AthenaError
a -> QueryExecutionStatus
s {$sel:athenaError:QueryExecutionStatus' :: Maybe AthenaError
athenaError = Maybe AthenaError
a} :: QueryExecutionStatus)

-- | The date and time that the query completed.
queryExecutionStatus_completionDateTime :: Lens.Lens' QueryExecutionStatus (Prelude.Maybe Prelude.UTCTime)
queryExecutionStatus_completionDateTime :: Lens' QueryExecutionStatus (Maybe UTCTime)
queryExecutionStatus_completionDateTime = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\QueryExecutionStatus' {Maybe POSIX
completionDateTime :: Maybe POSIX
$sel:completionDateTime:QueryExecutionStatus' :: QueryExecutionStatus -> Maybe POSIX
completionDateTime} -> Maybe POSIX
completionDateTime) (\s :: QueryExecutionStatus
s@QueryExecutionStatus' {} Maybe POSIX
a -> QueryExecutionStatus
s {$sel:completionDateTime:QueryExecutionStatus' :: Maybe POSIX
completionDateTime = Maybe POSIX
a} :: QueryExecutionStatus) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall (a :: Format). Iso' (Time a) UTCTime
Data._Time

-- | The state of query execution. @QUEUED@ indicates that the query has been
-- submitted to the service, and Athena will execute the query as soon as
-- resources are available. @RUNNING@ indicates that the query is in
-- execution phase. @SUCCEEDED@ indicates that the query completed without
-- errors. @FAILED@ indicates that the query experienced an error and did
-- not complete processing. @CANCELLED@ indicates that a user input
-- interrupted query execution.
--
-- Athena automatically retries your queries in cases of certain transient
-- errors. As a result, you may see the query state transition from
-- @RUNNING@ or @FAILED@ to @QUEUED@.
queryExecutionStatus_state :: Lens.Lens' QueryExecutionStatus (Prelude.Maybe QueryExecutionState)
queryExecutionStatus_state :: Lens' QueryExecutionStatus (Maybe QueryExecutionState)
queryExecutionStatus_state = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\QueryExecutionStatus' {Maybe QueryExecutionState
state :: Maybe QueryExecutionState
$sel:state:QueryExecutionStatus' :: QueryExecutionStatus -> Maybe QueryExecutionState
state} -> Maybe QueryExecutionState
state) (\s :: QueryExecutionStatus
s@QueryExecutionStatus' {} Maybe QueryExecutionState
a -> QueryExecutionStatus
s {$sel:state:QueryExecutionStatus' :: Maybe QueryExecutionState
state = Maybe QueryExecutionState
a} :: QueryExecutionStatus)

-- | Further detail about the status of the query.
queryExecutionStatus_stateChangeReason :: Lens.Lens' QueryExecutionStatus (Prelude.Maybe Prelude.Text)
queryExecutionStatus_stateChangeReason :: Lens' QueryExecutionStatus (Maybe Text)
queryExecutionStatus_stateChangeReason = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\QueryExecutionStatus' {Maybe Text
stateChangeReason :: Maybe Text
$sel:stateChangeReason:QueryExecutionStatus' :: QueryExecutionStatus -> Maybe Text
stateChangeReason} -> Maybe Text
stateChangeReason) (\s :: QueryExecutionStatus
s@QueryExecutionStatus' {} Maybe Text
a -> QueryExecutionStatus
s {$sel:stateChangeReason:QueryExecutionStatus' :: Maybe Text
stateChangeReason = Maybe Text
a} :: QueryExecutionStatus)

-- | The date and time that the query was submitted.
queryExecutionStatus_submissionDateTime :: Lens.Lens' QueryExecutionStatus (Prelude.Maybe Prelude.UTCTime)
queryExecutionStatus_submissionDateTime :: Lens' QueryExecutionStatus (Maybe UTCTime)
queryExecutionStatus_submissionDateTime = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\QueryExecutionStatus' {Maybe POSIX
submissionDateTime :: Maybe POSIX
$sel:submissionDateTime:QueryExecutionStatus' :: QueryExecutionStatus -> Maybe POSIX
submissionDateTime} -> Maybe POSIX
submissionDateTime) (\s :: QueryExecutionStatus
s@QueryExecutionStatus' {} Maybe POSIX
a -> QueryExecutionStatus
s {$sel:submissionDateTime:QueryExecutionStatus' :: Maybe POSIX
submissionDateTime = Maybe POSIX
a} :: QueryExecutionStatus) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall (a :: Format). Iso' (Time a) UTCTime
Data._Time

instance Data.FromJSON QueryExecutionStatus where
  parseJSON :: Value -> Parser QueryExecutionStatus
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"QueryExecutionStatus"
      ( \Object
x ->
          Maybe AthenaError
-> Maybe POSIX
-> Maybe QueryExecutionState
-> Maybe Text
-> Maybe POSIX
-> QueryExecutionStatus
QueryExecutionStatus'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"AthenaError")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"CompletionDateTime")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"State")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"StateChangeReason")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"SubmissionDateTime")
      )

instance Prelude.Hashable QueryExecutionStatus where
  hashWithSalt :: Int -> QueryExecutionStatus -> Int
hashWithSalt Int
_salt QueryExecutionStatus' {Maybe Text
Maybe POSIX
Maybe AthenaError
Maybe QueryExecutionState
submissionDateTime :: Maybe POSIX
stateChangeReason :: Maybe Text
state :: Maybe QueryExecutionState
completionDateTime :: Maybe POSIX
athenaError :: Maybe AthenaError
$sel:submissionDateTime:QueryExecutionStatus' :: QueryExecutionStatus -> Maybe POSIX
$sel:stateChangeReason:QueryExecutionStatus' :: QueryExecutionStatus -> Maybe Text
$sel:state:QueryExecutionStatus' :: QueryExecutionStatus -> Maybe QueryExecutionState
$sel:completionDateTime:QueryExecutionStatus' :: QueryExecutionStatus -> Maybe POSIX
$sel:athenaError:QueryExecutionStatus' :: QueryExecutionStatus -> Maybe AthenaError
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe AthenaError
athenaError
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
completionDateTime
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe QueryExecutionState
state
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
stateChangeReason
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
submissionDateTime

instance Prelude.NFData QueryExecutionStatus where
  rnf :: QueryExecutionStatus -> ()
rnf QueryExecutionStatus' {Maybe Text
Maybe POSIX
Maybe AthenaError
Maybe QueryExecutionState
submissionDateTime :: Maybe POSIX
stateChangeReason :: Maybe Text
state :: Maybe QueryExecutionState
completionDateTime :: Maybe POSIX
athenaError :: Maybe AthenaError
$sel:submissionDateTime:QueryExecutionStatus' :: QueryExecutionStatus -> Maybe POSIX
$sel:stateChangeReason:QueryExecutionStatus' :: QueryExecutionStatus -> Maybe Text
$sel:state:QueryExecutionStatus' :: QueryExecutionStatus -> Maybe QueryExecutionState
$sel:completionDateTime:QueryExecutionStatus' :: QueryExecutionStatus -> Maybe POSIX
$sel:athenaError:QueryExecutionStatus' :: QueryExecutionStatus -> Maybe AthenaError
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe AthenaError
athenaError
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
completionDateTime
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe QueryExecutionState
state
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
stateChangeReason
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
submissionDateTime