DocumentDetails - Amazon Q Business

DocumentDetails

The details of a document within an Amazon Q Business index.

Contents

createdAt

The timestamp for when the document was created.

Type: Timestamp

Required: No

documentId

The identifier of the document.

Type: String

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

Pattern: \P{C}*

Required: No

error

An error message associated with the document.

Type: ErrorDetail object

Required: No

status

The current status of the document.

Type: String

Valid Values: RECEIVED | PROCESSING | INDEXED | UPDATED | FAILED | DELETING | DELETED | DOCUMENT_FAILED_TO_INDEX

Required: No

updatedAt

The timestamp for when the document was last updated.

Type: Timestamp

Required: No

See Also

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