Status

Provides information about the status of documents submitted for indexing.

Contents

DocumentId

The identifier of the document.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

DocumentStatus

The current status of a document.

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

Type: String

Valid Values: NOT_FOUND | PROCESSING | INDEXED | UPDATED | FAILED | UPDATE_FAILED

Required: No

FailureCode

Indicates the source of the error.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for Ruby V3