Skip to content

CloudSearchDomain module#

Index > CloudSearchDomain

Auto-generated documentation for CloudSearchDomain type annotations stubs module types-boto3-cloudsearchdomain.

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.35.86' mypy_boto3_builder
  2. Select boto3 AWS SDK.
  3. Add CloudSearchDomain 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 CloudSearchDomain.

From PyPI with pip#

Install types-boto3 for CloudSearchDomain service.

# install with boto3 type annotations
python -m pip install 'types-boto3[cloudsearchdomain]'

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

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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

CloudSearchDomainClient#

Type annotations and code completion for boto3.client("cloudsearchdomain") as CloudSearchDomainClient boto3 documentation

# CloudSearchDomainClient usage example

from boto3.session import Session

from types_boto3_cloudsearchdomain.client import CloudSearchDomainClient

def get_client() -> CloudSearchDomainClient:
    return Session().client("cloudsearchdomain")

Literals#

Type annotations for literals used in methods and schema.

# ContentTypeType usage example

from types_boto3_cloudsearchdomain.literals import ContentTypeType

def get_value() -> ContentTypeType:
    return "application/json"

Type definitions#

Type annotations for type definitions used in methods and schema.