:doc:`LocationService <../../location>` / Client / get_map_tile

************
get_map_tile
************



.. py:method:: LocationService.Client.get_map_tile(**kwargs)

  

  

  .. warning::

    

    This operation is no longer current and may be deprecated in the future. We recommend upgrading to `GetTile <https://docs.aws.amazon.com/location/latest/APIReference/API_geomaps_GetTile.html>`__ 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 <https://docs.aws.amazon.com/location/latest/APIReference/API_Operations_Amazon_Location_Service_Maps_V2.html>`__ or the `Developer Guide <https://docs.aws.amazon.com/location/latest/developerguide/maps.html>`__.
    

    

   

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

  

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapTile>`_  


  **Request Syntax**
  ::

    response = client.get_map_tile(
        MapName='string',
        Z='string',
        X='string',
        Y='string',
        Key='string'
    )
    
  :type MapName: string
  :param MapName: **[REQUIRED]** 

    The map resource to retrieve the map tiles from.

    

  
  :type Z: string
  :param Z: **[REQUIRED]** 

    The zoom value for the map tile.

    

  
  :type X: string
  :param X: **[REQUIRED]** 

    The X axis value for the map tile.

    

  
  :type Y: string
  :param Y: **[REQUIRED]** 

    The Y axis value for the map tile.

    

  
  :type Key: string
  :param Key: 

    The optional `API key <https://docs.aws.amazon.com/location/previous/developerguide/using-apikeys.html>`__ to authorize the request.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'Blob': StreamingBody(),
          'ContentType': 'string',
          'CacheControl': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Blob** (:class:`.StreamingBody`) -- 

        Contains Mapbox Vector Tile (MVT) data.

        
      

      - **ContentType** *(string) --* 

        The map tile's content type. For example, ``application/vnd.mapbox-vector-tile``.

        
      

      - **CacheControl** *(string) --* 

        The HTTP Cache-Control directive for the value.

        
  
  **Exceptions**
  
  *   :py:class:`LocationService.Client.exceptions.InternalServerException`

  
  *   :py:class:`LocationService.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`LocationService.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`LocationService.Client.exceptions.ValidationException`

  
  *   :py:class:`LocationService.Client.exceptions.ThrottlingException`

  