Skip to content

CloudSearch module#

Index > CloudSearch

Auto-generated documentation for CloudSearch type annotations stubs module types-aiobotocore-cloudsearch.

How to install#

You can generate type annotations for aioboto3 package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'aioboto3==14.1.0' mypy-boto3-builder
  2. Select aioboto3 AWS SDK.
  3. Add CloudSearch service.
  4. Use provided commands to install generated packages.

From PyPI with pip#

Install types-aioboto3 for CloudSearch service.

# install with aioboto3 type annotations
python -m pip install 'types-aioboto3[cloudsearch]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aioboto3-lite[cloudsearch]'

# standalone installation
python -m pip install types-aiobotocore-cloudsearch

How to uninstall#

python -m pip uninstall -y types-aiobotocore-cloudsearch

Usage#

Code samples can be found in Examples.

CloudSearchClient#

Type annotations and code completion for session.client("cloudsearch") as CloudSearchClient boto3 documentation

# CloudSearchClient usage example

from aioboto3.session import Session

from types_aiobotocore_cloudsearch.client import CloudSearchClient


session = Session()
async with session.client("cloudsearch") as client:
    client: CloudSearchClient

Literals#

Type annotations for literals used in methods and schema.

# AlgorithmicStemmingType usage example

from types_aiobotocore_cloudsearch.literals import AlgorithmicStemmingType

def get_value() -> AlgorithmicStemmingType:
    return "full"

Type definitions#

Type annotations for type definitions used in methods and schema.