Class: Aws::Athena::Types::AthenaError

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb

Overview

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#error_categoryInteger

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

Returns:

  • (Integer)


90
91
92
93
94
95
96
97
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 90

class AthenaError < Struct.new(
  :error_category,
  :error_type,
  :retryable,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#error_messageString

Contains a short description of the error that occurred.

Returns:

  • (String)


90
91
92
93
94
95
96
97
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 90

class AthenaError < Struct.new(
  :error_category,
  :error_type,
  :retryable,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#error_typeInteger

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.

Returns:

  • (Integer)


90
91
92
93
94
95
96
97
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 90

class AthenaError < Struct.new(
  :error_category,
  :error_type,
  :retryable,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#retryableBoolean

True if the query might succeed if resubmitted.

Returns:

  • (Boolean)


90
91
92
93
94
95
96
97
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 90

class AthenaError < Struct.new(
  :error_category,
  :error_type,
  :retryable,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end