Create Place Index

locationservice_create_place_index

R Documentation

Creates a place index resource in your Amazon Web Services account

Description

Creates a place index resource in your Amazon Web Services account. Use a place index resource to geocode addresses and other text queries by using the search_place_index_for_text operation, and reverse geocode coordinates by using the search_place_index_for_position operation, and enable autosuggestions by using the search_place_index_for_suggestions operation.

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 Amazon Web Services service terms for more details.

Usage

locationservice_create_place_index(IndexName, DataSource, PricingPlan,
  Description, DataSourceConfiguration, Tags)

Arguments

IndexName

[required] The name of the place index resource.

Requirements:

• Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

• Must be a unique place index resource name.

• No spaces allowed. For example, ExamplePlaceIndex.

DataSource

[required] Specifies the geospatial data provider for the new place index.

This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

Valid values include:

• Esri – For additional information about Esri's coverage in your region of interest, see Esri details on geocoding coverage.

• Grab – Grab provides place index functionality for Southeast Asia. For additional information about GrabMaps' coverage, see GrabMaps countries and areas covered.

• Here – For additional information about HERE Technologies' coverage in your region of interest, see HERE details on goecoding coverage.

  If you specify HERE Technologies (Here) as the data provider, you may not store results for locations in Japan. For more information, see the Amazon Web Services Service Terms for Amazon Location Service.

For additional information , see Data providers on the Amazon Location Service Developer Guide.

PricingPlan

No longer used. If included, the only allowed value is RequestBasedUsage.

Description

The optional description for the place index resource.

DataSourceConfiguration

Specifies the data storage option requesting Places.

Tags

Applies one or more tags to the place index resource. A tag is a key-value pair that helps you manage, identify, search, and filter your resources.

Format: "key" : "value"

Restrictions:

• Maximum 50 tags per resource.

• Each tag key must be unique and must have exactly one associated value.

• Maximum key length: 128 Unicode characters in UTF-8.

• Maximum value length: 256 Unicode characters in UTF-8.

• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @

• Cannot use "aws:" as a prefix for a key.

Value

A list with the following syntax:

list(
  IndexName = "string",
  IndexArn = "string",
  CreateTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$create_place_index(
  IndexName = "string",
  DataSource = "string",
  PricingPlan = "RequestBasedUsage"|"MobileAssetTracking"|"MobileAssetManagement",
  Description = "string",
  DataSourceConfiguration = list(
    IntendedUse = "SingleUse"|"Storage"
  ),
  Tags = list(
    "string"
  )
)