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

Amazonka.Athena.Types.AthenaError

Description

Synopsis

Documentation

data AthenaError Source #

Provides information about an Athena query error. The AthenaError feature provides standardized error information to help you understand failed queries and take steps after a query failure occurs. AthenaError includes an ErrorCategory field that specifies whether the cause of the failed query is due to system error, user error, or other error.

See: newAthenaError smart constructor.

Constructors

AthenaError'

Fields

errorCategory :: Maybe Natural
An integer value that specifies the category of a query failure error. The following list shows the category for each integer value.
1 - System
2 - User
3 - Other
errorMessage :: Maybe Text
Contains a short description of the error that occurred.
errorType :: Maybe Natural
An integer value that provides specific information about an Athena query error. For the meaning of specific values, see the Error Type Reference in the Amazon Athena User Guide.
retryable :: Maybe Bool
True if the query might succeed if resubmitted.

Instances

Instances details

FromJSON AthenaError Source #
Instance details Defined in Amazonka.Athena.Types.AthenaError Methods parseJSON :: Value -> Parser AthenaError # parseJSONList :: Value -> Parser [AthenaError] #
Generic AthenaError Source #
Instance details Defined in Amazonka.Athena.Types.AthenaError Associated Types type Rep AthenaError :: Type -> Type # Methods from :: AthenaError -> Rep AthenaError x # to :: Rep AthenaError x -> AthenaError #
Read AthenaError Source #
Instance details Defined in Amazonka.Athena.Types.AthenaError Methods readsPrec :: Int -> ReadS AthenaError # readList :: ReadS [AthenaError] # readPrec :: ReadPrec AthenaError # readListPrec :: ReadPrec [AthenaError] #
Show AthenaError Source #
Instance details Defined in Amazonka.Athena.Types.AthenaError Methods showsPrec :: Int -> AthenaError -> ShowS # show :: AthenaError -> String # showList :: [AthenaError] -> ShowS #
NFData AthenaError Source #
Instance details Defined in Amazonka.Athena.Types.AthenaError Methods rnf :: AthenaError -> () #
Eq AthenaError Source #
Instance details Defined in Amazonka.Athena.Types.AthenaError Methods (==) :: AthenaError -> AthenaError -> Bool # (/=) :: AthenaError -> AthenaError -> Bool #
Hashable AthenaError Source #
Instance details Defined in Amazonka.Athena.Types.AthenaError Methods hashWithSalt :: Int -> AthenaError -> Int # hash :: AthenaError -> Int #
type Rep AthenaError Source #
Instance details Defined in Amazonka.Athena.Types.AthenaError type Rep AthenaError = D1 ('MetaData "AthenaError" "Amazonka.Athena.Types.AthenaError" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "AthenaError'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "errorCategory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "errorType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "retryable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))

newAthenaError :: AthenaError Source #

Create a value of AthenaError 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:errorCategory:AthenaError', athenaError_errorCategory - An integer value that specifies the category of a query failure error. The following list shows the category for each integer value.

1 - System

2 - User

3 - Other

$sel:errorMessage:AthenaError', athenaError_errorMessage - Contains a short description of the error that occurred.

$sel:errorType:AthenaError', athenaError_errorType - An integer value that provides specific information about an Athena query error. For the meaning of specific values, see the Error Type Reference in the Amazon Athena User Guide.

$sel:retryable:AthenaError', athenaError_retryable - True if the query might succeed if resubmitted.

athenaError_errorCategory :: Lens' AthenaError (Maybe Natural) Source #

An integer value that specifies the category of a query failure error. The following list shows the category for each integer value.

1 - System

2 - User

3 - Other

athenaError_errorMessage :: Lens' AthenaError (Maybe Text) Source #

Contains a short description of the error that occurred.

athenaError_errorType :: Lens' AthenaError (Maybe Natural) Source #

An integer value that provides specific information about an Athena query error. For the meaning of specific values, see the Error Type Reference in the Amazon Athena User Guide.

athenaError_retryable :: Lens' AthenaError (Maybe Bool) Source #

True if the query might succeed if resubmitted.