LocationService / Client / search_place_index_for_text

search_place_index_for_text#

LocationService.Client.search_place_index_for_text(**kwargs)#

Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.

Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe.

Note

You can search for places near a given position using BiasPosition, or filter results within a bounding box using FilterBBox. Providing both parameters simultaneously returns an error.

Search results are returned in order of highest to lowest relevance.

See also: AWS API Documentation

Request Syntax

response = client.search_place_index_for_text(
    IndexName='string',
    Text='string',
    BiasPosition=[
        123.0,
    ],
    FilterBBox=[
        123.0,
    ],
    FilterCountries=[
        'string',
    ],
    MaxResults=123,
    Language='string',
    FilterCategories=[
        'string',
    ],
    Key='string'
)
Parameters:

  • IndexName (string) –

    [REQUIRED]

    The name of the place index resource you want to use for the search.

  • Text (string) –

    [REQUIRED]

    The address, name, city, or region to be used in the search in free-form text format. For example, 123 Any Street.

  • BiasPosition (list) –

    An optional parameter that indicates a preference for places that are closer to a specified position.

    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.

    For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.

    Note

    BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error.

    • (float) –

  • FilterBBox (list) –

    An optional parameter that limits the search results by returning only places that are within the provided bounding box.

    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.

    For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542.

    Note

    FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.

    • (float) –

  • FilterCountries (list) –

    An optional parameter that limits the search results by returning only places that are in a specified list of countries.

    • Valid values include ISO 3166 3-digit country codes. For example, Australia uses three upper-case characters: AUS.

    • (string) –

  • MaxResults (integer) –

    An optional parameter. The maximum number of results returned per request.

    The default: 50

  • Language (string) –

    The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

    This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

    For an example, we’ll use the Greek language. You search for Athens, Greece, with the language parameter set to en. The result found will most likely be returned as Athens.

    If you set the language parameter to el, for Greek, then the result found will more likely be returned as Αθήνα.

    If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

  • FilterCategories (list) –

    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 any of the categories listed.

    For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.

    • (string) –

  • Key (string) – The optional API key to authorize the request.

Return type:

dict

Returns:

Response Syntax

{
    'Summary': {
        'Text': 'string',
        'BiasPosition': [
            123.0,
        ],
        'FilterBBox': [
            123.0,
        ],
        'FilterCountries': [
            'string',
        ],
        'MaxResults': 123,
        'ResultBBox': [
            123.0,
        ],
        'DataSource': 'string',
        'Language': 'string',
        'FilterCategories': [
            'string',
        ]
    },
    'Results': [
        {
            'Place': {
                'Label': 'string',
                'Geometry': {
                    'Point': [
                        123.0,
                    ]
                },
                'AddressNumber': 'string',
                'Street': 'string',
                'Neighborhood': 'string',
                'Municipality': 'string',
                'SubRegion': 'string',
                'Region': 'string',
                'Country': 'string',
                'PostalCode': 'string',
                'Interpolated': True|False,
                'TimeZone': {
                    'Name': 'string',
                    'Offset': 123
                },
                'UnitType': 'string',
                'UnitNumber': 'string',
                'Categories': [
                    'string',
                ],
                'SupplementalCategories': [
                    'string',
                ],
                'SubMunicipality': 'string'
            },
            'Distance': 123.0,
            'Relevance': 123.0,
            'PlaceId': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • Summary (dict) –

      Contains a summary of the request. Echoes the input values for BiasPosition, FilterBBox, FilterCountries, Language, MaxResults, and Text. Also includes the DataSource of the place index and the bounding box, ResultBBox, which surrounds the search results.

      • Text (string) –

        The search text specified in the request.

      • BiasPosition (list) –

        Contains the coordinates for the optional bias position specified in the request.

        This parameter contains a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

        For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.

        • (float) –

      • FilterBBox (list) –

        Contains the coordinates for the optional bounding box specified in the request.

        • (float) –

      • FilterCountries (list) –

        Contains the optional country filter specified in the request.

        • (string) –

      • MaxResults (integer) –

        Contains the optional result count limit specified in the request.

      • ResultBBox (list) –

        The bounding box that fully contains all search results.

        Note

        If you specified the optional FilterBBox parameter in the request, ResultBBox is contained within FilterBBox.

        • (float) –

      • DataSource (string) –

        The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:

        • Esri

        • Grab

        • Here

        For more information about data providers, see Amazon Location Service data providers.

      • Language (string) –

        The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English.

      • FilterCategories (list) –

        The optional category filter specified in the request.

        • (string) –

    • Results (list) –

      A list of Places matching the input text. Each result contains additional information about the specific point of interest.

      Not all response properties are included with all responses. Some properties may only be returned by specific data partners.

      • (dict) –

        Contains a search result from a text search query that is run on a place index resource.

        • Place (dict) –

          Details about the search result, such as its address and position.

          • Label (string) –

            The full name and address of the point of interest such as a city, region, or country. For example, 123 Any Street, Any Town, USA.

          • Geometry (dict) –

            Places uses a point geometry to specify a location or a Place.

            • Point (list) –

              A single point geometry specifies a location for a Place using WGS 84 coordinates:

              • x — Specifies the x coordinate or longitude.

              • y — Specifies the y coordinate or latitude.

              • (float) –

          • AddressNumber (string) –

            The numerical portion of an address, such as a building number.

          • Street (string) –

            The name for a street or a road to identify a location. For example, Main Street.

          • Neighborhood (string) –

            The name of a community district. For example, Downtown.

          • Municipality (string) –

            A name for a local area, such as a city or town name. For example, Toronto.

          • SubRegion (string) –

            A county, or an area that’s part of a larger region. For example, Metro Vancouver.

          • Region (string) –

            A name for an area or geographical division, such as a province or state name. For example, British Columbia.

          • Country (string) –

            A country/region specified using ISO 3166 3-digit country/region code. For example, CAN.

          • PostalCode (string) –

            A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.

          • Interpolated (boolean) –

            True if the result is interpolated from other known places.

            False if the Place is a known place.

            Not returned when the partner does not provide the information.

            For example, returns False for an address location that is found in the partner data, but returns True if an address does not exist in the partner data and its location is calculated by interpolating between other known addresses.

          • TimeZone (dict) –

            The time zone in which the Place is located. Returned only when using HERE or Grab as the selected partner.

            • Name (string) –

              The name of the time zone, following the IANA time zone standard. For example, America/Los_Angeles.

            • Offset (integer) –

              The time zone’s offset, in seconds, from UTC.

          • UnitType (string) –

            For addresses with a UnitNumber, the type of unit. For example, Apartment.

            Note

            Returned only for a place index that uses Esri as a data provider.

          • UnitNumber (string) –

            For addresses with multiple units, the unit identifier. Can include numbers and letters, for example 3B or Unit 123.

            Note

            Returned only for a place index that uses Esri or Grab as a data provider. Is not returned for SearchPlaceIndexForPosition.

          • Categories (list) –

            The Amazon Location categories that describe this Place.

            For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.

            • (string) –

          • SupplementalCategories (list) –

            Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.

            • (string) –

          • SubMunicipality (string) –

            An area that’s part of a larger municipality. For example, Blissville is a submunicipality in the Queen County in New York.

            Note

            This property supported by Esri and OpenData. The Esri property is district, and the OpenData property is borough.

        • Distance (float) –

          The distance in meters of a great-circle arc between the bias position specified and the result. Distance will be returned only if a bias position was specified in the query.

          Note

          A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance between two locations.

        • Relevance (float) –

          The relative confidence in the match for a result among the results returned. For example, if more fields for an address match (including house number, street, city, country/region, and postal code), the relevance score is closer to 1.

          Returned only when the partner selected is Esri or Grab.

        • PlaceId (string) –

          The unique identifier of the place. You can use this with the GetPlace operation to find the place again later.

          Note

          For SearchPlaceIndexForText operations, the PlaceId is returned only by place indexes that use HERE or Grab as a data provider.

Exceptions