Skip to content

/AWS1/IF_LOC=>UPDATETRACKER()

About UpdateTracker

Updates the specified properties of a given tracker resource.

Method Signature

METHODS /AWS1/IF_LOC~UPDATETRACKER
  IMPORTING
    !IV_TRACKERNAME TYPE /AWS1/LOCRESOURCENAME OPTIONAL
    !IV_PRICINGPLAN TYPE /AWS1/LOCPRICINGPLAN OPTIONAL
    !IV_PRICINGPLANDATASOURCE TYPE /AWS1/LOCSTRING OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/LOCRESOURCEDESCRIPTION OPTIONAL
    !IV_POSITIONFILTERING TYPE /AWS1/LOCPOSITIONFILTERING OPTIONAL
    !IV_EVENTBRIDGEENABLED TYPE /AWS1/LOCBOOLEAN OPTIONAL
    !IV_KMSKEYENBGEOSPATIALQUER00 TYPE /AWS1/LOCBOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_locupdatetrackerrsp
  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_trackername TYPE /AWS1/LOCRESOURCENAME /AWS1/LOCRESOURCENAME

The name of the tracker resource to update.

Optional arguments:

iv_pricingplan TYPE /AWS1/LOCPRICINGPLAN /AWS1/LOCPRICINGPLAN

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

iv_pricingplandatasource TYPE /AWS1/LOCSTRING /AWS1/LOCSTRING

This parameter is no longer used.

iv_description TYPE /AWS1/LOCRESOURCEDESCRIPTION /AWS1/LOCRESOURCEDESCRIPTION

Updates the description for the tracker resource.

iv_positionfiltering TYPE /AWS1/LOCPOSITIONFILTERING /AWS1/LOCPOSITIONFILTERING

Updates the position filtering for the tracker resource.

Valid values:

  • TimeBased - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID.

  • DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.

  • AccuracyBased - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This helps educe the effects of GPS noise when displaying device trajectories on a map, and can help control costs by reducing the number of geofence evaluations.

iv_eventbridgeenabled TYPE /AWS1/LOCBOOLEAN /AWS1/LOCBOOLEAN

Whether to enable position UPDATE events from this tracker to be sent to EventBridge.

You do not need enable this feature to get ENTER and EXIT events for geofences with this tracker. Those events are always sent to EventBridge.

iv_kmskeyenbgeospatialquer00 TYPE /AWS1/LOCBOOLEAN /AWS1/LOCBOOLEAN

Enables GeospatialQueries for a tracker that uses a Amazon Web Services KMS customer managed key.

This parameter is only used if you are using a KMS customer managed key.

RETURNING

oo_output TYPE REF TO /aws1/cl_locupdatetrackerrsp /AWS1/CL_LOCUPDATETRACKERRSP

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->updatetracker(
  iv_description = |string|
  iv_eventbridgeenabled = ABAP_TRUE
  iv_kmskeyenbgeospatialquer00 = ABAP_TRUE
  iv_positionfiltering = |string|
  iv_pricingplan = |string|
  iv_pricingplandatasource = |string|
  iv_trackername = |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_trackername( ).
  lv_arn = lo_result->get_trackerarn( ).
  lv_timestamp = lo_result->get_updatetime( ).
ENDIF.