DESCRIBEROUTECALCULATOR()`¶

About DescribeRouteCalculator¶

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.

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

Retrieves the route calculator resource details.

Method Signature¶

METHODS /AWS1/IF_LOC~DESCRIBEROUTECALCULATOR
  IMPORTING
    !IV_CALCULATORNAME TYPE /AWS1/LOCRESOURCENAME OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_locdscroutecalculat01
  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_calculatorname` `TYPE /AWS1/LOCRESOURCENAME` `/AWS1/LOCRESOURCENAME`¶

The name of the route calculator resource.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_locdscroutecalculat01` `/AWS1/CL_LOCDSCROUTECALCULAT01`¶

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->describeroutecalculator( |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_calculatorname( ).
  lv_geoarn = lo_result->get_calculatorarn( ).
  lv_pricingplan = lo_result->get_pricingplan( ).
  lv_resourcedescription = lo_result->get_description( ).
  lv_timestamp = lo_result->get_createtime( ).
  lv_timestamp = lo_result->get_updatetime( ).
  lv_string = lo_result->get_datasource( ).
  LOOP AT lo_result->get_tags( ) into ls_row.
    lv_key = ls_row-key.
    lo_value = ls_row-value.
    IF lo_value IS NOT INITIAL.
      lv_tagvalue = lo_value->get_value( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_LOC=>DESCRIBEROUTECALCULATOR()¶