SearchPlaceIndexForText

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

The optional API key to authorize the request.

Length Constraints: Minimum length of 0. Maximum length of 1000.

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.

Type: Array of doubles

Array Members: Fixed number of 2 items.

Required: No

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.

Type: Array of doubles

Array Members: Fixed number of 4 items.

Required: No

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.

Type: Array of strings

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

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

Required: No

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

Type: Array of strings

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

Length Constraints: Fixed length of 3.

Pattern: [A-Z]{3}

Required: No

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.

Type: String

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

Required: No

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

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

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.

Type: Array of SearchForTextResult objects

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

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

HTTP Status Code: 403

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

HTTP Status Code: 500

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

HTTP Status Code: 404

The request was denied because of request throttling.

HTTP Status Code: 429

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

HTTP Status Code: 400