TextractClient#
Auto-generated documentation for Textract type annotations stubs module mypy-boto3-textract.
TextractClient#
Type annotations and code completion for boto3.client("textract")
.
boto3 documentation
# TextractClient usage example
from boto3.session import Session
from mypy_boto3_textract.client import TextractClient
def get_textract_client() -> TextractClient:
return Session().client("textract")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("textract").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("textract")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.BadDocumentException,
client.exceptions.ClientError,
client.exceptions.DocumentTooLargeException,
client.exceptions.HumanLoopQuotaExceededException,
client.exceptions.IdempotentParameterMismatchException,
client.exceptions.InternalServerError,
client.exceptions.InvalidJobIdException,
client.exceptions.InvalidKMSKeyException,
client.exceptions.InvalidParameterException,
client.exceptions.InvalidS3ObjectException,
client.exceptions.LimitExceededException,
client.exceptions.ProvisionedThroughputExceededException,
client.exceptions.ThrottlingException,
client.exceptions.UnsupportedDocumentException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_textract.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
analyze_document#
Analyzes an input document for relationships between detected items.
Type annotations and code completion for boto3.client("textract").analyze_document
method.
boto3 documentation
# analyze_document method definition
def analyze_document(
self,
*,
Document: DocumentTypeDef, # (1)
FeatureTypes: Sequence[FeatureTypeType], # (2)
HumanLoopConfig: HumanLoopConfigTypeDef = ..., # (3)
QueriesConfig: QueriesConfigTypeDef = ..., # (4)
) -> AnalyzeDocumentResponseTypeDef: # (5)
...
- See DocumentTypeDef
- See FeatureTypeType
- See HumanLoopConfigTypeDef
- See QueriesConfigTypeDef
- See AnalyzeDocumentResponseTypeDef
# analyze_document method usage example with argument unpacking
kwargs: AnalyzeDocumentRequestRequestTypeDef = { # (1)
"Document": ...,
"FeatureTypes": ...,
}
parent.analyze_document(**kwargs)
analyze_expense#
AnalyzeExpense
synchronously analyzes an input document for financially
related relationships between text.
Type annotations and code completion for boto3.client("textract").analyze_expense
method.
boto3 documentation
# analyze_expense method definition
def analyze_expense(
self,
*,
Document: DocumentTypeDef, # (1)
) -> AnalyzeExpenseResponseTypeDef: # (2)
...
# analyze_expense method usage example with argument unpacking
kwargs: AnalyzeExpenseRequestRequestTypeDef = { # (1)
"Document": ...,
}
parent.analyze_expense(**kwargs)
analyze_id#
Analyzes identity documents for relevant information.
Type annotations and code completion for boto3.client("textract").analyze_id
method.
boto3 documentation
# analyze_id method definition
def analyze_id(
self,
*,
DocumentPages: Sequence[DocumentTypeDef], # (1)
) -> AnalyzeIDResponseTypeDef: # (2)
...
# analyze_id method usage example with argument unpacking
kwargs: AnalyzeIDRequestRequestTypeDef = { # (1)
"DocumentPages": ...,
}
parent.analyze_id(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("textract").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("textract").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
detect_document_text#
Detects text in the input document.
Type annotations and code completion for boto3.client("textract").detect_document_text
method.
boto3 documentation
# detect_document_text method definition
def detect_document_text(
self,
*,
Document: DocumentTypeDef, # (1)
) -> DetectDocumentTextResponseTypeDef: # (2)
...
# detect_document_text method usage example with argument unpacking
kwargs: DetectDocumentTextRequestRequestTypeDef = { # (1)
"Document": ...,
}
parent.detect_document_text(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("textract").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_document_analysis#
Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.
Type annotations and code completion for boto3.client("textract").get_document_analysis
method.
boto3 documentation
# get_document_analysis method definition
def get_document_analysis(
self,
*,
JobId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> GetDocumentAnalysisResponseTypeDef: # (1)
...
# get_document_analysis method usage example with argument unpacking
kwargs: GetDocumentAnalysisRequestRequestTypeDef = { # (1)
"JobId": ...,
}
parent.get_document_analysis(**kwargs)
get_document_text_detection#
Gets the results for an Amazon Textract asynchronous operation that detects text in a document.
Type annotations and code completion for boto3.client("textract").get_document_text_detection
method.
boto3 documentation
# get_document_text_detection method definition
def get_document_text_detection(
self,
*,
JobId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> GetDocumentTextDetectionResponseTypeDef: # (1)
...
# get_document_text_detection method usage example with argument unpacking
kwargs: GetDocumentTextDetectionRequestRequestTypeDef = { # (1)
"JobId": ...,
}
parent.get_document_text_detection(**kwargs)
get_expense_analysis#
Gets the results for an Amazon Textract asynchronous operation that analyzes invoices and receipts.
Type annotations and code completion for boto3.client("textract").get_expense_analysis
method.
boto3 documentation
# get_expense_analysis method definition
def get_expense_analysis(
self,
*,
JobId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> GetExpenseAnalysisResponseTypeDef: # (1)
...
# get_expense_analysis method usage example with argument unpacking
kwargs: GetExpenseAnalysisRequestRequestTypeDef = { # (1)
"JobId": ...,
}
parent.get_expense_analysis(**kwargs)
get_lending_analysis#
Gets the results for an Amazon Textract asynchronous operation that analyzes text in a lending document.
Type annotations and code completion for boto3.client("textract").get_lending_analysis
method.
boto3 documentation
# get_lending_analysis method definition
def get_lending_analysis(
self,
*,
JobId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> GetLendingAnalysisResponseTypeDef: # (1)
...
# get_lending_analysis method usage example with argument unpacking
kwargs: GetLendingAnalysisRequestRequestTypeDef = { # (1)
"JobId": ...,
}
parent.get_lending_analysis(**kwargs)
get_lending_analysis_summary#
Gets summarized results for the StartLendingAnalysis
operation, which analyzes
text in a lending document.
Type annotations and code completion for boto3.client("textract").get_lending_analysis_summary
method.
boto3 documentation
# get_lending_analysis_summary method definition
def get_lending_analysis_summary(
self,
*,
JobId: str,
) -> GetLendingAnalysisSummaryResponseTypeDef: # (1)
...
# get_lending_analysis_summary method usage example with argument unpacking
kwargs: GetLendingAnalysisSummaryRequestRequestTypeDef = { # (1)
"JobId": ...,
}
parent.get_lending_analysis_summary(**kwargs)
start_document_analysis#
Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements.
Type annotations and code completion for boto3.client("textract").start_document_analysis
method.
boto3 documentation
# start_document_analysis method definition
def start_document_analysis(
self,
*,
DocumentLocation: DocumentLocationTypeDef, # (1)
FeatureTypes: Sequence[FeatureTypeType], # (2)
ClientRequestToken: str = ...,
JobTag: str = ...,
NotificationChannel: NotificationChannelTypeDef = ..., # (3)
OutputConfig: OutputConfigTypeDef = ..., # (4)
KMSKeyId: str = ...,
QueriesConfig: QueriesConfigTypeDef = ..., # (5)
) -> StartDocumentAnalysisResponseTypeDef: # (6)
...
- See DocumentLocationTypeDef
- See FeatureTypeType
- See NotificationChannelTypeDef
- See OutputConfigTypeDef
- See QueriesConfigTypeDef
- See StartDocumentAnalysisResponseTypeDef
# start_document_analysis method usage example with argument unpacking
kwargs: StartDocumentAnalysisRequestRequestTypeDef = { # (1)
"DocumentLocation": ...,
"FeatureTypes": ...,
}
parent.start_document_analysis(**kwargs)
start_document_text_detection#
Starts the asynchronous detection of text in a document.
Type annotations and code completion for boto3.client("textract").start_document_text_detection
method.
boto3 documentation
# start_document_text_detection method definition
def start_document_text_detection(
self,
*,
DocumentLocation: DocumentLocationTypeDef, # (1)
ClientRequestToken: str = ...,
JobTag: str = ...,
NotificationChannel: NotificationChannelTypeDef = ..., # (2)
OutputConfig: OutputConfigTypeDef = ..., # (3)
KMSKeyId: str = ...,
) -> StartDocumentTextDetectionResponseTypeDef: # (4)
...
- See DocumentLocationTypeDef
- See NotificationChannelTypeDef
- See OutputConfigTypeDef
- See StartDocumentTextDetectionResponseTypeDef
# start_document_text_detection method usage example with argument unpacking
kwargs: StartDocumentTextDetectionRequestRequestTypeDef = { # (1)
"DocumentLocation": ...,
}
parent.start_document_text_detection(**kwargs)
start_expense_analysis#
Starts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names.
Type annotations and code completion for boto3.client("textract").start_expense_analysis
method.
boto3 documentation
# start_expense_analysis method definition
def start_expense_analysis(
self,
*,
DocumentLocation: DocumentLocationTypeDef, # (1)
ClientRequestToken: str = ...,
JobTag: str = ...,
NotificationChannel: NotificationChannelTypeDef = ..., # (2)
OutputConfig: OutputConfigTypeDef = ..., # (3)
KMSKeyId: str = ...,
) -> StartExpenseAnalysisResponseTypeDef: # (4)
...
- See DocumentLocationTypeDef
- See NotificationChannelTypeDef
- See OutputConfigTypeDef
- See StartExpenseAnalysisResponseTypeDef
# start_expense_analysis method usage example with argument unpacking
kwargs: StartExpenseAnalysisRequestRequestTypeDef = { # (1)
"DocumentLocation": ...,
}
parent.start_expense_analysis(**kwargs)
start_lending_analysis#
Starts the classification and analysis of an input document.
Type annotations and code completion for boto3.client("textract").start_lending_analysis
method.
boto3 documentation
# start_lending_analysis method definition
def start_lending_analysis(
self,
*,
DocumentLocation: DocumentLocationTypeDef, # (1)
ClientRequestToken: str = ...,
JobTag: str = ...,
NotificationChannel: NotificationChannelTypeDef = ..., # (2)
OutputConfig: OutputConfigTypeDef = ..., # (3)
KMSKeyId: str = ...,
) -> StartLendingAnalysisResponseTypeDef: # (4)
...
- See DocumentLocationTypeDef
- See NotificationChannelTypeDef
- See OutputConfigTypeDef
- See StartLendingAnalysisResponseTypeDef
# start_lending_analysis method usage example with argument unpacking
kwargs: StartLendingAnalysisRequestRequestTypeDef = { # (1)
"DocumentLocation": ...,
}
parent.start_lending_analysis(**kwargs)