SearchPlaceIndexForPositionRequest

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

interface SearchPlaceIndexForPositionRequest {

IndexName: string;

Language?: string | null;

MaxResults?: number | null;

Position: number[];

}

§Properties

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.

Default value: 50

Position: number[]

[src]

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.