Skip to content

TextractClient#

Index > Textract > 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.ConflictException,
    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.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.UnsupportedDocumentException,
    client.exceptions.ValidationException,
) 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)
    AdaptersConfig: AdaptersConfigTypeDef = ...,  # (5)
) -> AnalyzeDocumentResponseTypeDef:  # (6)
    ...
  1. See DocumentTypeDef
  2. See FeatureTypeType
  3. See HumanLoopConfigTypeDef
  4. See QueriesConfigTypeDef
  5. See AdaptersConfigTypeDef
  6. See AnalyzeDocumentResponseTypeDef
# analyze_document method usage example with argument unpacking

kwargs: AnalyzeDocumentRequestRequestTypeDef = {  # (1)
    "Document": ...,
    "FeatureTypes": ...,
}

parent.analyze_document(**kwargs)
  1. See AnalyzeDocumentRequestRequestTypeDef

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)
    ...
  1. See DocumentTypeDef
  2. See AnalyzeExpenseResponseTypeDef
# analyze_expense method usage example with argument unpacking

kwargs: AnalyzeExpenseRequestRequestTypeDef = {  # (1)
    "Document": ...,
}

parent.analyze_expense(**kwargs)
  1. See AnalyzeExpenseRequestRequestTypeDef

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)
    ...
  1. See DocumentTypeDef
  2. See AnalyzeIDResponseTypeDef
# analyze_id method usage example with argument unpacking

kwargs: AnalyzeIDRequestRequestTypeDef = {  # (1)
    "DocumentPages": ...,
}

parent.analyze_id(**kwargs)
  1. See AnalyzeIDRequestRequestTypeDef

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:
    ...

create_adapter#

Creates an adapter, which can be fine-tuned for enhanced performance on user provided documents.

Type annotations and code completion for boto3.client("textract").create_adapter method. boto3 documentation

# create_adapter method definition

def create_adapter(
    self,
    *,
    AdapterName: str,
    FeatureTypes: Sequence[FeatureTypeType],  # (1)
    ClientRequestToken: str = ...,
    Description: str = ...,
    AutoUpdate: AutoUpdateType = ...,  # (2)
    Tags: Mapping[str, str] = ...,
) -> CreateAdapterResponseTypeDef:  # (3)
    ...
  1. See FeatureTypeType
  2. See AutoUpdateType
  3. See CreateAdapterResponseTypeDef
# create_adapter method usage example with argument unpacking

kwargs: CreateAdapterRequestRequestTypeDef = {  # (1)
    "AdapterName": ...,
    "FeatureTypes": ...,
}

parent.create_adapter(**kwargs)
  1. See CreateAdapterRequestRequestTypeDef

create_adapter_version#

Creates a new version of an adapter.

Type annotations and code completion for boto3.client("textract").create_adapter_version method. boto3 documentation

# create_adapter_version method definition

def create_adapter_version(
    self,
    *,
    AdapterId: str,
    DatasetConfig: AdapterVersionDatasetConfigTypeDef,  # (1)
    OutputConfig: OutputConfigTypeDef,  # (2)
    ClientRequestToken: str = ...,
    KMSKeyId: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateAdapterVersionResponseTypeDef:  # (3)
    ...
  1. See AdapterVersionDatasetConfigTypeDef
  2. See OutputConfigTypeDef
  3. See CreateAdapterVersionResponseTypeDef
# create_adapter_version method usage example with argument unpacking

kwargs: CreateAdapterVersionRequestRequestTypeDef = {  # (1)
    "AdapterId": ...,
    "DatasetConfig": ...,
    "OutputConfig": ...,
}

parent.create_adapter_version(**kwargs)
  1. See CreateAdapterVersionRequestRequestTypeDef

delete_adapter#

Deletes an Amazon Textract adapter.

Type annotations and code completion for boto3.client("textract").delete_adapter method. boto3 documentation

# delete_adapter method definition

def delete_adapter(
    self,
    *,
    AdapterId: str,
) -> Dict[str, Any]:
    ...
# delete_adapter method usage example with argument unpacking

kwargs: DeleteAdapterRequestRequestTypeDef = {  # (1)
    "AdapterId": ...,
}

parent.delete_adapter(**kwargs)
  1. See DeleteAdapterRequestRequestTypeDef

delete_adapter_version#

Deletes an Amazon Textract adapter version.

Type annotations and code completion for boto3.client("textract").delete_adapter_version method. boto3 documentation

# delete_adapter_version method definition

def delete_adapter_version(
    self,
    *,
    AdapterId: str,
    AdapterVersion: str,
) -> Dict[str, Any]:
    ...
# delete_adapter_version method usage example with argument unpacking

kwargs: DeleteAdapterVersionRequestRequestTypeDef = {  # (1)
    "AdapterId": ...,
    "AdapterVersion": ...,
}

parent.delete_adapter_version(**kwargs)
  1. See DeleteAdapterVersionRequestRequestTypeDef

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)
    ...
  1. See DocumentTypeDef
  2. See DetectDocumentTextResponseTypeDef
# detect_document_text method usage example with argument unpacking

kwargs: DetectDocumentTextRequestRequestTypeDef = {  # (1)
    "Document": ...,
}

parent.detect_document_text(**kwargs)
  1. See DetectDocumentTextRequestRequestTypeDef

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_adapter#

Gets configuration information for an adapter specified by an AdapterId, returning information on AdapterName, Description, CreationTime, AutoUpdate status, and FeatureTypes.

Type annotations and code completion for boto3.client("textract").get_adapter method. boto3 documentation

# get_adapter method definition

def get_adapter(
    self,
    *,
    AdapterId: str,
) -> GetAdapterResponseTypeDef:  # (1)
    ...
  1. See GetAdapterResponseTypeDef
# get_adapter method usage example with argument unpacking

kwargs: GetAdapterRequestRequestTypeDef = {  # (1)
    "AdapterId": ...,
}

parent.get_adapter(**kwargs)
  1. See GetAdapterRequestRequestTypeDef

get_adapter_version#

Gets configuration information for the specified adapter version, including: AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and EvaluationMetrics.

Type annotations and code completion for boto3.client("textract").get_adapter_version method. boto3 documentation

# get_adapter_version method definition

def get_adapter_version(
    self,
    *,
    AdapterId: str,
    AdapterVersion: str,
) -> GetAdapterVersionResponseTypeDef:  # (1)
    ...
  1. See GetAdapterVersionResponseTypeDef
# get_adapter_version method usage example with argument unpacking

kwargs: GetAdapterVersionRequestRequestTypeDef = {  # (1)
    "AdapterId": ...,
    "AdapterVersion": ...,
}

parent.get_adapter_version(**kwargs)
  1. See GetAdapterVersionRequestRequestTypeDef

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)
    ...
  1. See GetDocumentAnalysisResponseTypeDef
# get_document_analysis method usage example with argument unpacking

kwargs: GetDocumentAnalysisRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.get_document_analysis(**kwargs)
  1. See GetDocumentAnalysisRequestRequestTypeDef

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)
    ...
  1. See GetDocumentTextDetectionResponseTypeDef
# get_document_text_detection method usage example with argument unpacking

kwargs: GetDocumentTextDetectionRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.get_document_text_detection(**kwargs)
  1. See GetDocumentTextDetectionRequestRequestTypeDef

get_expense_analysis#

Gets the results for an Amazon Textract asynchronous operation that analyzes invoices and receipts.

Type annotations and code comp