SearchPlaceIndexForTextRequest

import type { SearchPlaceIndexForTextRequest } from "https://aws-api.deno.dev/v0.3/services/location.ts?docs=full";

interface SearchPlaceIndexForTextRequest {

BiasPosition?: number[] | null;

FilterBBox?: number[] | null;

FilterCountries?: string[] | null;

IndexName: string;

Language?: string | null;

MaxResults?: number | null;

Text: string;

}

§Properties

BiasPosition?: number[] | null

[src]

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.

FilterBBox?: number[] | null

[src]

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.

FilterCountries?: string[] | null

[src]

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.

IndexName: string

[src]

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

Language?: string | null

[src]

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.

MaxResults?: number | null

[src]

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

The default: 50

Text: string

[src]

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