Interface GeoMapsClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface GeoMapsClient
extends AwsClient

Service client for accessing Amazon Location Service Maps V2. This can be created using the static builder() method.

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static GeoMapsClientBuilder	builder()	Create a builder that can be used to configure and create a GeoMapsClient.
static GeoMapsClient	create()	Create a GeoMapsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default GetGlyphsResponse	getGlyphs(Consumer<GetGlyphsRequest.Builder> getGlyphsRequest)	GetGlyphs returns the map's glyphs.
default GetGlyphsResponse	getGlyphs(GetGlyphsRequest getGlyphsRequest)	GetGlyphs returns the map's glyphs.
default GetSpritesResponse	getSprites(Consumer<GetSpritesRequest.Builder> getSpritesRequest)	GetSprites returns the map's sprites.
default GetSpritesResponse	getSprites(GetSpritesRequest getSpritesRequest)	GetSprites returns the map's sprites.
default GetStaticMapResponse	getStaticMap(Consumer<GetStaticMapRequest.Builder> getStaticMapRequest)	GetStaticMap provides high-quality static map images with customizable options.
default GetStaticMapResponse	getStaticMap(GetStaticMapRequest getStaticMapRequest)	GetStaticMap provides high-quality static map images with customizable options.
default GetStyleDescriptorResponse	getStyleDescriptor(Consumer<GetStyleDescriptorRequest.Builder> getStyleDescriptorRequest)	GetStyleDescriptor returns information about the style.
default GetStyleDescriptorResponse	getStyleDescriptor(GetStyleDescriptorRequest getStyleDescriptorRequest)	GetStyleDescriptor returns information about the style.
default GetTileResponse	getTile(Consumer<GetTileRequest.Builder> getTileRequest)	GetTile returns a tile.
default GetTileResponse	getTile(GetTileRequest getTileRequest)	GetTile returns a tile.
default GeoMapsServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

getGlyphs

default GetGlyphsResponse getGlyphs(GetGlyphsRequest getGlyphsRequest)
                             throws AwsServiceException,
SdkClientException,
GeoMapsException

GetGlyphs returns the map's glyphs.

For more information, see Style labels with glyphs in the Amazon Location Service Developer Guide.

Parameters:

getGlyphsRequest -

Returns:

Result of the GetGlyphs operation returned by the service.

See Also:

• AWS API Documentation

getGlyphs

default GetGlyphsResponse getGlyphs(Consumer<GetGlyphsRequest.Builder> getGlyphsRequest)
                             throws AwsServiceException,
SdkClientException,
GeoMapsException

GetGlyphs returns the map's glyphs.

For more information, see Style labels with glyphs in the Amazon Location Service Developer Guide.

This is a convenience which creates an instance of the GetGlyphsRequest.Builder avoiding the need to create one manually via GetGlyphsRequest.builder()

Parameters:

getGlyphsRequest - A Consumer that will call methods on GetGlyphsRequest.Builder to create a request.

Returns:

Result of the GetGlyphs operation returned by the service.

See Also:

• AWS API Documentation

getSprites

default GetSpritesResponse getSprites(GetSpritesRequest getSpritesRequest)
                               throws AwsServiceException,
SdkClientException,
GeoMapsException

GetSprites returns the map's sprites.

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

Parameters:

getSpritesRequest -

Returns:

Result of the GetSprites operation returned by the service.

See Also:

• AWS API Documentation

getSprites

default GetSpritesResponse getSprites(Consumer<GetSpritesRequest.Builder> getSpritesRequest)
                               throws AwsServiceException,
SdkClientException,
GeoMapsException

GetSprites returns the map's sprites.

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

This is a convenience which creates an instance of the GetSpritesRequest.Builder avoiding the need to create one manually via GetSpritesRequest.builder()

Parameters:

getSpritesRequest - A Consumer that will call methods on GetSpritesRequest.Builder to create a request.

Returns:

Result of the GetSprites operation returned by the service.

See Also:

• AWS API Documentation

getStaticMap

default GetStaticMapResponse getStaticMap(GetStaticMapRequest getStaticMapRequest)
                                   throws InternalServerException,
AccessDeniedException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
GeoMapsException

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.

For more information, see the following topics in the Amazon Location Service Developer Guide:

• Static maps

• Customize static maps

• Overlay on the static map

Parameters:

getStaticMapRequest -

Returns:

Result of the GetStaticMap operation returned by the service.

See Also:

• AWS API Documentation

getStaticMap

default GetStaticMapResponse getStaticMap(Consumer<GetStaticMapRequest.Builder> getStaticMapRequest)
                                   throws InternalServerException,
AccessDeniedException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
GeoMapsException

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.

For more information, see the following topics in the Amazon Location Service Developer Guide:

• Static maps

• Customize static maps

• Overlay on the static map

This is a convenience which creates an instance of the GetStaticMapRequest.Builder avoiding the need to create one manually via GetStaticMapRequest.builder()

Parameters:

getStaticMapRequest - A Consumer that will call methods on GetStaticMapRequest.Builder to create a request.

Returns:

Result of the GetStaticMap operation returned by the service.

See Also:

• AWS API Documentation

getStyleDescriptor

default GetStyleDescriptorResponse getStyleDescriptor(GetStyleDescriptorRequest getStyleDescriptorRequest)
                                               throws AwsServiceException,
SdkClientException,
GeoMapsException

GetStyleDescriptor returns information about the style.

For more information, see Style dynamic maps in the Amazon Location Service Developer Guide.

Parameters:

getStyleDescriptorRequest -

Returns:

Result of the GetStyleDescriptor operation returned by the service.

See Also:

• AWS API Documentation

getStyleDescriptor

default GetStyleDescriptorResponse getStyleDescriptor(Consumer<GetStyleDescriptorRequest.Builder> getStyleDescriptorRequest)
                                               throws AwsServiceException,
SdkClientException,
GeoMapsException

GetStyleDescriptor returns information about the style.

For more information, see Style dynamic maps in the Amazon Location Service Developer Guide.

This is a convenience which creates an instance of the GetStyleDescriptorRequest.Builder avoiding the need to create one manually via GetStyleDescriptorRequest.builder()

Parameters:

getStyleDescriptorRequest - A Consumer that will call methods on GetStyleDescriptorRequest.Builder to create a request.

Returns:

Result of the GetStyleDescriptor operation returned by the service.

See Also:

• AWS API Documentation

getTile

default GetTileResponse getTile(GetTileRequest getTileRequest)
                         throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
GeoMapsException

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.

For more information, see Tiles in the Amazon Location Service Developer Guide.

Parameters:

getTileRequest -

Returns:

Result of the GetTile operation returned by the service.

See Also:

• AWS API Documentation

getTile

default GetTileResponse getTile(Consumer<GetTileRequest.Builder> getTileRequest)
                         throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
GeoMapsException

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.

For more information, see Tiles in the Amazon Location Service Developer Guide.

This is a convenience which creates an instance of the GetTileRequest.Builder avoiding the need to create one manually via GetTileRequest.builder()

Parameters:

getTileRequest - A Consumer that will call methods on GetTileRequest.Builder to create a request.

Returns:

Result of the GetTile operation returned by the service.

See Also:

• AWS API Documentation

create

static GeoMapsClient create()

Create a GeoMapsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static GeoMapsClientBuilder builder()

Create a builder that can be used to configure and create a GeoMapsClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default GeoMapsServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration