Page updated Jan 16, 2024

Use existing Amazon Location resources

Amplify iOS v1 is now in Maintenance Mode until May 31st, 2024. This means that we will continue to include updates to ensure compatibility with backend services and security. No new features will be introduced in v1.

Please use the latest version (v2) of Amplify Library for Swift to get started.

If you are currently using v1, follow these instructions to upgrade to v2.

Amplify libraries should be used for all new cloud connected applications. If you are currently using the AWS Mobile SDK for iOS, you can access the documentation here.

You can also use Amplify Geo with your existing Amazon Location Service resources if you'd like, there's just some manual setup that you need to do.

Authorization permissions

To use your existing Amazon Location Service resources, i.e. maps and place indices, with Amplify Geo, you need to ensure your role has the right authorization permissions through Cognito. If you set up your Cognito resources in any way other than the Amplify CLI or Amplify Studio, the roles will need to be given permission to access the map and place indices.

Note: Here is a guide on Creating an Amazon Cognito identity pool for use with Amazon Location Service

There are two roles created by Cognito: an Auth_Role that grants signed-in-user-level access and an Unauth_Role that allows unauthenticated access to resources. Attach the following policies for the appropriate resources and roles (Auth and/or Unauth). Replace {region}, {account-id}, and {enter Map/PlaceIndex name} with the correct items. Note that certain actions cannot be performed with unauthenticated access. The list of actions allowed for the Unauth role is in the Granting access to Amazon Location Service guide.

1{
2 "Version": "2012-10-17",
3 "Statement": [
4 {
5 "Sid": "GetTiles",
6 "Effect": "Allow",
7 "Action": [
8 "geo:GetMapTile",
9 "geo:GetMapSprites",
10 "geo:GetMapGlyphs",
11 "geo:GetMapStyleDescriptor"
12 ],
13 "Resource": "arn:aws:geo:{region}:{account-id}:map/{enter Map name}"
14 },
15 {
16 "Sid": "Search",
17 "Effect": "Allow",
18 "Action": [
19 "geo:SearchPlaceIndexForPosition",
20 "geo:SearchPlaceIndexForText"
21 ],
22 "Resource": "arn:aws:geo:{region}:{account-id}:place-index/{enter PlaceIndex name}"
23 }
24 ]
25}

In your app configuration

Amplify Geo is dependent on your Amplify Auth category. If it is not already configured, then you will need to configure it as well.

Existing Amazon Location Service resources can be used with the Amplify Libraries by adding information about the resources to your amplifyconfiguration.json file.

1{
2 "geo": {
3 "plugins": {
4 "awsLocationGeoPlugin": {
5 "region": <YOUR_REGION>,
6 "maps": {
7 "items": {
8 <YOUR_MAP_NAME>: {
9 "style": <YOUR_MAP_STYLE>
10 }
11 },
12 "default": <DEFAULT_MAP_NAME>
13 },
14 "searchIndices": {
15 "items": [
16 <YOUR_PLACE_INDEX>
17 ],
18 "default": <DEFAULT_PLACE_INDEX>
19 }
20 }
21 }
22 }
23}