Skip to content

Comprehend module#

Index > Comprehend

Auto-generated documentation for Comprehend type annotations stubs module types-boto3-comprehend.

How to install#

You can generate type annotations for boto3 package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.37.3' mypy-boto3-builder
  2. Select boto3 AWS SDK.
  3. Add Comprehend service.
  4. Use provided commands to install generated packages.

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and Comprehend.

From PyPI with pip#

Install types-boto3 for Comprehend service.

# install with boto3 type annotations
python -m pip install 'types-boto3[comprehend]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[comprehend]'

# standalone installation
python -m pip install types-boto3-comprehend

How to uninstall#

python -m pip uninstall -y types-boto3-comprehend

Usage#

Code samples can be found in Examples.

ComprehendClient#

Type annotations and code completion for boto3.client("comprehend") as ComprehendClient boto3 documentation

# ComprehendClient usage example

from boto3.session import Session

from types_boto3_comprehend.client import ComprehendClient

def get_client() -> ComprehendClient:
    return Session().client("comprehend")

Paginators#

Type annotations and code completion for paginators from boto3.client("comprehend").get_paginator("...").

# ListDocumentClassificationJobsPaginator usage example

from boto3.session import Session

from types_boto3_comprehend.paginator import ListDocumentClassificationJobsPaginator

def get_list_document_classification_jobs_paginator() -> ListDocumentClassificationJobsPaginator:
    return Session().client("comprehend").get_paginator("list_document_classification_jobs"))

Literals#

Type annotations for literals used in methods and schema.

# AugmentedManifestsDocumentTypeFormatType usage example

from types_boto3_comprehend.literals import AugmentedManifestsDocumentTypeFormatType

def get_value() -> AugmentedManifestsDocumentTypeFormatType:
    return "PLAIN_TEXT_DOCUMENT"

Type definitions#

Type annotations for type definitions used in methods and schema.