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

***************
get_map_sprites
***************



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

  

  

  .. warning::

    

    This operation is no longer current and may be deprecated in the future. We recommend upgrading to `GetSprites <https://docs.aws.amazon.com/location/latest/APIReference/API_geomaps_GetSprites.html>`__ unless you require ``Grab`` data.

     

    
    * ``GetMapSprites`` 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 ``GetSprites`` 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 the sprite sheet corresponding to a map resource. The sprite sheet is a PNG image paired with a JSON document describing the offsets of individual icons that will be displayed on a rendered map.

  

  

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


  **Request Syntax**
  ::

    response = client.get_map_sprites(
        MapName='string',
        FileName='string',
        Key='string'
    )
    
  :type MapName: string
  :param MapName: **[REQUIRED]** 

    The map resource associated with the sprite ﬁle.

    

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

    The name of the sprite ﬁle. Use the following ﬁle names for the sprite sheet:

     

    
    * ``sprites.png``
     
    * ``sprites@2x.png`` for high pixel density displays
    

     

    For the JSON document containing image offsets. Use the following ﬁle names:

     

    
    * ``sprites.json``
     
    * ``sprites@2x.json`` for high pixel density displays
    

    

  
  :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 the body of the sprite sheet or JSON offset ﬁle.

        
      

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

        The content type of the sprite sheet and offsets. For example, the sprite sheet content type is ``image/png``, and the sprite offset JSON document is ``application/json``.

        
      

      - **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`

  