GeoMapsClient

Suggest an Edit

Integrate high-quality base map data into your applications using MapLibre . Capabilities include:

  • Access to comprehensive base map data, allowing you to tailor the map display to your specific needs.

  • Multiple pre-designed map styles suited for various application types, such as navigation, logistics, or data visualization.

  • Generation of static map images for scenarios where interactive maps aren't suitable, such as:

    • Embedding in emails or documents

    • Displaying in low-bandwidth environments

    • Creating printable maps

    • Enhancing application performance by reducing client-side rendering

Installation

NPM
npm install @aws-sdk/client-geo-maps
Yarn
yarn add @aws-sdk/client-geo-maps
pnpm
pnpm add @aws-sdk/client-geo-maps

GeoMapsClient Operations

Command
Summary
GetGlyphsCommand

GetGlyphs returns the map's glyphs.

GetSpritesCommand

GetSprites returns the map's sprites.

GetStaticMapCommand

GetStaticMap provides high-quality static map images with customizable options. You can modify the map's appearance and overlay additional information. It's an ideal solution for applications requiring tailored static map snapshots.

GetStyleDescriptorCommand

GetStyleDescriptor returns information about the style.

GetTileCommand

GetTile returns a tile. Map tiles are used by clients to render a map. they're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level.

GeoMapsClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: GeoMapsClientConfig