CloudSearchDomainClient#
Index > CloudSearchDomain > CloudSearchDomainClient
Auto-generated documentation for CloudSearchDomain type annotations stubs module mypy-boto3-cloudsearchdomain.
CloudSearchDomainClient#
Type annotations and code completion for boto3.client("cloudsearchdomain").
boto3 documentation
# CloudSearchDomainClient usage example
from boto3.session import Session
from mypy_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 mypy_boto3_cloudsearchdomain.client import Exceptions
def handle_error(exc: Exceptions.ClientError) -> None:
...Methods#
can_paginate#
Check if an operation can be paginated.
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:
...close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("cloudsearchdomain").close method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
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:
...search#
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)
...- See QueryParserType
- See SearchResponseTypeDef
# search method usage example with argument unpacking
kwargs: SearchRequestRequestTypeDef = { # (1)
"query": ...,
}
parent.search(**kwargs)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)
...# suggest method usage example with argument unpacking
kwargs: SuggestRequestRequestTypeDef = { # (1)
"query": ...,
"suggester": ...,
}
parent.suggest(**kwargs)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)
...# upload_documents method usage example with argument unpacking
kwargs: UploadDocumentsRequestRequestTypeDef = { # (1)
"documents": ...,
"contentType": ...,
}
parent.upload_documents(**kwargs)