Skip to content

CloudSearchDomainClient#

Index > CloudSearchDomain > CloudSearchDomainClient

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

CloudSearchDomainClient#

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

# CloudSearchDomainClient usage example

from boto3.session import Session
from types_boto3_cloudsearchdomain.client import CloudSearchDomainClient

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

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("cloudsearchdomain").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("cloudsearchdomain")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.DocumentServiceException,
    client.exceptions.SearchException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from types_boto3_cloudsearchdomain.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("cloudsearchdomain").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("cloudsearchdomain").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

Retrieves a list of documents that match the specified search criteria.

Type annotations and code completion for boto3.client("cloudsearchdomain").search method. boto3 documentation

# search method definition

def search(
    self,
    *,
    query: str,
    cursor: str = ...,
    expr: str = ...,
    facet: str = ...,
    filterQuery: str = ...,
    highlight: str = ...,
    partial: bool = ...,
    queryOptions: str = ...,
    queryParser: QueryParserType = ...,  # (1)
    returnFields: str = ...,
    size: int = ...,
    sort: str = ...,
    start: int = ...,
    stats: str = ...,
) -> SearchResponseTypeDef:  # (2)
    ...
  1. See QueryParserType
  2. See SearchResponseTypeDef
# search method usage example with argument unpacking

kwargs: SearchRequestTypeDef = {  # (1)
    "query": ...,
}

parent.search(**kwargs)
  1. See SearchRequestTypeDef

suggest#

Retrieves autocomplete suggestions for a partial query string.

Type annotations and code completion for boto3.client("cloudsearchdomain").suggest method. boto3 documentation

# suggest method definition

def suggest(
    self,
    *,
    query: str,
    suggester: str,
    size: int = ...,
) -> SuggestResponseTypeDef:  # (1)
    ...
  1. See SuggestResponseTypeDef
# suggest method usage example with argument unpacking

kwargs: SuggestRequestTypeDef = {  # (1)
    "query": ...,
    "suggester": ...,
}

parent.suggest(**kwargs)
  1. See SuggestRequestTypeDef

upload_documents#

Posts a batch of documents to a search domain for indexing.

Type annotations and code completion for boto3.client("cloudsearchdomain").upload_documents method. boto3 documentation

# upload_documents method definition

def upload_documents(
    self,
    *,
    documents: BlobTypeDef,
    contentType: ContentTypeType,  # (1)
) -> UploadDocumentsResponseTypeDef:  # (2)
    ...
  1. See ContentTypeType
  2. See UploadDocumentsResponseTypeDef
# upload_documents method usage example with argument unpacking

kwargs: UploadDocumentsRequestTypeDef = {  # (1)
    "documents": ...,
    "contentType": ...,
}

parent.upload_documents(**kwargs)
  1. See UploadDocumentsRequestTypeDef