LocationService / Client / search_place_index_for_position

search_place_index_for_position#

LocationService.Client.search_place_index_for_position(**kwargs)#

Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position.

Request Syntax

response = client.search_place_index_for_position(
    IndexName='string',
    Key='string',
    Language='string',
    MaxResults=123,
    Position=[
        123.0,
    ]
)

Parameters:

IndexName (string) –
[REQUIRED]

The name of the place index resource you want to use for the search.
Key (string) – The optional API key to authorize the request.
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 a location around Athens, Greece, with the language parameter set to en. The city in the results will most likely be returned as Athens.

If you set the language parameter to el, for Greek, then the city in the results 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.
MaxResults (integer) –
An optional parameter. The maximum number of results returned per request.

Default value: 50
Position (list) –
[REQUIRED]

Specifies the longitude and latitude of the position to query.

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 a position with longitude -123.1174 and latitude 49.2847.
- (float) –

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- Results (list) –
  
  Returns a list of Places closest to the specified position. Each result contains additional information about the Places returned.
  - (dict) –
    
    Contains a search result from a position search query that is run on a place index resource.
    - Distance (float) –
      
      The distance in meters of a great-circle arc between the query position and the result.
      
      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.
    - Place (dict) –
      
      Details about the search result, such as its address and position.
      - AddressNumber (string) –
        
        The numerical portion of an address, such as a building number.
      - 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) –
      - Country (string) –
        
        A country/region specified using ISO 3166 3-digit country/region code. For example, CAN.
      - 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) –
      - 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.
      - 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.
      - Municipality (string) –
        
        A name for a local area, such as a city or town name. For example, Toronto.
      - Neighborhood (string) –
        
        The name of a community district. For example, Downtown.
      - PostalCode (string) –
        
        A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.
      - Region (string) –
        
        A name for an area or geographical division, such as a province or state name. For example, British Columbia.
      - Street (string) –
        
        The name for a street or a road to identify a location. For example, Main Street.
      - 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 is only returned for a place index that uses Esri as a data provider. The property is represented as a district.
        
        For more information about data providers, see Amazon Location Service data providers.
      - SubRegion (string) –
        
        A county, or an area that’s part of a larger region. For example, Metro Vancouver.
      - SupplementalCategories (list) –
        
        Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
        
        (string) –
      - 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.
      - UnitNumber (string) –
        
        For addresses with multiple units, the unit identifier. Can include numbers and letters, for example 3B or Unit 123.
        
        Note
        This property is returned only for a place index that uses Esri or Grab as a data provider. It is not returned for SearchPlaceIndexForPosition.
      - UnitType (string) –
        
        For addresses with a UnitNumber, the type of unit. For example, Apartment.
        
        Note
        This property is returned only for a place index that uses Esri as a data provider.
    - PlaceId (string) –
      
      The unique identifier of the place. You can use this with the GetPlace operation to find the place again later.
      
      Note
      For SearchPlaceIndexForPosition operations, the PlaceId is returned only by place indexes that use HERE or Grab as a data provider.
- Summary (dict) –
  
  Contains a summary of the request. Echoes the input values for Position, Language, MaxResults, and the DataSource of the place index.
  - 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.
  - MaxResults (integer) –
    
    Contains the optional result count limit that is specified in the request.
    
    Default value: 50
  - Position (list) –
    
    The position specified in the request.
    - (float) –

Exceptions

LocationService.Client.exceptions.InternalServerException
LocationService.Client.exceptions.ResourceNotFoundException
LocationService.Client.exceptions.AccessDeniedException
LocationService.Client.exceptions.ValidationException
LocationService.Client.exceptions.ThrottlingException