/places/v0/indexes/{IndexName}/search/text

The Amazon Location Service multi-region endpoint

http://geo.{region}.amazonaws.com

POST

Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.

Includes the option to apply additional parameters to narrow your list of results.

Request

Path Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟠480InternalServerException

🟠481ResourceNotFoundException

🟠482AccessDeniedException

🟠483ValidationException

🟠484ThrottlingException

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'http://geo.{region}.amazonaws.com/places/v0/indexes//search/text' \
--header 'Content-Type: application/json' \
--data-raw '{
    "BiasPosition": [
        0,
        0
    ],
    "FilterBBox": [
        0,
        0,
        0,
        0
    ],
    "FilterCountries": [
        "string"
    ],
    "MaxResults": 1,
    "Text": "pa$$word"
}'

Response Example

200 - Example 1

{
    "Results": [],
    "Summary": {
        "BiasPosition": [],
        "DataSource": "string",
        "FilterBBox": [],
        "FilterCountries": [],
        "MaxResults": 0,
        "ResultBBox": [],
        "Text": "string"
    }
}

Modified at 2022-09-10 19:59:22

/places/v0/indexes/{IndexName}/search/position

/tags/{ResourceArn}