Skip to content

/AWS1/CL_ATHATHENAERROR

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.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_errorcategory TYPE /AWS1/ATHERRORCATEGORY /AWS1/ATHERRORCATEGORY

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

iv_errortype TYPE /AWS1/ATHERRORTYPE /AWS1/ATHERRORTYPE

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.

iv_retryable TYPE /AWS1/ATHBOOLEAN /AWS1/ATHBOOLEAN

True if the query might succeed if resubmitted.

iv_errormessage TYPE /AWS1/ATHSTRING /AWS1/ATHSTRING

Contains a short description of the error that occurred.


Queryable Attributes

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

Accessible with the following methods

Method Description
GET_ERRORCATEGORY() Getter for ERRORCATEGORY, with configurable default
ASK_ERRORCATEGORY() Getter for ERRORCATEGORY w/ exceptions if field has no value
HAS_ERRORCATEGORY() Determine if ERRORCATEGORY has a value

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.

Accessible with the following methods

Method Description
GET_ERRORTYPE() Getter for ERRORTYPE, with configurable default
ASK_ERRORTYPE() Getter for ERRORTYPE w/ exceptions if field has no value
HAS_ERRORTYPE() Determine if ERRORTYPE has a value

Retryable

True if the query might succeed if resubmitted.

Accessible with the following methods

Method Description
GET_RETRYABLE() Getter for RETRYABLE

ErrorMessage

Contains a short description of the error that occurred.

Accessible with the following methods

Method Description
GET_ERRORMESSAGE() Getter for ERRORMESSAGE, with configurable default
ASK_ERRORMESSAGE() Getter for ERRORMESSAGE w/ exceptions if field has no value
HAS_ERRORMESSAGE() Determine if ERRORMESSAGE has a value