Skip to content

KendraRanking module#

Index > KendraRanking

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

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.38.19' mypy-boto3-builder
  2. Select boto3-stubs AWS SDK.
  3. Add KendraRanking 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 KendraRanking.

From PyPI with pip#

Install boto3-stubs for KendraRanking service.

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

# 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-ranking]'

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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

KendraRankingClient#

Type annotations and code completion for boto3.client("kendra-ranking") as KendraRankingClient boto3 documentation

# KendraRankingClient usage example

from boto3.session import Session

from mypy_boto3_kendra_ranking.client import KendraRankingClient

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

Literals#

Type annotations for literals used in methods and schema.

# RescoreExecutionPlanStatusType usage example

from mypy_boto3_kendra_ranking.literals import RescoreExecutionPlanStatusType

def get_value() -> RescoreExecutionPlanStatusType:
    return "ACTIVE"

Type definitions#

Type annotations for type definitions used in methods and schema.