UPDATEPLACEINDEX()`¶

About UpdatePlaceIndex¶

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.

UpdatePlaceIndex 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.

Updates the specified properties of a given place index resource.

Method Signature¶

METHODS /AWS1/IF_LOC~UPDATEPLACEINDEX
  IMPORTING
    !IV_INDEXNAME TYPE /AWS1/LOCRESOURCENAME OPTIONAL
    !IV_PRICINGPLAN TYPE /AWS1/LOCPRICINGPLAN OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/LOCRESOURCEDESCRIPTION OPTIONAL
    !IO_DATASOURCECONFIGURATION TYPE REF TO /AWS1/CL_LOCDATASOURCECONF OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_locupdplaceindexrsp
  RAISING
    /AWS1/CX_LOCACCESSDENIEDEX
    /AWS1/CX_LOCINTERNALSERVEREX
    /AWS1/CX_LOCRESOURCENOTFOUNDEX
    /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 to update.

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`¶

Updates the description for the place index resource.

`io_datasourceconfiguration` `TYPE REF TO /AWS1/CL_LOCDATASOURCECONF` `/AWS1/CL_LOCDATASOURCECONF`¶

Updates the data storage option for the place index resource.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_locupdplaceindexrsp` `/AWS1/CL_LOCUPDPLACEINDEXRSP`¶

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->updateplaceindex(
  io_datasourceconfiguration = new /aws1/cl_locdatasourceconf( |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_updatetime( ).
ENDIF.

/AWS1/IF_LOC=>UPDATEPLACEINDEX()¶