Package software.amazon.awssdk.services.geomaps

Interface GeoMapsClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@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 String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static 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)	Returns the map's glyphs.
default GetGlyphsResponse	getGlyphs(GetGlyphsRequest getGlyphsRequest)	Returns the map's glyphs.
default GetSpritesResponse	getSprites(Consumer<GetSpritesRequest.Builder> getSpritesRequest)	Returns the map's sprites.
default GetSpritesResponse	getSprites(GetSpritesRequest getSpritesRequest)	Returns the map's sprites.
default GetStaticMapResponse	getStaticMap(Consumer<GetStaticMapRequest.Builder> getStaticMapRequest)	Provides high-quality static map images with customizable options.
default GetStaticMapResponse	getStaticMap(GetStaticMapRequest getStaticMapRequest)	Provides high-quality static map images with customizable options.
default GetStyleDescriptorResponse	getStyleDescriptor(Consumer<GetStyleDescriptorRequest.Builder> getStyleDescriptorRequest)	Returns information about the style.
default GetStyleDescriptorResponse	getStyleDescriptor(GetStyleDescriptorRequest getStyleDescriptorRequest)	Returns information about the style.
default GetTileResponse	getTile(Consumer<GetTileRequest.Builder> getTileRequest)	Returns a tile.
default GetTileResponse	getTile(GetTileRequest getTileRequest)	Returns a tile.
default GeoMapsServiceClientConfiguration	serviceClientConfiguration()
static ServiceMetadata	serviceMetadata()

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

close

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

serviceName

Field Detail

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 Detail

getGlyphs

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

Returns the map's glyphs.

Parameters:

getGlyphsRequest -

Returns:

Result of the GetGlyphs operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

GeoMapsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getGlyphs

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

Returns the map's glyphs.

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.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

GeoMapsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getSprites

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

Returns the map's sprites.

Parameters:

getSpritesRequest -

Returns:

Result of the GetSprites operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

GeoMapsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getSprites

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

Returns the map's sprites.

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.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

GeoMapsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getStaticMap

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

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.

Parameters:

getStaticMapRequest -

Returns:

Result of the GetStaticMap operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

AccessDeniedException - The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException - The request was denied due to request throttling.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

GeoMapsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getStaticMap

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

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.

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.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

AccessDeniedException - The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException - The request was denied due to request throttling.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

GeoMapsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getStyleDescriptor

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

Returns information about the style.

Parameters:

getStyleDescriptorRequest -

Returns:

Result of the GetStyleDescriptor operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

GeoMapsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getStyleDescriptor

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

Returns information about the style.

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.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

GeoMapsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getTile

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

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.

Parameters:

getTileRequest -

Returns:

Result of the GetTile operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

AccessDeniedException - The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException - The request was denied due to request throttling.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

GeoMapsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getTile

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

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.

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.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

AccessDeniedException - The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException - The request was denied due to request throttling.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

GeoMapsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

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()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient