Skip to content

/AWS1/IF_LOC=>CREATEPLACEINDEX()

About CreatePlaceIndex

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Places API V2 unless you require Grab data.

  • CreatePlaceIndex is part of a previous Amazon Location Service Places API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2).

  • The Places API version 2 has a simplified interface that can be used without creating or managing place index resources.

  • If you are using an Amazon Web Services SDK or the Amazon Web Services CLI, note that the Places API version 2 is found under geo-places or geo_places, not under location.

  • Since Grab is not yet fully supported in Places API version 2, we recommend you continue using API version 1 when using Grab.

  • Start your version 2 API journey with the Places V2 API Reference or the Developer Guide.

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 SearchPlaceIndexForText operation, and reverse geocode coordinates by using the SearchPlaceIndexForPosition operation, and enable autosuggestions by using the SearchPlaceIndexForSuggestions 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.

Method Signature

METHODS /AWS1/IF_LOC~CREATEPLACEINDEX
  IMPORTING
    !IV_INDEXNAME TYPE /AWS1/LOCRESOURCENAME OPTIONAL
    !IV_DATASOURCE TYPE /AWS1/LOCSTRING OPTIONAL
    !IV_PRICINGPLAN TYPE /AWS1/LOCPRICINGPLAN OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/LOCRESOURCEDESCRIPTION OPTIONAL
    !IO_DATASOURCECONFIGURATION TYPE REF TO /AWS1/CL_LOCDATASOURCECONF OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_LOCTAGMAP_W=>TT_TAGMAP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_loccreplaceindexrsp
  RAISING
    /AWS1/CX_LOCACCESSDENIEDEX
    /AWS1/CX_LOCCONFLICTEXCEPTION
    /AWS1/CX_LOCINTERNALSERVEREX
    /AWS1/CX_LOCSERVICEQUOTAEXCDEX
    /AWS1/CX_LOCTHROTTLINGEX
    /AWS1/CX_LOCVALIDATIONEX
    /AWS1/CX_LOCCLIENTEXC
    /AWS1/CX_LOCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_indexname TYPE /AWS1/LOCRESOURCENAME /AWS1/LOCRESOURCENAME

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.

iv_datasource TYPE /AWS1/LOCSTRING /AWS1/LOCSTRING

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:

For additional information , see Data providers on the Amazon Location Service developer guide.

Optional arguments:

iv_pricingplan TYPE /AWS1/LOCPRICINGPLAN /AWS1/LOCPRICINGPLAN

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

iv_description TYPE /AWS1/LOCRESOURCEDESCRIPTION /AWS1/LOCRESOURCEDESCRIPTION

The optional description for the place index resource.

io_datasourceconfiguration TYPE REF TO /AWS1/CL_LOCDATASOURCECONF /AWS1/CL_LOCDATASOURCECONF

Specifies the data storage option requesting Places.

it_tags TYPE /AWS1/CL_LOCTAGMAP_W=>TT_TAGMAP TT_TAGMAP

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.

RETURNING

oo_output TYPE REF TO /aws1/cl_loccreplaceindexrsp /AWS1/CL_LOCCREPLACEINDEXRSP

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->createplaceindex(
  io_datasourceconfiguration = new /aws1/cl_locdatasourceconf( |string| )
  it_tags = VALUE /aws1/cl_loctagmap_w=>tt_tagmap(
    (
      VALUE /aws1/cl_loctagmap_w=>ts_tagmap_maprow(
        key = |string|
        value = new /aws1/cl_loctagmap_w( |string| )
      )
    )
  )
  iv_datasource = |string|
  iv_description = |string|
  iv_indexname = |string|
  iv_pricingplan = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_resourcename = lo_result->get_indexname( ).
  lv_geoarn = lo_result->get_indexarn( ).
  lv_timestamp = lo_result->get_createtime( ).
ENDIF.