Interface GeoMapsAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @SdkPublicApi @ThreadSafe public interface GeoMapsAsyncClient extends AwsClient
Service client for accessing Amazon Location Service Maps V2 asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

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 Details

  • Method Details

    • getGlyphs

      default CompletableFuture<GetGlyphsResponse> getGlyphs(GetGlyphsRequest getGlyphsRequest)

      GetGlyphs returns the map's glyphs.

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

      Parameters:
      getGlyphsRequest -
      Returns:
      A Java Future containing the result of the GetGlyphs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getGlyphs

      default CompletableFuture<GetGlyphsResponse> getGlyphs(Consumer<GetGlyphsRequest.Builder> getGlyphsRequest)

      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:
      A Java Future containing the result of the GetGlyphs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getSprites

      default CompletableFuture<GetSpritesResponse> getSprites(GetSpritesRequest getSpritesRequest)

      GetSprites returns the map's sprites.

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

      Parameters:
      getSpritesRequest -
      Returns:
      A Java Future containing the result of the GetSprites operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getSprites

      default CompletableFuture<GetSpritesResponse> getSprites(Consumer<GetSpritesRequest.Builder> getSpritesRequest)

      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:
      A Java Future containing the result of the GetSprites operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getStaticMap

      default CompletableFuture<GetStaticMapResponse> getStaticMap(GetStaticMapRequest getStaticMapRequest)

      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:

      Parameters:
      getStaticMapRequest -
      Returns:
      A Java Future containing the result of the GetStaticMap operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getStaticMap

      default CompletableFuture<GetStaticMapResponse> getStaticMap(Consumer<GetStaticMapRequest.Builder> getStaticMapRequest)

      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:


      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:
      A Java Future containing the result of the GetStaticMap operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getStyleDescriptor

      default CompletableFuture<GetStyleDescriptorResponse> getStyleDescriptor(GetStyleDescriptorRequest getStyleDescriptorRequest)

      GetStyleDescriptor returns information about the style.

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

      Parameters:
      getStyleDescriptorRequest -
      Returns:
      A Java Future containing the result of the GetStyleDescriptor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getStyleDescriptor

      default CompletableFuture<GetStyleDescriptorResponse> getStyleDescriptor(Consumer<GetStyleDescriptorRequest.Builder> getStyleDescriptorRequest)

      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:
      A Java Future containing the result of the GetStyleDescriptor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getTile

      default CompletableFuture<GetTileResponse> getTile(GetTileRequest getTileRequest)

      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:
      A Java Future containing the result of the GetTile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException The request processing has failed because of an unknown error, exception or failure.
      • ResourceNotFoundException Exception thrown when the associated resource could not be found.
      • 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.
      See Also:

    • getTile

      default CompletableFuture<GetTileResponse> getTile(Consumer<GetTileRequest.Builder> getTileRequest)

      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:
      A Java Future containing the result of the GetTile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException The request processing has failed because of an unknown error, exception or failure.
      • ResourceNotFoundException Exception thrown when the associated resource could not be found.
      • 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.
      See Also:

    • 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

    • create

      static GeoMapsAsyncClient create()
      Create a GeoMapsAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static GeoMapsAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a GeoMapsAsyncClient.