Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

Preferences
Contact Us
Feedback
AWS Documentation
Create an AWS Account

Status

PDF
Focus mode
Status - Amazon Kendra API Reference
ContentsSee Also

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:

On this page

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.