KendraRanking module#
Index > KendraRanking
Auto-generated documentation for KendraRanking type annotations stubs module types-aiobotocore-kendra-ranking.
How to install#
Generate locally (recommended)#
You can generate type annotations for aiobotocore
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'aiobotocore==2.24.2' mypy-boto3-builder
- Select
aiobotocore
AWS SDK. - Add
KendraRanking
service. - Use provided commands to install generated packages.
From PyPI with pip#
Install types-aiobotocore
for KendraRanking
service.
# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[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 'types-aiobotocore-lite[kendra-ranking]'
# standalone installation
python -m pip install types-aiobotocore-kendra-ranking
How to uninstall#
python -m pip uninstall -y types-aiobotocore-kendra-ranking
Usage#
Code samples can be found in Examples.
KendraRankingClient#
Type annotations and code completion for session.create_client("kendra-ranking")
as KendraRankingClient
boto3 documentation
# KendraRankingClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_kendra_ranking.client import KendraRankingClient
session = get_session()
async with session.create_client("kendra-ranking") as client:
client: KendraRankingClient
Literals#
Type annotations for literals used in methods and schema.
# RescoreExecutionPlanStatusType usage example
from types_aiobotocore_kendra_ranking.literals import RescoreExecutionPlanStatusType
def get_value() -> RescoreExecutionPlanStatusType:
return "ACTIVE"
Type definitions#
Type annotations for type definitions used in methods and schema.
- CapacityUnitsConfigurationTypeDef
- TagTypeDef
- ResponseMetadataTypeDef
- DeleteRescoreExecutionPlanRequestTypeDef
- DescribeRescoreExecutionPlanRequestTypeDef
- DocumentTypeDef
- ListRescoreExecutionPlansRequestTypeDef
- RescoreExecutionPlanSummaryTypeDef
- ListTagsForResourceRequestTypeDef
- RescoreResultItemTypeDef
- UntagResourceRequestTypeDef
- UpdateRescoreExecutionPlanRequestTypeDef
- CreateRescoreExecutionPlanRequestTypeDef
- TagResourceRequestTypeDef
- CreateRescoreExecutionPlanResponseTypeDef
- DescribeRescoreExecutionPlanResponseTypeDef
- EmptyResponseMetadataTypeDef
- ListTagsForResourceResponseTypeDef
- RescoreRequestTypeDef
- ListRescoreExecutionPlansResponseTypeDef
- RescoreResultTypeDef