Skip to content

Comprehend module

Index > Comprehend

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

How to install

From PyPI with pip

Install types-aioboto3 for Comprehend service.

# install with aioboto3 type annotations
python -m pip install 'types-aioboto3[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-aioboto3-lite[comprehend]'


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

How to uninstall

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

Usage

Code samples can be found in Examples.

ComprehendClient

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

Usage example
from aioboto3.session import Session

from types_aiobotocore_comprehend.client import ComprehendClient


session = Session()
async with session.client("comprehend") as client:
    client: ComprehendClient

Paginators

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

Usage example
from types_aiobotocore_comprehend.paginator import ListDocumentClassificationJobsPaginator

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

Literals

Type annotations for literals used in methods and schema.

Usage example
from types_aiobotocore_comprehend.literals import AugmentedManifestsDocumentTypeFormatType

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

Typed dictionaries

Type annotations for typed dictionaries used in methods and schema.

Usage example
from types_aiobotocore_comprehend.type_defs import AugmentedManifestsListItemTypeDef

def get_value() -> AugmentedManifestsListItemTypeDef:
    return {
        "S3Uri": ...,
        "AttributeNames": ...,
    }