SearchPlaceIndexForText - Amazon Location Service Places

SearchPlaceIndexForText

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.

Request Syntax

POST /places/v0/indexes/IndexName/search/text HTTP/1.1 Content-type: application/json { "BiasPosition": [ number ], "FilterBBox": [ number ], "FilterCountries": [ "string" ], "Language": "string", "MaxResults": number, "Text": "string" }

URI Request Parameters

The request uses the following URI parameters.

IndexName

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

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[-._\w]+$

Required: Yes

Request Body

The request accepts the following data in JSON format.

BiasPosition

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.

Type: Array of doubles

Array Members: Fixed number of 2 items.

Required: No

FilterBBox

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.

Type: Array of doubles

Array Members: Fixed number of 4 items.

Required: No

FilterCountries

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.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Pattern: ^[A-Z]{3}$

Required: No

Language

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. It does not change which results are returned. If the language is not specified, or not supported for a particular result, the partner automatically chooses a language for the result.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 35.

Required: No

MaxResults

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

The default: 50

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

Text

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Results": [ { "Distance": number, "Place": { "AddressNumber": "string", "Country": "string", "Geometry": { "Point": [ number ] }, "Interpolated": boolean, "Label": "string", "Municipality": "string", "Neighborhood": "string", "PostalCode": "string", "Region": "string", "Street": "string", "SubRegion": "string", "TimeZone": { "Name": "string", "Offset": number } }, "Relevance": number } ], "Summary": { "BiasPosition": [ number ], "DataSource": "string", "FilterBBox": [ number ], "FilterCountries": [ "string" ], "Language": "string", "MaxResults": number, "ResultBBox": [ number ], "Text": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Results

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

Type: Array of SearchForTextResult objects

Summary

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.

Type: SearchPlaceIndexForTextSummary object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

HTTP Status Code: 403

InternalServerException

The request has failed to process because of an unknown server error, exception, or failure.

HTTP Status Code: 500

ResourceNotFoundException

The resource that you've entered was not found in your AWS account.

HTTP Status Code: 404

ThrottlingException

The request was denied because of request throttling.

HTTP Status Code: 429

ValidationException

The input failed to meet the constraints specified by the AWS service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: