define_suggester ¶

def define_suggester(
    self,
    domain_name: "capo_cloudsearch.types.domain_name.DomainName",
    suggester: "capo_cloudsearch.types.suggester.Suggester",
    *,
    config_overrides: Optional[CloudSearchClientConfig] = None,
) -> "capo_cloudsearch.types.define_suggester_response.DefineSuggesterResponse":
    """<p>Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html" target="_blank">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>

    Raises:
        capo_cloudsearch.errors.base_exception.BaseException: <p>An error occurred while processing the request.</p>
        capo_cloudsearch.errors.internal_exception.InternalException: <p>An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>.</p>
        capo_cloudsearch.errors.invalid_type_exception.InvalidTypeException: <p>The request was rejected because it specified an invalid type definition.</p>
        capo_cloudsearch.errors.limit_exceeded_exception.LimitExceededException: <p>The request was rejected because a resource limit has already been met.</p>
        capo_cloudsearch.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request was rejected because it attempted to reference a resource that does not exist.</p>
        capo_cloudsearch.errors.validation_exception.ValidationException: <p>The request was rejected because it has invalid parameters.</p>
        capo_cloudsearch.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cloudsearch.types.define_suggester_request.DefineSuggesterRequest]",
    ) -> OperationResponse[
        "capo_cloudsearch.types.define_suggester_response.DefineSuggesterResponse"
    ]:
        import capo_cloudsearch._operations.a9_search_cloud_config_service2013.define_suggester

        output, http_response = (
            capo_cloudsearch._operations.a9_search_cloud_config_service2013.define_suggester.define_suggester(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DefineSuggester")
    )
    input_: capo_cloudsearch.types.define_suggester_request.DefineSuggesterRequest = {
        "domain_name": domain_name,
        "suggester": suggester,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output