CloudSearchDomainClient#
Index > CloudSearchDomain > CloudSearchDomainClient
Auto-generated documentation for CloudSearchDomain type annotations stubs module types-aiobotocore-cloudsearchdomain.
CloudSearchDomainClient#
Type annotations and code completion for session.create_client("cloudsearchdomain")
boto3 documentation
CloudSearchDomainClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_cloudsearchdomain.client import CloudSearchDomainClient
session = get_session()
async with session.create_client("cloudsearchdomain") as client:
client: CloudSearchDomainClient
Exceptions#
aiobotocore
client exceptions are generated in runtime.
This class provides code completion for session.create_client("cloudsearchdomain").exceptions
structure.
CloudSearchDomainClient.exceptions usage example
async with session.create_client("cloudsearchdomain") as client:
try:
do_something(client)
except (
client.ClientError,
client.DocumentServiceException,
client.SearchException,
) as e:
print(e)
CloudSearchDomainClient usage type checking example
from types_aiobotocore_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 session.create_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 session.create_client("cloudsearchdomain").close
method.
boto3 documentation
# close method definition
await def close(
self,
) -> None:
...
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.create_client("cloudsearchdomain").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
await 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 session.create_client("cloudsearchdomain").search
method.
boto3 documentation
# search method definition
await 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 session.create_client("cloudsearchdomain").suggest
method.
boto3 documentation
# suggest method definition
await 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 session.create_client("cloudsearchdomain").upload_documents
method.
boto3 documentation
# upload_documents method definition
await def upload_documents(
self,
*,
documents: Union[str, bytes, IO[Any], StreamingBody],
contentType: ContentTypeType, # (1)
) -> UploadDocumentsResponseTypeDef: # (2)
...
# upload_documents method usage example with argument unpacking
kwargs: UploadDocumentsRequestRequestTypeDef = { # (1)
"documents": ...,
"contentType": ...,
}
parent.upload_documents(**kwargs)
__aenter__#
Type annotations and code completion for session.create_client("cloudsearchdomain").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> CloudSearchDomainClient:
...
__aexit__#
Type annotations and code completion for session.create_client("cloudsearchdomain").__aexit__
method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...