Skip to content

CloudSearch module#

Index > CloudSearch

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

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.36.26' mypy-boto3-builder
  2. Select boto3 AWS SDK.
  3. Add CloudSearch 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 CloudSearch.

From PyPI with pip#

Install types-boto3 for CloudSearch service.

# install with boto3 type annotations
python -m pip install 'types-boto3[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-boto3-lite[cloudsearch]'

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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

CloudSearchClient#

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

# CloudSearchClient usage example

from boto3.session import Session

from types_boto3_cloudsearch.client import CloudSearchClient

def get_client() -> CloudSearchClient:
    return Session().client("cloudsearch")

Literals#

Type annotations for literals used in methods and schema.

# AlgorithmicStemmingType usage example

from types_boto3_cloudsearch.literals import AlgorithmicStemmingType

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

Type definitions#

Type annotations for type definitions used in methods and schema.