mypy-boto3-kendra

Warnings

• breaking Python 3.8 is no longer supported. `mypy-boto3-builder` version 8.12.0 and subsequent versions (which generate `mypy-boto3-kendra` 1.42.3) removed Python 3.8 support.
  Fix: Upgrade your Python environment to 3.9 or higher. For Python 3.8, use an older version of `mypy-boto3-kendra` if available, though this is not recommended due to security and feature updates.
• breaking TypeDefs for packed method arguments now use shorter names, and conflicting TypeDef `Extra` postfixes have moved. This is a breaking change for code that explicitly references generated `TypeDef` classes by their full names.
  Fix: Review your code for direct imports and usage of `mypy_boto3_kendra.type_defs` and adjust the `TypeDef` names according to the new naming conventions (e.g., `CreateDistributionRequestRequestTypeDef` might become `CreateDistributionRequestTypeDef`).
• gotcha The `mypy-boto3-kendra` package provides only type stubs. You still need `boto3` installed at runtime to execute your code. This package enables type checking for `boto3` calls, not the `boto3` functionality itself.
  Fix: Always install `boto3` alongside `mypy-boto3-kendra` (e.g., `pip install boto3 mypy-boto3-kendra`).
• gotcha Since `mypy-boto3` migrated to PEP 561, the generated packages are now proper stub packages. While generally an improvement, if you had a complex custom setup around older non-PEP 561 compliant versions or were relying on specific internal structures, it might require minor adjustments to your build or type-checking configuration.
  Fix: Verify that your type checker (e.g., MyPy) correctly identifies and uses the `py.typed` marker files in the installed `mypy-boto3-kendra` package. No specific code change is typically needed, but be aware of potential environment or configuration impacts.

Install

• pip install mypy-boto3-kendra boto3 Install library and boto3

Imports

• KendraClient

  from mypy_boto3_kendra.client import KendraClient

• ListIndicesOutputTypeDef

  from mypy_boto3_kendra.type_defs import ListIndicesOutputTypeDef

• KendraServiceName

  from mypy_boto3_kendra import KendraServiceName

  Useful for explicit type annotations or passing service names.

Quickstart

This quickstart demonstrates how to use `mypy-boto3-kendra` with `boto3` to get type-checked interactions with the AWS Kendra service. It initializes a Kendra client and lists available indices, leveraging the `KendraClient` and `ListIndicesOutputTypeDef` type hints for static analysis.

import boto3
from mypy_boto3_kendra.client import KendraClient
from mypy_boto3_kendra.type_defs import IndexConfigurationSummaryTypeDef, ListIndicesOutputTypeDef
from typing import List
import os

def list_kendra_indices() -> List[IndexConfigurationSummaryTypeDef]:
    """Lists Kendra indices and returns their summaries."""
    # Ensure AWS credentials are configured (e.g., via environment variables or ~/.aws/credentials)
    # For explicit credential provision (if not using implicit chain):
    # client: KendraClient = boto3.client(
    #     "kendra",
    #     aws_access_key_id=os.environ.get('AWS_ACCESS_KEY_ID', ''),
    #     aws_secret_access_key=os.environ.get('AWS_SECRET_ACCESS_KEY', ''),
    #     region_name=os.environ.get('AWS_REGION', 'us-east-1')
    # )
    
    client: KendraClient = boto3.client("kendra")
    
    # Using type hints for the response
    response: ListIndicesOutputTypeDef = client.list_indices()
    
    indices: List[IndexConfigurationSummaryTypeDef] = response.get('IndexConfigurationSummaryItems', [])
    if indices:
        print(f"Found Kendra indices: {[i['Name'] for i in indices]}")
    else:
        print("No Kendra indices found.")
    
    return indices

if __name__ == "__main__":
    list_kendra_indices()