Skip to content

kendra module#

Index > kendra

Auto-generated documentation for kendra type annotations stubs module mypy-boto3-kendra.

How to install#

VSCode extension#

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

Click Modify and select boto3 common and kendra.

From PyPI with pip#

Install boto3-stubs for kendra service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[kendra]'


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


# standalone installation
python -m pip install mypy-boto3-kendra

How to uninstall#

python -m pip uninstall -y mypy-boto3-kendra

Usage#

Code samples can be found in Examples.

kendraClient#

Type annotations and code completion for boto3.client("kendra") as kendraClient boto3 documentation

# kendraClient usage example

from boto3.session import Session

from mypy_boto3_kendra.client import kendraClient

def get_client() -> kendraClient:
    return Session().client("kendra")

Literals#

Type annotations for literals used in methods and schemas.

# AdditionalResultAttributeValueTypeType usage example

from mypy_boto3_kendra.literals import AdditionalResultAttributeValueTypeType

def get_value() -> AdditionalResultAttributeValueTypeType:
    return "TEXT_WITH_HIGHLIGHTS_VALUE"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# AccessControlConfigurationSummaryTypeDef usage example

from mypy_boto3_kendra.type_defs import AccessControlConfigurationSummaryTypeDef

def get_value() -> AccessControlConfigurationSummaryTypeDef:
    return {
        "Id": ...,
    }