Skip to content

/AWS1/IF_LOC=>LISTROUTECALCULATORS()

About ListRouteCalculators

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

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

  • The Routes API version 2 has a simplified interface that can be used without creating or managing route calculator resources.

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

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

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

Lists route calculator resources in your Amazon Web Services account.

Method Signature

METHODS /AWS1/IF_LOC~LISTROUTECALCULATORS
  IMPORTING
    !IV_MAXRESULTS TYPE /AWS1/LOCINTEGER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/LOCTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_loclstroutecalculat01
  RAISING
    /AWS1/CX_LOCACCESSDENIEDEX
    /AWS1/CX_LOCINTERNALSERVEREX
    /AWS1/CX_LOCTHROTTLINGEX
    /AWS1/CX_LOCVALIDATIONEX
    /AWS1/CX_LOCCLIENTEXC
    /AWS1/CX_LOCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_maxresults TYPE /AWS1/LOCINTEGER /AWS1/LOCINTEGER

An optional maximum number of results returned in a single call.

Default Value: 100

iv_nexttoken TYPE /AWS1/LOCTOKEN /AWS1/LOCTOKEN

The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Default Value: null

RETURNING

oo_output TYPE REF TO /aws1/cl_loclstroutecalculat01 /AWS1/CL_LOCLSTROUTECALCULAT01

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->listroutecalculators(
  iv_maxresults = 123
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_entries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_resourcename = lo_row_1->get_calculatorname( ).
      lv_resourcedescription = lo_row_1->get_description( ).
      lv_string = lo_row_1->get_datasource( ).
      lv_pricingplan = lo_row_1->get_pricingplan( ).
      lv_timestamp = lo_row_1->get_createtime( ).
      lv_timestamp = lo_row_1->get_updatetime( ).
    ENDIF.
  ENDLOOP.
  lv_token = lo_result->get_nexttoken( ).
ENDIF.