Skip to content

GetDocumentAnalysisRequest

Source code in docs_src/capo_textract/types/get_document_analysis_request.py 
15
16
17
18
19
20
21
class GetDocumentAnalysisRequest(TypedDict, closed=True):
    job_id: "capo_textract.types.job_id.JobId"
    """<p>A unique identifier for the text-detection job. The <code>JobId</code> is returned from <code>StartDocumentAnalysis</code>. A <code>JobId</code> value is only valid for 7 days.</p>"""
    max_results: NotRequired["capo_textract.types.max_results.MaxResults"]
    """<p>The maximum number of results to return per paginated call. The largest value that you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.</p>"""
    next_token: NotRequired["capo_textract.types.pagination_token.PaginationToken"]
    """<p>If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.</p>"""

job_id instance-attribute 

job_id: JobId

A unique identifier for the text-detection job. The JobId is returned from StartDocumentAnalysis. A JobId value is only valid for 7 days.

max_results instance-attribute 

max_results: NotRequired[MaxResults]

The maximum number of results to return per paginated call. The largest value that you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.

next_token instance-attribute 

next_token: NotRequired[PaginationToken]

If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.