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 . geo-maps ]

get-sprites

Description

GetSprites returns the map’s sprites.

See also: AWS API Documentation

Synopsis

  get-sprites
--file-name <value>
--style <value>
--color-scheme <value>
--variant <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

--file-name (string)

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

Example: sprites.png

--style (string)

Style specifies the desired map style for the Sprites APIs.

Possible values:

• Standard
• Monochrome
• Hybrid
• Satellite

--color-scheme (string)

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.

Possible values:

• Light
• Dark

--variant (string)

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.

Possible values:

• Default

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)

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.