Skip to content

GetMapSpritesRequest

Source code in docs_src/capo_location/types/get_map_sprites_request.py 
12
13
14
15
16
17
18
class GetMapSpritesRequest(TypedDict, closed=True):
    map_name: "capo_location.types.resource_name.ResourceName"
    """<p>The map resource associated with the sprite file.</p>"""
    file_name: "str"
    """<p>The name of the sprite file. Use the following file names for the sprite sheet:</p> <ul> <li> <p> <code>sprites.png</code> </p> </li> <li> <p> <code>[email protected]</code> for high pixel density displays</p> </li> </ul> <p>For the JSON document containing image offsets. Use the following file names:</p> <ul> <li> <p> <code>sprites.json</code> </p> </li> <li> <p> <code>[email protected]</code> for high pixel density displays</p> </li> </ul>"""
    key: NotRequired["capo_location.types.api_key.ApiKey"]
    """<p>The optional <a href="https://docs.aws.amazon.com/location/previous/developerguide/using-apikeys.html">API key</a> to authorize the request.</p>"""

file_name instance-attribute 

file_name: str

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

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

key instance-attribute 

key: NotRequired[ApiKey]

The optional API key to authorize the request.

map_name instance-attribute 

map_name: ResourceName

The map resource associated with the sprite file.