:doc:`LocationServiceMapsV2 <../../geo-maps>` / Client / get_sprites

***********
get_sprites
***********



.. py:method:: LocationServiceMapsV2.Client.get_sprites(**kwargs)

  

  ``GetSprites`` returns the map's sprites.

   

  For more information, see `Style iconography with sprites <https://docs.aws.amazon.com/location/latest/developerguide/styling-iconography-with-sprites.html>`__ in the *Amazon Location Service Developer Guide*.

  

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


  **Request Syntax**
  ::

    response = client.get_sprites(
        FileName='string',
        Style='Standard'|'Monochrome'|'Hybrid'|'Satellite',
        ColorScheme='Light'|'Dark',
        Variant='Default'
    )
    
  :type FileName: string
  :param FileName: **[REQUIRED]** 

    ``Sprites`` API: The name of the sprite ﬁle to retrieve, following pattern ``sprites(@2x)?\.(png|json)``.

     

    Example: ``sprites.png``

    

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

    Style specifies the desired map style for the ``Sprites`` APIs.

    

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

    Sets color tone for map such as dark and light for specific map styles. It applies to only vector map styles such as Standard and Monochrome.

     

    Example: ``Light``

     

    Default value: ``Light``

     

    .. note::

      

      Valid values for ColorScheme are case sensitive.

      

    

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

    Optimizes map styles for specific use case or industry. You can choose allowed variant only with Standard map style.

     

    Example: ``Default``

     

    .. note::

      

      Valid values for Variant are case sensitive.

      

    

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

    
    ::

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

    

    - *(dict) --* 
      

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

        The body of the sprite sheet or JSON offset file (image/png or application/json, depending on input).

        
      

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

        Header that represents the format of the response. The response returns the following as the HTTP body.

        
      

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

        Header that instructs caching configuration for the client.

        
      

      - **ETag** *(string) --* 

        The sprite's Etag.

        
  