Amazonka.Kendra.Types.Status

Documentation

data Status

Provides information about the status of documents submitted for indexing.

See: newStatus smart constructor.

Constructors

Status'

Fields

• documentId :: Maybe Text

  The identifier of the document.

• documentStatus :: Maybe DocumentStatus

  The current status of a document.

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

• failureCode :: Maybe Text

  Indicates the source of the error.

• failureReason :: Maybe Text

  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.

Instances

FromJSON Status

Defined in Amazonka.Kendra.Types.Status

Methods

parseJSON :: Value -> Parser Status

parseJSONList :: Value -> Parser [Status]

Generic Status

Defined in Amazonka.Kendra.Types.Status

Associated Types

type Rep Status :: Type -> Type

Methods

from :: Status -> Rep Status x

to :: Rep Status x -> Status

Read Status

Defined in Amazonka.Kendra.Types.Status

Methods

readsPrec :: Int -> ReadS Status

readList :: ReadS [Status]

readPrec :: ReadPrec Status

readListPrec :: ReadPrec [Status]

Show Status

Defined in Amazonka.Kendra.Types.Status

Methods

showsPrec :: Int -> Status -> ShowS

show :: Status -> String

showList :: [Status] -> ShowS

NFData Status

Defined in Amazonka.Kendra.Types.Status

Methods

rnf :: Status -> ()

Eq Status

Defined in Amazonka.Kendra.Types.Status

Methods

(==) :: Status -> Status -> Bool

(/=) :: Status -> Status -> Bool

Hashable Status

Defined in Amazonka.Kendra.Types.Status

Methods

hashWithSalt :: Int -> Status -> Int

hash :: Status -> Int

type Rep Status

Defined in Amazonka.Kendra.Types.Status

type Rep Status = D1 ('MetaData "Status" "Amazonka.Kendra.Types.Status" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "Status'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "documentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "documentStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentStatus))) :*: (S1 ('MetaSel ('Just "failureCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newStatus :: Status

Create a value of Status with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:documentId:Status', status_documentId - The identifier of the document.

$sel:documentStatus:Status', status_documentStatus - The current status of a document.

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

$sel:failureCode:Status', status_failureCode - Indicates the source of the error.

$sel:failureReason:Status', status_failureReason - 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.

status_documentId :: Lens' Status (Maybe Text)

The identifier of the document.

status_documentStatus :: Lens' Status (Maybe DocumentStatus)

The current status of a document.

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

status_failureCode :: Lens' Status (Maybe Text)

Indicates the source of the error.

status_failureReason :: Lens' Status (Maybe Text)

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.