Package software.amazon.awssdk.services.geomaps

Interface GeoMapsAsyncClient

  • All Superinterfaces:
    AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
    @Generated("software.amazon.awssdk:codegen")
@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

    • Method Detail

      • getGlyphs

        default CompletableFuture<GetGlyphsResponse> getGlyphs​(GetGlyphsRequest getGlyphsRequest)

        Returns the map's glyphs.

        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:
        AWS API Documentation

      • getGlyphs

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

        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:
        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:
        AWS API Documentation

      • getSprites

        default CompletableFuture<GetSpritesResponse> getSprites​(GetSpritesRequest getSpritesRequest)

        Returns the map's sprites.

        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:
        AWS API Documentation

      • getSprites

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

        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:
        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:
        AWS API Documentation

      • getStaticMap

        default CompletableFuture<GetStaticMapResponse> getStaticMap​(GetStaticMapRequest getStaticMapRequest)

        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:
        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:
        AWS API Documentation

      • getStaticMap

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

        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:
        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:
        AWS API Documentation

      • getStyleDescriptor

        default CompletableFuture<GetStyleDescriptorResponse> getStyleDescriptor​(GetStyleDescriptorRequest getStyleDescriptorRequest)

        Returns information about the style.

        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:
        AWS API Documentation

      • getStyleDescriptor

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

        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:
        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:
        AWS API Documentation

      • getTile

        default CompletableFuture<GetTileResponse> getTile​(GetTileRequest getTileRequest)

        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:
        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.
        • 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:
        AWS API Documentation

      • getTile

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

        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:
        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.
        • 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:
        AWS API Documentation