Skip to content

Kendra module#

Index > Kendra

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

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.36.2' mypy_boto3_builder
  2. Select boto3-stubs AWS SDK.
  3. Add Kendra 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 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 schema.

# AdditionalResultAttributeValueTypeType usage example

from mypy_boto3_kendra.literals import AdditionalResultAttributeValueTypeType

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