CloudSearchDomain module

Index > CloudSearchDomain

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

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

From PyPI with pip

Install boto3-stubs for CloudSearchDomain service.

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


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


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

How to uninstall

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

Usage

Code samples can be found in Examples.

CloudSearchDomainClient

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

Usage example

from boto3.session import Session

from mypy_boto3_cloudsearchdomain.client import CloudSearchDomainClient

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

Literals

Type annotations for literals used in methods and schemas.

Usage example

from mypy_boto3_cloudsearchdomain.literals import ContentTypeType

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

Typed dictionaries

Type annotations for typed dictionaries used in methods and schema.

Usage example

from mypy_boto3_cloudsearchdomain.type_defs import BucketTypeDef

def get_value() -> BucketTypeDef:
    return {
        "value": ...,
    }