Skip to content

CloudSearch module#

Index > CloudSearch

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

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

From PyPI with pip#

Install boto3-stubs for CloudSearch service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[cloudsearch]'

# 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[cloudsearch]'

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

How to uninstall#

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


Code samples can be found in Examples.


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

# CloudSearchClient usage example

from boto3.session import Session

from mypy_boto3_cloudsearch.client import CloudSearchClient

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


Type annotations for literals used in methods and schema.

# AlgorithmicStemmingType usage example

from mypy_boto3_cloudsearch.literals import AlgorithmicStemmingType

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

Type definitions#

Type annotations for type definitions used in methods and schema.