Skip to content

Status

Source code in docs_src/capo_kendra/types/status.py 
13
14
15
16
17
18
19
20
21
class Status(TypedDict, closed=True):
    document_id: NotRequired["capo_kendra.types.document_id.DocumentId"]
    """<p>The identifier of the document.</p>"""
    document_status: NotRequired["capo_kendra.types.document_status.DocumentStatus"]
    """<p>The current status of a document.</p> <p>If the document was submitted for deletion, the status is <code>NOT_FOUND</code> after the document is deleted.</p>"""
    failure_code: NotRequired["capo_kendra.types.string.String"]
    """<p>Indicates the source of the error.</p>"""
    failure_reason: NotRequired["capo_kendra.types.string.String"]
    """<p>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.</p>"""

document_id instance-attribute 

document_id: NotRequired[DocumentId]

The identifier of the document.

document_status instance-attribute 

document_status: NotRequired[DocumentStatus]

The current status of a document.

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

failure_code instance-attribute 

failure_code: NotRequired[String]

Indicates the source of the error.

failure_reason instance-attribute 

failure_reason: NotRequired[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.