Skip to content

KendraRanking module

Index > KendraRanking

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

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 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 schemas.

# RescoreExecutionPlanStatusType usage example

from mypy_boto3_kendra_ranking.literals import RescoreExecutionPlanStatusType

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

Typed dictionaries

Type annotations for typed dictionaries used in methods and schema.

# CapacityUnitsConfigurationTypeDef usage example

from mypy_boto3_kendra_ranking.type_defs import CapacityUnitsConfigurationTypeDef

def get_value() -> CapacityUnitsConfigurationTypeDef:
    return {
        "RescoreCapacityUnits": ...,
    }