get_sprites ¶

get_sprites(
    file_name: str,
    style: MapStyle,
    color_scheme: ColorScheme,
    variant: Variant,
    *,
    config_overrides: Optional[GeoMapsClientConfig] = None,
) -> GetSpritesResponse

GetSprites returns the map's sprites.

For more information, see Style iconography with sprites in the Amazon Location Service Developer Guide.

Parameters:

file_name (str) –

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

Example: sprites.png
style (MapStyle) –

Style specifies the desired map style for the Sprites APIs.
color_scheme (ColorScheme) –

Sets the color tone for the map sprites, such as dark and light.

Example: Light

Default value: Light

Valid values for ColorScheme are case sensitive.
variant (Variant) –

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

Example: Default

Valid values for Variant are case sensitive.

Raises:

UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_geo_maps/_services/geo_maps.py

def get_sprites(
    self,
    file_name: str,
    style: "capo_geo_maps.types.map_style.MapStyle",
    color_scheme: "capo_geo_maps.types.color_scheme.ColorScheme",
    variant: "capo_geo_maps.types.variant.Variant",
    *,
    config_overrides: Optional[GeoMapsClientConfig] = None,
) -> "capo_geo_maps.types.get_sprites_response.GetSpritesResponse":
    r"""<p> <code>GetSprites</code> returns the map's sprites.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/styling-iconography-with-sprites.html">Style iconography with sprites</a> in the <i>Amazon Location Service Developer Guide</i>.</p>

    Args:
        file_name: <p> <code>Sprites</code> API: The name of the sprite ﬁle to retrieve, following pattern <code>sprites(@2x)?\.(png|json)</code>.</p> <p>Example: <code>sprites.png</code> </p>
        style: <p>Style specifies the desired map style for the <code>Sprites</code> APIs.</p>
        color_scheme: <p>Sets the color tone for the map sprites, such as dark and light.</p> <p>Example: <code>Light</code> </p> <p>Default value: <code>Light</code> </p> <note> <p>Valid values for ColorScheme are case sensitive.</p> </note>
        variant: <p>Optimizes map styles for specific use case or industry. You can choose allowed variant only with Standard map style.</p> <p>Example: <code>Default</code> </p> <note> <p>Valid values for Variant are case sensitive.</p> </note>

    Raises:
        capo_geo_maps.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_geo_maps.types.get_sprites_request.GetSpritesRequest]",
    ) -> OperationResponse[
        "capo_geo_maps.types.get_sprites_response.GetSpritesResponse"
    ]:
        import capo_geo_maps._operations.maps_service.get_sprites

        output, http_response = (
            capo_geo_maps._operations.maps_service.get_sprites.get_sprites(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetSprites")
    )
    input_: capo_geo_maps.types.get_sprites_request.GetSpritesRequest = {
        "file_name": file_name,
        "style": style,
        "color_scheme": color_scheme,
        "variant": variant,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output