View a markdown version of this page

Managing your place index resources (V1) - Amazon Location Service
List your place index resourcesGet place index resource detailsDelete a place index resource

Managing your place index resources (V1)

Important

This page documents the previous Places API (V1). Use it only for existing applications. The Places V2 API is the latest version. Use it for all new applications; see the latest Amazon Location Service Places developer guide.

The latest API calls Geocode, ReverseGeocode, SearchText, SearchNearby, Suggest, Autocomplete, and GetPlace directly. These operations are under the geo-places namespace. They are exposed as @aws-sdk/client-geo-places for JavaScript and boto3.client('geo-places') for Python.

There is no PlaceIndex resource to create, describe, or delete.

You can manage your place index resources using the Amazon Location console, the AWS CLI, or the Amazon Location APIs.

List your place index resources

You can view your place index resources list using the Amazon Location console, the AWS CLI, or the Amazon Location APIs:

Console

To view a list of place index resources using the Amazon Location console

  1. Open the Amazon Location console at https://console.aws.amazon.com/location/.

  2. Choose Place indexes from the left navigation pane.

  3. View a list of your place index resources under the My place indexes.

API

Use the ListPlaceIndexes operation from the Amazon Location Places APIs.

The following example is an API request to get a list of place index resources in the AWS account. 

POST /places/v0/list-indexes

The following is an example response for ListPlaceIndexes:

{
   "Entries": [ 
      { 
         "CreateTime": 2020-10-30T01:38:36Z,
         "DataSource": "Esri",
         "Description": "string",
         "IndexName": "ExamplePlaceIndex",
         "UpdateTime": 2020-10-30T01:40:36Z
      }
   ],
   "NextToken": "1234-5678-9012"
}
CLI

Use the list-place-indexes command.

The following example is an AWS CLI to get a list of place index resources in the AWS account. 

aws location list-place-indexes

Get place index resource details

You can get details about any place index resource in your AWS account using the Amazon Location console, the AWS CLI, or the Amazon Location APIs:

Console

To view the details of a place index resource using the Amazon Location console

  1. Open the Amazon Location console at https://console.aws.amazon.com/location/.

  2. Choose Place indexes from the left navigation pane.

  3. Under My place indexes, select the name link of the target place index resource.

API

Use the DescribePlaceIndex operation from the Amazon Location Place APIs.

The following example is an API request to get the place index resource details for ExamplePlaceIndex.

GET /places/v0/indexes/ExamplePlaceIndex

The following is an example response for DescribePlaceIndex:

{
   "CreateTime": 2020-10-30T01:38:36Z,
   "DataSource": "Esri",
   "DataSourceConfiguration": { 
      "IntendedUse": "SingleUse"
   },
   "Description": "string",
   "IndexArn": "arn:aws:geo:us-west-2:123456789012:place-indexes/ExamplePlaceIndex",
   "IndexName": "ExamplePlaceIndex",
   "Tags": { 
      "string" : "string" 
   },
   "UpdateTime": 2020-10-30T01:40:36Z
}
CLI

Use the describe-place-index command.

The following example is an AWS CLI to get the place index resource details for ExamplePlaceIndex.

aws location describe-place-index \
    --index-name "ExamplePlaceIndex"

Delete a place index resource

You can delete a place index resource from your AWS account using the Amazon Location console, the AWS CLI, or the Amazon Location APIs:

Console

To delete a place index resource using the Amazon Location console

Warning

This operation deletes the resource permanently.

  1. Open the Amazon Location console at https://console.aws.amazon.com/location/.

  2. Choose Place indexes from the left navigation pane.

  3. Under My place index, select the target place index resource.

  4. Choose Delete place index.

API

Use the DeletePlaceIndex operation from the Amazon Location Places APIs.

The following example is an API request to delete the place index resource ExamplePlaceIndex.

DELETE /places/v0/indexes/ExamplePlaceIndex

The following is an example success response for DeletePlaceIndex:

HTTP/1.1 200
CLI

Use the delete-place-index command.

The following example is an AWS CLI command to delete the place index resource ExamplePlaceIndex.

aws location delete-place-index \
    --index-name "ExamplePlaceIndex"