You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Comprehend::Types::BatchItemError

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

Overview

Describes an error that occurred while processing a document in a batch. The operation returns on BatchItemError object for each document that contained an error.

Instance Attribute Summary collapse

Instance Attribute Details

#error_codeString

The numeric error code of the error.

Returns:

  • (String)


304
305
306
307
308
309
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 304

class BatchItemError < Struct.new(
  :index,
  :error_code,
  :error_message)
  include Aws::Structure
end

#error_messageString

A text description of the error.

Returns:

  • (String)


304
305
306
307
308
309
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 304

class BatchItemError < Struct.new(
  :index,
  :error_code,
  :error_message)
  include Aws::Structure
end

#indexInteger

The zero-based index of the document in the input list.

Returns:

  • (Integer)


304
305
306
307
308
309
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 304

class BatchItemError < Struct.new(
  :index,
  :error_code,
  :error_message)
  include Aws::Structure
end