Class: Aws::Kendra::Types::Status

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::Status

Includes:

Structure

Defined in:

lib/aws-sdk-kendra/types.rb

Overview

Provides information about the status of documents submitted for indexing.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #document_id ⇒ String

  The identifier of the document.

• #document_status ⇒ String

  The current status of a document.

• #failure_code ⇒ String

  Indicates the source of the error.

• #failure_reason ⇒ String

  Provides detailed information about why the document couldn’t be indexed.

Instance Attribute Details

#document_id ⇒ String

The identifier of the document.

# File 'lib/aws-sdk-kendra/types.rb', line 9786

class Status < Struct.new(
  :document_id,
  :document_status,
  :failure_code,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#document_status ⇒ String

The current status of a document.

If the document was submitted for deletion, the status is ‘NOT_FOUND` after the document is deleted.

# File 'lib/aws-sdk-kendra/types.rb', line 9786

class Status < Struct.new(
  :document_id,
  :document_status,
  :failure_code,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#failure_code ⇒ String

Indicates the source of the error.

# File 'lib/aws-sdk-kendra/types.rb', line 9786

class Status < Struct.new(
  :document_id,
  :document_status,
  :failure_code,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reason ⇒ String

Provides detailed information about why the document couldn’t be indexed. Use this information to correct the error before you resubmit the document for indexing.

# File 'lib/aws-sdk-kendra/types.rb', line 9786

class Status < Struct.new(
  :document_id,
  :document_status,
  :failure_code,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end