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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kendra/types.rb

Overview

Provides information about the status of documents submitted for indexing.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#document_id ⇒ String

The identifier of the document.

Returns:

  • (String) 


9999
10000
10001
10002
10003
10004
10005
10006
 
# File 'lib/aws-sdk-kendra/types.rb', line 9999

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.

Returns:

  • (String) 


9999
10000
10001
10002
10003
10004
10005
10006
 
# File 'lib/aws-sdk-kendra/types.rb', line 9999

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.

Returns:

  • (String) 


9999
10000
10001
10002
10003
10004
10005
10006
 
# File 'lib/aws-sdk-kendra/types.rb', line 9999

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.

Returns:

  • (String) 


9999
10000
10001
10002
10003
10004
10005
10006
 
# File 'lib/aws-sdk-kendra/types.rb', line 9999

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