Skip to content

/AWS1/IF_LOC=>GETMAPTILE()

About GetMapTile

This operation is no longer current and may be deprecated in the future. We recommend upgrading to GetTile unless you require Grab data.

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

  • The version 2 GetTile operation gives a better user experience and is compatible with the remainder of the V2 Maps API.

  • If you are using an AWS SDK or the AWS CLI, note that the Maps API version 2 is found under geo-maps or geo_maps, not under location.

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

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

Retrieves a vector data tile from the map resource. Map tiles are used by clients to render a map. they're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level.

The origin (0, 0) is the top left of the map. Increasing the zoom level by 1 doubles both the X and Y dimensions, so a tile containing data for the entire world at (0/0/0) will be split into 4 tiles at zoom 1 (1/0/0, 1/0/1, 1/1/0, 1/1/1).

Method Signature

METHODS /AWS1/IF_LOC~GETMAPTILE
  IMPORTING
    !IV_MAPNAME TYPE /AWS1/LOCRESOURCENAME OPTIONAL
    !IV_Z TYPE /AWS1/LOCSENSITIVESTRING OPTIONAL
    !IV_X TYPE /AWS1/LOCSENSITIVESTRING OPTIONAL
    !IV_Y TYPE /AWS1/LOCSENSITIVESTRING OPTIONAL
    !IV_KEY TYPE /AWS1/LOCAPIKEY OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_locgetmaptileresponse
  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_mapname TYPE /AWS1/LOCRESOURCENAME /AWS1/LOCRESOURCENAME

The map resource to retrieve the map tiles from.

iv_z TYPE /AWS1/LOCSENSITIVESTRING /AWS1/LOCSENSITIVESTRING

The zoom value for the map tile.

iv_x TYPE /AWS1/LOCSENSITIVESTRING /AWS1/LOCSENSITIVESTRING

The X axis value for the map tile.

iv_y TYPE /AWS1/LOCSENSITIVESTRING /AWS1/LOCSENSITIVESTRING

The Y axis value for the map tile.

Optional arguments:

iv_key TYPE /AWS1/LOCAPIKEY /AWS1/LOCAPIKEY

The optional API key to authorize the request.

RETURNING

oo_output TYPE REF TO /aws1/cl_locgetmaptileresponse /AWS1/CL_LOCGETMAPTILERESPONSE

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->getmaptile(
  iv_key = |string|
  iv_mapname = |string|
  iv_x = |string|
  iv_y = |string|
  iv_z = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_blob = lo_result->get_blob( ).
  lv_string = lo_result->get_contenttype( ).
  lv_string = lo_result->get_cachecontrol( ).
ENDIF.