search_place_index_for_suggestions ¶

def search_place_index_for_suggestions(
    self,
    index_name: "capo_location.types.resource_name.ResourceName",
    text: "capo_location.types.sensitive_string.SensitiveString",
    *,
    config_overrides: Optional[LocationClientConfig] = None,
    bias_position: Optional["capo_location.types.position.Position"] = None,
    filter_b_box: Optional["capo_location.types.bounding_box.BoundingBox"] = None,
    filter_countries: Optional[
        "capo_location.types.country_code_list.CountryCodeList"
    ] = None,
    max_results: Optional[int] = None,
    language: Optional["capo_location.types.language_tag.LanguageTag"] = None,
    filter_categories: Optional[
        "capo_location.types.filter_place_category_list.FilterPlaceCategoryList"
    ] = None,
    key: Optional["capo_location.types.api_key.ApiKey"] = None,
) -> "capo_location.types.search_place_index_for_suggestions_response.SearchPlaceIndexForSuggestionsResponse":
    """<important> <p>This operation is no longer current and may be deprecated in the future. We recommend you upgrade to <a href="/location/latest/APIReference/API_geoplaces_Suggest.html"> <code>Suggest</code> </a> or <a href="/location/latest/APIReference/API_geoplaces_Autocomplete.html"> <code>Autocomplete</code> </a> unless you require Grab data.</p> <ul> <li> <p> <code>SearchPlaceIndexForSuggestions</code> is part of a previous Amazon Location Service Places API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2).</p> </li> <li> <p>The version 2 <code>Suggest</code> operation gives better results for typeahead place search suggestions with fuzzy matching, while the version 2 <code>Autocomplete</code> operation gives better results for address completion based on partial input.</p> </li> <li> <p>If you are using an Amazon Web Services SDK or the Amazon Web Services CLI, note that the Places API version 2 is found under <code>geo-places</code> or <code>geo_places</code>, not under <code>location</code>.</p> </li> <li> <p>Since Grab is not yet fully supported in Places API version 2, we recommend you continue using API version 1 when using Grab.</p> </li> </ul> </important> <p>Generates suggestions for addresses and points of interest based on partial or misspelled free-form text. This operation is also known as autocomplete, autosuggest, or fuzzy matching.</p> <p>Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe.</p> <note> <p>You can search for suggested place names near a specified position by using <code>BiasPosition</code>, or filter results within a bounding box by using <code>FilterBBox</code>. These parameters are mutually exclusive; using both <code>BiasPosition</code> and <code>FilterBBox</code> in the same command returns an error.</p> </note>

    Args:
        index_name: <p>The name of the place index resource you want to use for the search.</p>
        text: <p>The free-form partial text to use to generate place suggestions. For example, <code>eiffel tow</code>.</p>
        bias_position: <p>An optional parameter that indicates a preference for place suggestions that are closer to a specified position.</p> <p> If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.</p> <p>For example, <code>[-123.1174, 49.2847]</code> represents the position with longitude <code>-123.1174</code> and latitude <code>49.2847</code>.</p> <note> <p> <code>BiasPosition</code> and <code>FilterBBox</code> are mutually exclusive. Specifying both options results in an error. </p> </note>
        filter_b_box: <p>An optional parameter that limits the search results by returning only suggestions within a specified bounding box.</p> <p> If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.</p> <p>For example, <code>[-12.7935, -37.4835, -12.0684, -36.9542]</code> represents a bounding box where the southwest corner has longitude <code>-12.7935</code> and latitude <code>-37.4835</code>, and the northeast corner has longitude <code>-12.0684</code> and latitude <code>-36.9542</code>.</p> <note> <p> <code>FilterBBox</code> and <code>BiasPosition</code> are mutually exclusive. Specifying both options results in an error. </p> </note>
        filter_countries: <p>An optional parameter that limits the search results by returning only suggestions within the provided list of countries.</p> <ul> <li> <p>Use the <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166</a> 3-digit country code. For example, Australia uses three upper-case characters: <code>AUS</code>.</p> </li> </ul>
        max_results: <p>An optional parameter. The maximum number of results returned per request. </p> <p>The default: <code>5</code> </p>
        language: <p>The preferred language used to return results. The value must be a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a> language tag, for example, <code>en</code> for English.</p> <p>This setting affects the languages used in the results. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.</p> <p>For an example, we'll use the Greek language. You search for <code>Athens, Gr</code> to get suggestions with the <code>language</code> parameter set to <code>en</code>. The results found will most likely be returned as <code>Athens, Greece</code>.</p> <p>If you set the <code>language</code> parameter to <code>el</code>, for Greek, then the result found will more likely be returned as <code>Αθήνα, Ελλάδα</code>.</p> <p>If the data provider does not have a value for Greek, the result will be in a language that the provider does support.</p>
        filter_categories: <p>A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match <i>any</i> of the categories listed.</p> <p>For more information about using categories, including a list of Amazon Location categories, see <a href="https://docs.aws.amazon.com/location/previous/developerguide/category-filtering.html">Categories and filtering</a>, in the <i>Amazon Location Service developer guide</i>.</p>
        key: <p>The optional <a href="https://docs.aws.amazon.com/location/previous/developerguide/using-apikeys.html">API key</a> to authorize the request.</p>

    Raises:
        capo_location.errors.access_denied_exception.AccessDeniedException: <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
        capo_location.errors.internal_server_exception.InternalServerException: <p>The request has failed to process because of an unknown server error, exception, or failure.</p>
        capo_location.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource that you've entered was not found in your AWS account.</p>
        capo_location.errors.throttling_exception.ThrottlingException: <p>The request was denied because of request throttling.</p>
        capo_location.errors.validation_exception.ValidationException: <p>The input failed to meet the constraints specified by the AWS service. </p>
        capo_location.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_location.types.search_place_index_for_suggestions_request.SearchPlaceIndexForSuggestionsRequest]",
    ) -> OperationResponse[
        "capo_location.types.search_place_index_for_suggestions_response.SearchPlaceIndexForSuggestionsResponse"
    ]:
        import capo_location._operations.location_service.search_place_index_for_suggestions

        output, http_response = (
            capo_location._operations.location_service.search_place_index_for_suggestions.search_place_index_for_suggestions(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_location.types.search_place_index_for_suggestions_request.SearchPlaceIndexForSuggestionsRequest",
    ) -> dict[str, Any]:
        import capo_location.types.search_place_index_for_suggestions_request

        return capo_location.types.search_place_index_for_suggestions_request.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_location.types.search_place_index_for_suggestions_response.SearchPlaceIndexForSuggestionsResponse",
    ) -> dict[str, Any]:
        import capo_location.types.search_place_index_for_suggestions_response

        return capo_location.types.search_place_index_for_suggestions_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "SearchPlaceIndexForSuggestions",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_location.types.search_place_index_for_suggestions_request.SearchPlaceIndexForSuggestionsRequest = {
        "index_name": index_name,
        "text": text,
    }
    if bias_position is not None:
        input_["bias_position"] = bias_position
    if filter_b_box is not None:
        input_["filter_b_box"] = filter_b_box
    if filter_countries is not None:
        input_["filter_countries"] = filter_countries
    if max_results is not None:
        input_["max_results"] = max_results
    if language is not None:
        input_["language"] = language
    if filter_categories is not None:
        input_["filter_categories"] = filter_categories
    if key is not None:
        input_["key"] = key

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