CloudSearchClient
Index > CloudSearch > CloudSearchClient
Auto-generated documentation for CloudSearch type annotations stubs module types-aiobotocore-cloudsearch.
CloudSearchClient
Type annotations and code completion for session.client("cloudsearch")
boto3 documentation
from aioboto3.session import Session
from types_aiobotocore_cloudsearch.client import CloudSearchClient
session = Session()
async with session.client("cloudsearch") as client:
client: CloudSearchClient
Exceptions
aioboto3
client exceptions are generated in runtime.
This class provides code completion for session.client("cloudsearch").exceptions
structure.
async with session.client("cloudsearch") as client:
try:
do_something(client)
except (
client.BaseException,
client.ClientError,
client.DisabledOperationException,
client.InternalException,
client.InvalidTypeException,
client.LimitExceededException,
client.ResourceAlreadyExistsException,
client.ResourceNotFoundException,
client.ValidationException,
) as e:
print(e)
from types_aiobotocore_cloudsearch.client import Exceptions
def handle_error(exc: Exceptions.BaseException) -> None:
...
Methods
build_suggesters
Indexes the search suggestions.
Type annotations and code completion for session.client("cloudsearch").build_suggesters
method.
boto3 documentation
await def build_suggesters(
self,
*,
DomainName: str,
) -> BuildSuggestersResponseTypeDef: # (1)
...
kwargs: BuildSuggestersRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.build_suggesters(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for session.client("cloudsearch").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for session.client("cloudsearch").close
method.
boto3 documentation
create_domain
Creates a new search domain.
Type annotations and code completion for session.client("cloudsearch").create_domain
method.
boto3 documentation
await def create_domain(
self,
*,
DomainName: str,
) -> CreateDomainResponseTypeDef: # (1)
...
kwargs: CreateDomainRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.create_domain(**kwargs)
define_analysis_scheme
Configures an analysis scheme that can be applied to a text
or text-array
field to define language-specific text processing options.
Type annotations and code completion for session.client("cloudsearch").define_analysis_scheme
method.
boto3 documentation
await def define_analysis_scheme(
self,
*,
DomainName: str,
AnalysisScheme: AnalysisSchemeTypeDef, # (1)
) -> DefineAnalysisSchemeResponseTypeDef: # (2)
...
kwargs: DefineAnalysisSchemeRequestRequestTypeDef = { # (1)
"DomainName": ...,
"AnalysisScheme": ...,
}
parent.define_analysis_scheme(**kwargs)
define_expression
Configures an Expression
for the search domain.
Type annotations and code completion for session.client("cloudsearch").define_expression
method.
boto3 documentation
await def define_expression(
self,
*,
DomainName: str,
Expression: ExpressionTypeDef, # (1)
) -> DefineExpressionResponseTypeDef: # (2)
...
kwargs: DefineExpressionRequestRequestTypeDef = { # (1)
"DomainName": ...,
"Expression": ...,
}
parent.define_expression(**kwargs)
define_index_field
Configures an IndexField
for the search domain.
Type annotations and code completion for session.client("cloudsearch").define_index_field
method.
boto3 documentation
await def define_index_field(
self,
*,
DomainName: str,
IndexField: IndexFieldTypeDef, # (1)
) -> DefineIndexFieldResponseTypeDef: # (2)
...
kwargs: DefineIndexFieldRequestRequestTypeDef = { # (1)
"DomainName": ...,
"IndexField": ...,
}
parent.define_index_field(**kwargs)
define_suggester
Configures a suggester for a domain.
Type annotations and code completion for session.client("cloudsearch").define_suggester
method.
boto3 documentation
await def define_suggester(
self,
*,
DomainName: str,
Suggester: SuggesterTypeDef, # (1)
) -> DefineSuggesterResponseTypeDef: # (2)
...
kwargs: DefineSuggesterRequestRequestTypeDef = { # (1)
"DomainName": ...,
"Suggester": ...,
}
parent.define_suggester(**kwargs)
delete_analysis_scheme
Deletes an analysis scheme.
Type annotations and code completion for session.client("cloudsearch").delete_analysis_scheme
method.
boto3 documentation
await def delete_analysis_scheme(
self,
*,
DomainName: str,
AnalysisSchemeName: str,
) -> DeleteAnalysisSchemeResponseTypeDef: # (1)
...
kwargs: DeleteAnalysisSchemeRequestRequestTypeDef = { # (1)
"DomainName": ...,
"AnalysisSchemeName": ...,
}
parent.delete_analysis_scheme(**kwargs)
delete_domain
Permanently deletes a search domain and all of its data.
Type annotations and code completion for session.client("cloudsearch").delete_domain
method.
boto3 documentation
await def delete_domain(
self,
*,
DomainName: str,
) -> DeleteDomainResponseTypeDef: # (1)
...
kwargs: DeleteDomainRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.delete_domain(**kwargs)
delete_expression
Removes an Expression
from the search domain.
Type annotations and code completion for session.client("cloudsearch").delete_expression
method.
boto3 documentation
await def delete_expression(
self,
*,
DomainName: str,
ExpressionName: str,
) -> DeleteExpressionResponseTypeDef: # (1)
...
kwargs: DeleteExpressionRequestRequestTypeDef = { # (1)
"DomainName": ...,
"ExpressionName": ...,
}
parent.delete_expression(**kwargs)
delete_index_field
Removes an IndexField
from the search domain.
Type annotations and code completion for session.client("cloudsearch").delete_index_field
method.
boto3 documentation
await def delete_index_field(
self,
*,
DomainName: str,
IndexFieldName: str,
) -> DeleteIndexFieldResponseTypeDef: # (1)
...
kwargs: DeleteIndexFieldRequestRequestTypeDef = { # (1)
"DomainName": ...,
"IndexFieldName": ...,
}
parent.delete_index_field(**kwargs)
delete_suggester
Deletes a suggester.
Type annotations and code completion for session.client("cloudsearch").delete_suggester
method.
boto3 documentation
await def delete_suggester(
self,
*,
DomainName: str,
SuggesterName: str,
) -> DeleteSuggesterResponseTypeDef: # (1)
...
kwargs: DeleteSuggesterRequestRequestTypeDef = { # (1)
"DomainName": ...,
"SuggesterName": ...,
}
parent.delete_suggester(**kwargs)
describe_analysis_schemes
Gets the analysis schemes configured for a domain.
Type annotations and code completion for session.client("cloudsearch").describe_analysis_schemes
method.
boto3 documentation
await def describe_analysis_schemes(
self,
*,
DomainName: str,
AnalysisSchemeNames: Sequence[str] = ...,
Deployed: bool = ...,
) -> DescribeAnalysisSchemesResponseTypeDef: # (1)
...
kwargs: DescribeAnalysisSchemesRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.describe_analysis_schemes(**kwargs)
describe_availability_options
Gets the availability options configured for a domain.
Type annotations and code completion for session.client("cloudsearch").describe_availability_options
method.
boto3 documentation
await def describe_availability_options(
self,
*,
DomainName: str,
Deployed: bool = ...,
) -> DescribeAvailabilityOptionsResponseTypeDef: # (1)
...
kwargs: DescribeAvailabilityOptionsRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.describe_availability_options(**kwargs)
describe_domain_endpoint_options
Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS.
Type annotations and code completion for session.client("cloudsearch").describe_domain_endpoint_options
method.
boto3 documentation
await def describe_domain_endpoint_options(
self,
*,
DomainName: str,
Deployed: bool = ...,
) -> DescribeDomainEndpointOptionsResponseTypeDef: # (1)
...
kwargs: DescribeDomainEndpointOptionsRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.describe_domain_endpoint_options(**kwargs)
describe_domains
Gets information about the search domains owned by this account.
Type annotations and code completion for session.client("cloudsearch").describe_domains
method.
boto3 documentation
await def describe_domains(
self,
*,
DomainNames: Sequence[str] = ...,
) -> DescribeDomainsResponseTypeDef: # (1)
...
kwargs: DescribeDomainsRequestRequestTypeDef = { # (1)
"DomainNames": ...,
}
parent.describe_domains(**kwargs)
describe_expressions
Gets the expressions configured for the search domain.
Type annotations and code completion for session.client("cloudsearch").describe_expressions
method.
boto3 documentation
await def describe_expressions(
self,
*,
DomainName: str,
ExpressionNames: Sequence[str] = ...,
Deployed: bool = ...,
) -> DescribeExpressionsResponseTypeDef: # (1)
...
kwargs: DescribeExpressionsRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.describe_expressions(**kwargs)
describe_index_fields
Gets information about the index fields configured for the search domain.
Type annotations and code completion for session.client("cloudsearch").describe_index_fields
method.
boto3 documentation
await def describe_index_fields(
self,
*,
DomainName: str,
FieldNames: Sequence[str] = ...,
Deployed: bool = ...,
) -> DescribeIndexFieldsResponseTypeDef: # (1)
...
kwargs: DescribeIndexFieldsRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.describe_index_fields(**kwargs)
describe_scaling_parameters
Gets the scaling parameters configured for a domain.
Type annotations and code completion for session.client("cloudsearch").describe_scaling_parameters
method.
boto3 documentation
await def describe_scaling_parameters(
self,
*,
DomainName: str,
) -> DescribeScalingParametersResponseTypeDef: # (1)
...
kwargs: DescribeScalingParametersRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.describe_scaling_parameters(**kwargs)
describe_service_access_policies
Gets information about the access policies that control access to the domain's document and search endpoints.
Type annotations and code completion for session.client("cloudsearch").describe_service_access_policies
method.
boto3 documentation
await def describe_service_access_policies(
self,
*,
DomainName: str,
Deployed: bool = ...,
) -> DescribeServiceAccessPoliciesResponseTypeDef: # (1)
...
kwargs: DescribeServiceAccessPoliciesRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.describe_service_access_policies(**kwargs)
describe_suggesters
Gets the suggesters configured for a domain.
Type annotations and code completion for session.client("cloudsearch").describe_suggesters
method.
boto3 documentation
await def describe_suggesters(
self,
*,
DomainName: str,
SuggesterNames: Sequence[str] = ...,
Deployed: bool = ...,
) -> DescribeSuggestersResponseTypeDef: # (1)
...
kwargs: DescribeSuggestersRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.describe_suggesters(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.client("cloudsearch").generate_presigned_url
method.
boto3 documentation
await def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
index_documents
Tells the search domain to start indexing its documents using the latest indexing options.
Type annotations and code completion for session.client("cloudsearch").index_documents
method.
boto3 documentation
await def index_documents(
self,
*,
DomainName: str,
) -> IndexDocumentsResponseTypeDef: # (1)
...
kwargs: IndexDocumentsRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.index_documents(**kwargs)
list_domain_names
Lists all search domains owned by an account.
Type annotations and code completion for session.client("cloudsearch").list_domain_names
method.
boto3 documentation
update_availability_options
Configures the availability options for a domain.
Type annotations and code completion for session.client("cloudsearch").update_availability_options
method.
boto3 documentation
await def update_availability_options(
self,
*,
DomainName: str,
MultiAZ: bool,
) -> UpdateAvailabilityOptionsResponseTypeDef: # (1)
...
kwargs: UpdateAvailabilityOptionsRequestRequestTypeDef = { # (1)
"DomainName": ...,
"MultiAZ": ...,
}
parent.update_availability_options(**kwargs)
update_domain_endpoint_options
Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS.
Type annotations and code completion for session.client("cloudsearch").update_domain_endpoint_options
method.
boto3 documentation
await def update_domain_endpoint_options(
self,
*,
DomainName: str,
DomainEndpointOptions: DomainEndpointOptionsTypeDef, # (1)
) -> UpdateDomainEndpointOptionsResponseTypeDef: # (2)
...
kwargs: UpdateDomainEndpointOptionsRequestRequestTypeDef = { # (1)
"DomainName": ...,
"DomainEndpointOptions": ...,
}
parent.update_domain_endpoint_options(**kwargs)
update_scaling_parameters
Configures scaling parameters for a domain.
Type annotations and code completion for session.client("cloudsearch").update_scaling_parameters
method.
boto3 documentation
await def update_scaling_parameters(
self,
*,
DomainName: str,
ScalingParameters: ScalingParametersTypeDef, # (1)
) -> UpdateScalingParametersResponseTypeDef: # (2)
...
kwargs: UpdateScalingParametersRequestRequestTypeDef = { # (1)
"DomainName": ...,
"ScalingParameters": ...,
}
parent.update_scaling_parameters(**kwargs)
update_service_access_policies
Configures the access rules that control access to the domain's document and search endpoints.
Type annotations and code completion for session.client("cloudsearch").update_service_access_policies
method.
boto3 documentation
await def update_service_access_policies(
self,
*,
DomainName: str,
AccessPolicies: str,
) -> UpdateServiceAccessPoliciesResponseTypeDef: # (1)
...
kwargs: UpdateServiceAccessPoliciesRequestRequestTypeDef = { # (1)
"DomainName": ...,
"AccessPolicies": ...,
}
parent.update_service_access_policies(**kwargs)
__aenter__
Type annotations and code completion for session.client("cloudsearch").__aenter__
method.
boto3 documentation
__aexit__
Type annotations and code completion for session.client("cloudsearch").__aexit__
method.
boto3 documentation