Places prerequisites using Amazon Location
Before you begin geocoding, reverse geocoding or searching for places, follow the prerequisite steps:
Creating a place index
resource
Begin by creating a place index resource in your AWS account.
When you create a place index resource, you can choose from the data providers available to support queries for geocoding, reverse geocoding, and searches:
-
Esri – For more information about Esri's coverage in your region of interest, see Esri geocoding coverage
in the Esri documentation. -
HERE Technologies – For more information about HERE's coverage in your region of interest, see HERE geocoding coverage
in the HERE documentation. -
Grab – Grab provides data only for Southeast Asia. For more information about Grab's coverage, see Countries/regions and area covered in this guide.
You can do this using the Amazon Location Service console, the AWS CLI, or the Amazon Location APIs.
To create a place index resource using the Amazon Location Service console
-
Open the Amazon Location Service console at https://console.aws.amazon.com/location/
. -
In the left navigation pane, choose Place indexes.
-
Choose Create place index.
-
Fill out the following boxes:
-
Name – Enter a name for the place index resource. For example,
ExamplePlaceIndex. Maximum 100 characters. Valid entries include alphanumeric characters, hyphens, periods, and underscores. -
Description – Enter an optional description.
-
-
Under Data providers, choose an available data provider
to use with your place index resource. Note
If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the AWS service terms
for more details. -
Under Data storage options, specify if you intend to store search results from your place index resource.
-
(Optional) Under Tags, enter a tag Key and Value. This adds a tag your new place index resource. For more information, see Tagging your resources.
-
Choose Create place index.
Note
Billing depends on your usage. You may incur fees for the use of other AWS
services. For more information, see Amazon Location Service
pricing
Authenticating your requests
Once you create a place index resource and you're ready to begin building location features into your application, choose how you would authenticate your requests:
-
To explore ways you can access the services, see Accessing Amazon Location Service.
-
If you have a website with anonymous users, you may want to use API Keys or Amazon Cognito.
Example
The following example shows using an API key for authorization, using AWS JavaScript SDK v3
, and the Amazon Location JavaScript Authentication helper. import { LocationClient, SearchPlaceIndexForTextCommand } from "@aws-sdk/client-location"; import { withAPIKey } from "@aws/amazon-location-utilities-auth-helper"; const apiKey = "v1.public.your-api-key-value"; // API key // Create an authentication helper instance using an API key const authHelper = await withAPIKey(apiKey); const client = new LocationClient({ region: "<region>", // region containing Cognito pool ...authHelper.getLocationClientConfig(), // Provides configuration required to make requests to Amazon Location }); const input = { IndexName: "ExamplePlaceIndex", Text: "Anyplace", BiasPosition: [-123.4567, 45.6789] }; const command = new SearchPlaceIndexForTextCommand(input); const response = await client.send(command);
