Skip to content

CloudSearchClient#

Index > CloudSearch > CloudSearchClient

Auto-generated documentation for CloudSearch type annotations stubs module mypy-boto3-cloudsearch.

CloudSearchClient#

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

# CloudSearchClient usage example

from boto3.session import Session
from mypy_boto3_cloudsearch.client import CloudSearchClient

def get_cloudsearch_client() -> CloudSearchClient:
    return Session().client("cloudsearch")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("cloudsearch")

try:
    do_something(client)
except (
    client.exceptions.BaseException,
    client.exceptions.ClientError,
    client.exceptions.DisabledOperationException,
    client.exceptions.InternalException,
    client.exceptions.InvalidTypeException,
    client.exceptions.LimitExceededException,
    client.exceptions.ResourceAlreadyExistsException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_cloudsearch.client import Exceptions

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

Methods#

build_suggesters#

Indexes the search suggestions.

Type annotations and code completion for boto3.client("cloudsearch").build_suggesters method. boto3 documentation

# build_suggesters method definition

def build_suggesters(
    self,
    *,
    DomainName: str,
) -> BuildSuggestersResponseTypeDef:  # (1)
    ...
  1. See BuildSuggestersResponseTypeDef 
# build_suggesters method usage example with argument unpacking

kwargs: BuildSuggestersRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.build_suggesters(**kwargs)
  1. See BuildSuggestersRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("cloudsearch").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("cloudsearch").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_domain#

Creates a new search domain.

Type annotations and code completion for boto3.client("cloudsearch").create_domain method. boto3 documentation

# create_domain method definition

def create_domain(
    self,
    *,
    DomainName: str,
) -> CreateDomainResponseTypeDef:  # (1)
    ...
  1. See CreateDomainResponseTypeDef 
# create_domain method usage example with argument unpacking

kwargs: CreateDomainRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.create_domain(**kwargs)
  1. See CreateDomainRequestRequestTypeDef

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 boto3.client("cloudsearch").define_analysis_scheme method. boto3 documentation

# define_analysis_scheme method definition

def define_analysis_scheme(
    self,
    *,
    DomainName: str,
    AnalysisScheme: AnalysisSchemeTypeDef,  # (1)
) -> DefineAnalysisSchemeResponseTypeDef:  # (2)
    ...
  1. See AnalysisSchemeTypeDef
  2. See DefineAnalysisSchemeResponseTypeDef 
# define_analysis_scheme method usage example with argument unpacking

kwargs: DefineAnalysisSchemeRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "AnalysisScheme": ...,
}

parent.define_analysis_scheme(**kwargs)
  1. See DefineAnalysisSchemeRequestRequestTypeDef

define_expression#

Configures an Expression for the search domain.

Type annotations and code completion for boto3.client("cloudsearch").define_expression method. boto3 documentation

# define_expression method definition

def define_expression(
    self,
    *,
    DomainName: str,
    Expression: ExpressionTypeDef,  # (1)
) -> DefineExpressionResponseTypeDef:  # (2)
    ...
  1. See ExpressionTypeDef
  2. See DefineExpressionResponseTypeDef 
# define_expression method usage example with argument unpacking

kwargs: DefineExpressionRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "Expression": ...,
}

parent.define_expression(**kwargs)
  1. See DefineExpressionRequestRequestTypeDef

define_index_field#

Configures an IndexField for the search domain.

Type annotations and code completion for boto3.client("cloudsearch").define_index_field method. boto3 documentation

# define_index_field method definition

def define_index_field(
    self,
    *,
    DomainName: str,
    IndexField: IndexFieldTypeDef,  # (1)
) -> DefineIndexFieldResponseTypeDef:  # (2)
    ...
  1. See IndexFieldTypeDef
  2. See DefineIndexFieldResponseTypeDef 
# define_index_field method usage example with argument unpacking

kwargs: DefineIndexFieldRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "IndexField": ...,
}

parent.define_index_field(**kwargs)
  1. See DefineIndexFieldRequestRequestTypeDef

define_suggester#

Configures a suggester for a domain.

Type annotations and code completion for boto3.client("cloudsearch").define_suggester method. boto3 documentation

# define_suggester method definition

def define_suggester(
    self,
    *,
    DomainName: str,
    Suggester: SuggesterTypeDef,  # (1)
) -> DefineSuggesterResponseTypeDef:  # (2)
    ...
  1. See SuggesterTypeDef
  2. See DefineSuggesterResponseTypeDef 
# define_suggester method usage example with argument unpacking

kwargs: DefineSuggesterRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "Suggester": ...,
}

parent.define_suggester(**kwargs)
  1. See DefineSuggesterRequestRequestTypeDef

delete_analysis_scheme#

Deletes an analysis scheme.

Type annotations and code completion for boto3.client("cloudsearch").delete_analysis_scheme method. boto3 documentation

# delete_analysis_scheme method definition

def delete_analysis_scheme(
    self,
    *,
    DomainName: str,
    AnalysisSchemeName: str,
) -> DeleteAnalysisSchemeResponseTypeDef:  # (1)
    ...
  1. See DeleteAnalysisSchemeResponseTypeDef 
# delete_analysis_scheme method usage example with argument unpacking

kwargs: DeleteAnalysisSchemeRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "AnalysisSchemeName": ...,
}

parent.delete_analysis_scheme(**kwargs)
  1. See DeleteAnalysisSchemeRequestRequestTypeDef

delete_domain#

Permanently deletes a search domain and all of its data.

Type annotations and code completion for boto3.client("cloudsearch").delete_domain method. boto3 documentation

# delete_domain method definition

def delete_domain(
    self,
    *,
    DomainName: str,
) -> DeleteDomainResponseTypeDef:  # (1)
    ...
  1. See DeleteDomainResponseTypeDef 
# delete_domain method usage example with argument unpacking

kwargs: DeleteDomainRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.delete_domain(**kwargs)
  1. See DeleteDomainRequestRequestTypeDef

delete_expression#

Removes an Expression from the search domain.

Type annotations and code completion for boto3.client("cloudsearch").delete_expression method. boto3 documentation

# delete_expression method definition

def delete_expression(
    self,
    *,
    DomainName: str,
    ExpressionName: str,
) -> DeleteExpressionResponseTypeDef:  # (1)
    ...
  1. See DeleteExpressionResponseTypeDef 
# delete_expression method usage example with argument unpacking

kwargs: DeleteExpressionRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "ExpressionName": ...,
}

parent.delete_expression(**kwargs)
  1. See DeleteExpressionRequestRequestTypeDef

delete_index_field#

Removes an IndexField from the search domain.

Type annotations and code completion for boto3.client("cloudsearch").delete_index_field method. boto3 documentation

# delete_index_field method definition

def delete_index_field(
    self,
    *,
    DomainName: str,
    IndexFieldName: str,
) -> DeleteIndexFieldResponseTypeDef:  # (1)
    ...
  1. See DeleteIndexFieldResponseTypeDef 
# delete_index_field method usage example with argument unpacking

kwargs: DeleteIndexFieldRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "IndexFieldName": ...,
}

parent.delete_index_field(**kwargs)
  1. See DeleteIndexFieldRequestRequestTypeDef

delete_suggester#

Deletes a suggester.

Type annotations and code completion for boto3.client("cloudsearch").delete_suggester method. boto3 documentation

# delete_suggester method definition

def delete_suggester(
    self,
    *,
    DomainName: str,
    SuggesterName: str,
) -> DeleteSuggesterResponseTypeDef:  # (1)
    ...
  1. See DeleteSuggesterResponseTypeDef 
# delete_suggester method usage example with argument unpacking

kwargs: DeleteSuggesterRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "SuggesterName": ...,
}

parent.delete_suggester(**kwargs)
  1. See DeleteSuggesterRequestRequestTypeDef

describe_analysis_schemes#

Gets the analysis schemes configured for a domain.

Type annotations and code completion for boto3.client("cloudsearch").describe_analysis_schemes method. boto3 documentation

# describe_analysis_schemes method definition

def describe_analysis_schemes(
    self,
    *,
    DomainName: str,
    AnalysisSchemeNames: Sequence[str] = ...,
    Deployed: bool = ...,
) -> DescribeAnalysisSchemesResponseTypeDef:  # (1)
    ...
  1. See DescribeAnalysisSchemesResponseTypeDef 
# describe_analysis_schemes method usage example with argument unpacking

kwargs: DescribeAnalysisSchemesRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.describe_analysis_schemes(**kwargs)
  1. See DescribeAnalysisSchemesRequestRequestTypeDef

describe_availability_options#

Gets the availability options configured for a domain.

Type annotations and code completion for boto3.client("cloudsearch").describe_availability_options method. boto3 documentation

# describe_availability_options method definition

def describe_availability_options(
    self,
    *,
    DomainName: str,
    Deployed: bool = ...,
) -> DescribeAvailabilityOptionsResponseTypeDef:  # (1)
    ...
  1. See DescribeAvailabilityOptionsResponseTypeDef 
# describe_availability_options method usage example with argument unpacking

kwargs: DescribeAvailabilityOptionsRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.describe_availability_options(**kwargs)
  1. See DescribeAvailabilityOptionsRequestRequestTypeDef

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 boto3.client("cloudsearch").describe_domain_endpoint_options method. boto3 documentation

# describe_domain_endpoint_options method definition

def describe_domain_endpoint_options(
    self,
    *,
    DomainName: str,
    Deployed: bool = ...,
) -> DescribeDomainEndpointOptionsResponseTypeDef:  # (1)
    ...
  1. See DescribeDomainEndpointOptionsResponseTypeDef 
# describe_domain_endpoint_options method usage example with argument unpacking

kwargs: DescribeDomainEndpointOptionsRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.describe_domain_endpoint_options(**kwargs)
  1. See DescribeDomainEndpointOptionsRequestRequestTypeDef

describe_domains#

Gets information about the search domains owned by this account.

Type annotations and code completion for boto3.client("cloudsearch").describe_domains method. boto3 documentation

# describe_domains method definition

def describe_domains(
    self,
    *,
    DomainNames: Sequence[str] = ...,
) -> DescribeDomainsResponseTypeDef:  # (1)
    ...
  1. See DescribeDomainsResponseTypeDef 
# describe_domains method usage example with argument unpacking

kwargs: DescribeDomainsRequestRequestTypeDef = {  # (1)
    "DomainNames": ...,
}

parent.describe_domains(**kwargs)
  1. See DescribeDomainsRequestRequestTypeDef

describe_expressions#

Gets the expressions configured for the search domain.

Type annotations and code completion for boto3.client("cloudsearch").describe_expressions method. boto3 documentation

# describe_expressions method definition

def describe_expressions(
    self,
    *,
    DomainName: str,
    ExpressionNames: Sequence[str] = ...,
    Deployed: bool = ...,
) -> DescribeExpressionsResponseTypeDef:  # (1)
    ...
  1. See DescribeExpressionsResponseTypeDef 
# describe_expressions method usage example with argument unpacking

kwargs: DescribeExpressionsRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.describe_expressions(**kwargs)
  1. See DescribeExpressionsRequestRequestTypeDef

describe_index_fields#

Gets information about the index fields configured for the search domain.

Type annotations and code completion for boto3.client("cloudsearch").describe_index_fields method. boto3 documentation

# describe_index_fields method definition

def describe_index_fields(
    self,
    *,
    DomainName: str,
    FieldNames: Sequence[str] = ...,
    Deployed: bool = ...,
) -> DescribeIndexFieldsResponseTypeDef:  # (1)
    ...
  1. See DescribeIndexFieldsResponseTypeDef 
# describe_index_fields method usage example with argument unpacking

kwargs: DescribeIndexFieldsRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.describe_index_fields(**kwargs)
  1. See DescribeIndexFieldsRequestRequestTypeDef

describe_scaling_parameters#

Gets the scaling parameters configured for a domain.

Type annotations and code completion for boto3.client("cloudsearch").describe_scaling_parameters method. boto3 documentation

# describe_scaling_parameters method definition

def describe_scaling_parameters(
    self,
    *,
    DomainName: str,
) -> DescribeScalingParametersResponseTypeDef:  # (1)
    ...
  1. See DescribeScalingParametersResponseTypeDef 
# describe_scaling_parameters method usage example with argument unpacking

kwargs: DescribeScalingParametersRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.describe_scaling_parameters(**kwargs)
  1. See DescribeScalingParametersRequestRequestTypeDef

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 boto3.client("cloudsearch").describe_service_access_policies method. boto3 documentation

# describe_service_access_policies method definition

def describe_service_access_policies(
    self,
    *,
    DomainName: str,
    Deployed: bool = ...,
) -> DescribeServiceAccessPoliciesResponseTypeDef:  # (1)
    ...
  1. See DescribeServiceAccessPoliciesResponseTypeDef 
# describe_service_access_policies method usage example with argument unpacking

kwargs: DescribeServiceAccessPoliciesRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.describe_service_access_policies(**kwargs)
  1. See DescribeServiceAccessPoliciesRequestRequestTypeDef

describe_suggesters#

Gets the suggesters configured for a domain.

Type annotations and code completion for boto3.client("cloudsearch").describe_suggesters method. boto3 documentation

# describe_suggesters method definition

def describe_suggesters(
    self,
    *,
    DomainName: str,
    SuggesterNames: Sequence[str] = ...,
    Deployed: bool = ...,
) -> DescribeSuggestersResponseTypeDef:  # (1)
    ...
  1. See DescribeSuggestersResponseTypeDef 
# describe_suggesters method usage example with argument unpacking

kwargs: DescribeSuggestersRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.describe_suggesters(**kwargs)
  1. See DescribeSuggestersRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("cloudsearch").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:
    ...

index_documents#

Tells the search domain to start indexing its documents using the latest indexing options.

Type annotations and code completion for boto3.client("cloudsearch").index_documents method. boto3 documentation

# index_documents method definition

def index_documents(
    self,
    *,
    DomainName: str,
) -> IndexDocumentsResponseTypeDef:  # (1)
    ...
  1. See IndexDocumentsResponseTypeDef 
# index_documents method usage example with argument unpacking

kwargs: IndexDocumentsRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.index_documents(**kwargs)
  1. See IndexDocumentsRequestRequestTypeDef

list_domain_names#

Lists all search domains owned by an account.

Type annotations and code completion for boto3.client("cloudsearch").list_domain_names method. boto3 documentation

# list_domain_names method definition

def list_domain_names(
    self,
) -> ListDomainNamesResponseTypeDef:  # (1)
    ...
  1. See ListDomainNamesResponseTypeDef

update_availability_options#

Configures the availability options for a domain.

Type annotations and code completion for boto3.client("cloudsearch").update_availability_options method. boto3 documentation

# update_availability_options method definition

def update_availability_options(
    self,
    *,
    DomainName: str,
    MultiAZ: bool,
) -> UpdateAvailabilityOptionsResponseTypeDef:  # (1)
    ...
  1. See UpdateAvailabilityOptionsResponseTypeDef 
# update_availability_options method usage example with argument unpacking

kwargs: UpdateAvailabilityOptionsRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "MultiAZ": ...,
}

parent.update_availability_options(**kwargs)
  1. See UpdateAvailabilityOptionsRequestRequestTypeDef

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 boto3.client("cloudsearch").update_domain_endpoint_options method. boto3 documentation

# update_domain_endpoint_options method definition

def update_domain_endpoint_options(
    self,
    *,
    DomainName: str,
    DomainEndpointOptions: DomainEndpointOptionsTypeDef,  # (1)
) -> UpdateDomainEndpointOptionsResponseTypeDef:  # (2)
    ...
  1. See DomainEndpointOptionsTypeDef
  2. See UpdateDomainEndpointOptionsResponseTypeDef 
# update_domain_endpoint_options method usage example with argument unpacking

kwargs: UpdateDomainEndpointOptionsRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "DomainEndpointOptions": ...,
}

parent.update_domain_endpoint_options(**kwargs)
  1. See UpdateDomainEndpointOptionsRequestRequestTypeDef

update_scaling_parameters#

Configures scaling parameters for a domain.

Type annotations and code completion for boto3.client("cloudsearch").update_scaling_parameters method. boto3 documentation

# update_scaling_parameters method definition

def update_scaling_parameters(
    self,
    *,
    DomainName: str,
    ScalingParameters: ScalingParametersTypeDef,  # (1)
) -> UpdateScalingParametersResponseTypeDef:  # (2)
    ...
  1. See ScalingParametersTypeDef
  2. See UpdateScalingParametersResponseTypeDef 
# update_scaling_parameters method usage example with argument unpacking

kwargs: UpdateScalingParametersRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "ScalingParameters": ...,
}

parent.update_scaling_parameters(**kwargs)
  1. See UpdateScalingParametersRequestRequestTypeDef

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 boto3.client("cloudsearch").update_service_access_policies method. boto3 documentation

# update_service_access_policies method definition

def update_service_access_policies(
    self,
    *,
    DomainName: str,
    AccessPolicies: str,
) -> UpdateServiceAccessPoliciesResponseTypeDef:  # (1)
    ...
  1. See UpdateServiceAccessPoliciesResponseTypeDef 
# update_service_access_policies method usage example with argument unpacking

kwargs: UpdateServiceAccessPoliciesRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "AccessPolicies": ...,
}

parent.update_service_access_policies(**kwargs)
  1. See UpdateServiceAccessPoliciesRequestRequestTypeDef