Skip to content

AthenaError

Source code in docs_src/capo_athena/types/athena_error.py
class AthenaError(TypedDict, closed=True):
    error_category: NotRequired["capo_athena.types.error_category.ErrorCategory"]
    """<p>An integer value that specifies the category of a query failure error. The following list shows the category for each integer value.</p> <p> <b>1</b> - System</p> <p> <b>2</b> - User</p> <p> <b>3</b> - Other</p>"""
    error_type: NotRequired["capo_athena.types.error_type.ErrorType"]
    """<p>An integer value that provides specific information about an Athena query error. For the meaning of specific values, see the <a href="https://docs.aws.amazon.com/athena/latest/ug/error-reference.html#error-reference-error-type-reference">Error Type Reference</a> in the <i>Amazon Athena User Guide</i>.</p>"""
    retryable: "capo_athena.types.boolean.Boolean"
    """<p>True if the query might succeed if resubmitted.</p>"""
    error_message: NotRequired["capo_athena.types.string.String"]
    """<p>Contains a short description of the error that occurred.</p>"""

error_category instance-attribute

error_category: NotRequired[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

error_message instance-attribute

error_message: NotRequired[String]

Contains a short description of the error that occurred.

error_type instance-attribute

error_type: NotRequired[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.

retryable instance-attribute

retryable: Boolean

True if the query might succeed if resubmitted.