AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . location ]

get-map-sprites

Description

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 or the Developer Guide .

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

Synopsis

  get-map-sprites
--map-name <value>
--file-name <value>
[--key <value>]
<outfile>
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--map-name (string)

The map resource associated with the sprite file.

--file-name (string)

The name of the sprite file. Use the following file 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 file names:

  • sprites.json
  • sprites@2x.json for high pixel density displays

--key (string)

The optional API key to authorize the request.

outfile (string) Filename where the content will be saved

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

Blob -> (blob)

Contains the body of the sprite sheet or JSON offset file.

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.