Interface GeoPlacesClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

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

The Places API enables powerful location search and geocoding capabilities for your applications, offering global coverage with rich, detailed information. Key features include:

• Forward and reverse geocoding for addresses and coordinates. See Geocode and ReverseGeocode.

• Comprehensive place searches with detailed information. See SearchText, SearchNearby, and GetPlace. Place information you can find include:

  • Business names and addresses

  • Contact information

  • Hours of operation

  • Points of Interest (POI) categories

  • Food types for restaurants

  • Chain affiliation for relevant businesses

• Address and place completion as users type, enhancing input efficiency by completing partial queries with valid addresses. See Autocomplete.

• Intelligent place and query recommendation based on user's input or context, returning relevant places, points of interest, query terms, or search categories. See Suggest.

• Global data coverage with a wide range of POI categories.

• Regular data updates to ensure accuracy and relevance.

• Bulk address validation for verifying and standardizing large volumes of addresses in a single operation using Amazon Location Service Jobs.

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
default AutocompleteResponse	autocomplete(Consumer<AutocompleteRequest.Builder> autocompleteRequest)	Autocomplete completes potential places and addresses as the user types, based on the partial input.
default AutocompleteResponse	autocomplete(AutocompleteRequest autocompleteRequest)	Autocomplete completes potential places and addresses as the user types, based on the partial input.
static GeoPlacesClientBuilder	builder()	Create a builder that can be used to configure and create a GeoPlacesClient.
static GeoPlacesClient	create()	Create a GeoPlacesClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default GeocodeResponse	geocode(Consumer<GeocodeRequest.Builder> geocodeRequest)	Geocode converts a textual address or place into geographic coordinates.
default GeocodeResponse	geocode(GeocodeRequest geocodeRequest)	Geocode converts a textual address or place into geographic coordinates.
default GetPlaceResponse	getPlace(Consumer<GetPlaceRequest.Builder> getPlaceRequest)	GetPlace finds a place by its unique ID.
default GetPlaceResponse	getPlace(GetPlaceRequest getPlaceRequest)	GetPlace finds a place by its unique ID.
default ReverseGeocodeResponse	reverseGeocode(Consumer<ReverseGeocodeRequest.Builder> reverseGeocodeRequest)	ReverseGeocode converts geographic coordinates into a human-readable address or place.
default ReverseGeocodeResponse	reverseGeocode(ReverseGeocodeRequest reverseGeocodeRequest)	ReverseGeocode converts geographic coordinates into a human-readable address or place.
default SearchNearbyResponse	searchNearby(Consumer<SearchNearbyRequest.Builder> searchNearbyRequest)	SearchNearby queries for points of interest within a radius from a central coordinates, returning place results with optional filters such as categories, business chains, food types and more.
default SearchNearbyResponse	searchNearby(SearchNearbyRequest searchNearbyRequest)	SearchNearby queries for points of interest within a radius from a central coordinates, returning place results with optional filters such as categories, business chains, food types and more.
default SearchTextResponse	searchText(Consumer<SearchTextRequest.Builder> searchTextRequest)	SearchText searches for geocode and place information.
default SearchTextResponse	searchText(SearchTextRequest searchTextRequest)	SearchText searches for geocode and place information.
default GeoPlacesServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default SuggestResponse	suggest(Consumer<SuggestRequest.Builder> suggestRequest)	Suggest provides intelligent predictions or recommendations based on the user's input or context, such as relevant places, points of interest, query terms or search category.
default SuggestResponse	suggest(SuggestRequest suggestRequest)	Suggest provides intelligent predictions or recommendations based on the user's input or context, such as relevant places, points of interest, query terms or search category.

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

autocomplete

default AutocompleteResponse autocomplete(AutocompleteRequest autocompleteRequest)
                                   throws InternalServerException,
AccessDeniedException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
GeoPlacesException

Autocomplete completes potential places and addresses as the user types, based on the partial input. The API enhances the efficiency and accuracy of address by completing query based on a few entered keystrokes. It helps you by completing partial queries with valid address completion. Also, the API supports the filtering of results based on geographic location, country, or specific place types, and can be tailored using optional parameters like language and political views. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

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

Parameters:

autocompleteRequest -

Returns:

Result of the Autocomplete operation returned by the service.

See Also:

• AWS API Documentation

autocomplete

default AutocompleteResponse autocomplete(Consumer<AutocompleteRequest.Builder> autocompleteRequest)
                                   throws InternalServerException,
AccessDeniedException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
GeoPlacesException

Autocomplete completes potential places and addresses as the user types, based on the partial input. The API enhances the efficiency and accuracy of address by completing query based on a few entered keystrokes. It helps you by completing partial queries with valid address completion. Also, the API supports the filtering of results based on geographic location, country, or specific place types, and can be tailored using optional parameters like language and political views. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

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

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

Parameters:

autocompleteRequest - A Consumer that will call methods on AutocompleteRequest.Builder to create a request.

Returns:

Result of the Autocomplete operation returned by the service.

See Also:

• AWS API Documentation

geocode

default GeocodeResponse geocode(GeocodeRequest geocodeRequest)
                         throws InternalServerException,
AccessDeniedException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
GeoPlacesException

Geocode converts a textual address or place into geographic coordinates. You can obtain geographic coordinates, address component, and other related information. It supports flexible queries, including free-form text or structured queries with components like street names, postal codes, and regions. The Geocode API can also provide additional features such as time zone information and the inclusion of political views. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

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

Parameters:

geocodeRequest -

Returns:

Result of the Geocode operation returned by the service.

See Also:

• AWS API Documentation

geocode

default GeocodeResponse geocode(Consumer<GeocodeRequest.Builder> geocodeRequest)
                         throws InternalServerException,
AccessDeniedException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
GeoPlacesException

Geocode converts a textual address or place into geographic coordinates. You can obtain geographic coordinates, address component, and other related information. It supports flexible queries, including free-form text or structured queries with components like street names, postal codes, and regions. The Geocode API can also provide additional features such as time zone information and the inclusion of political views. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

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

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

Parameters:

geocodeRequest - A Consumer that will call methods on GeocodeRequest.Builder to create a request.

Returns:

Result of the Geocode operation returned by the service.

See Also:

• AWS API Documentation

getPlace

default GetPlaceResponse getPlace(GetPlaceRequest getPlaceRequest)
                           throws InternalServerException,
AccessDeniedException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
GeoPlacesException

GetPlace finds a place by its unique ID. A PlaceId is returned by other place operations.

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

Parameters:

getPlaceRequest -

Returns:

Result of the GetPlace operation returned by the service.

See Also:

• AWS API Documentation

getPlace

default GetPlaceResponse getPlace(Consumer<GetPlaceRequest.Builder> getPlaceRequest)
                           throws InternalServerException,
AccessDeniedException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
GeoPlacesException

GetPlace finds a place by its unique ID. A PlaceId is returned by other place operations.

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

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

Parameters:

getPlaceRequest - A Consumer that will call methods on GetPlaceRequest.Builder to create a request.

Returns:

Result of the GetPlace operation returned by the service.

See Also:

• AWS API Documentation

reverseGeocode

default ReverseGeocodeResponse reverseGeocode(ReverseGeocodeRequest reverseGeocodeRequest)
                                       throws InternalServerException,
AccessDeniedException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
GeoPlacesException

ReverseGeocode converts geographic coordinates into a human-readable address or place. You can obtain address component, and other related information such as place type, category, street information. The Reverse Geocode API supports filtering to on place type so that you can refine result based on your need. Also, The Reverse Geocode API can also provide additional features such as time zone information and the inclusion of political views.

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

Parameters:

reverseGeocodeRequest -

Returns:

Result of the ReverseGeocode operation returned by the service.

See Also:

• AWS API Documentation
• Code Example

reverseGeocode

default ReverseGeocodeResponse reverseGeocode(Consumer<ReverseGeocodeRequest.Builder> reverseGeocodeRequest)
                                       throws InternalServerException,
AccessDeniedException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
GeoPlacesException

ReverseGeocode converts geographic coordinates into a human-readable address or place. You can obtain address component, and other related information such as place type, category, street information. The Reverse Geocode API supports filtering to on place type so that you can refine result based on your need. Also, The Reverse Geocode API can also provide additional features such as time zone information and the inclusion of political views.

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

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

Parameters:

reverseGeocodeRequest - A Consumer that will call methods on ReverseGeocodeRequest.Builder to create a request.

Returns:

Result of the ReverseGeocode operation returned by the service.

See Also:

• AWS API Documentation
• Code Example

searchNearby

default SearchNearbyResponse searchNearby(SearchNearbyRequest searchNearbyRequest)
                                   throws InternalServerException,
AccessDeniedException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
GeoPlacesException

SearchNearby queries for points of interest within a radius from a central coordinates, returning place results with optional filters such as categories, business chains, food types and more. The API returns details such as a place name, address, phone, category, food type, contact, opening hours. Also, the API can return phonemes, time zones and more based on requested parameters. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

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

Parameters:

searchNearbyRequest -

Returns:

Result of the SearchNearby operation returned by the service.

See Also:

• AWS API Documentation
• Code Example

searchNearby

default SearchNearbyResponse searchNearby(Consumer<SearchNearbyRequest.Builder> searchNearbyRequest)
                                   throws InternalServerException,
AccessDeniedException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
GeoPlacesException

SearchNearby queries for points of interest within a radius from a central coordinates, returning place results with optional filters such as categories, business chains, food types and more. The API returns details such as a place name, address, phone, category, food type, contact, opening hours. Also, the API can return phonemes, time zones and more based on requested parameters. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

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

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

Parameters:

searchNearbyRequest - A Consumer that will call methods on SearchNearbyRequest.Builder to create a request.

Returns:

Result of the SearchNearby operation returned by the service.

See Also:

• AWS API Documentation
• Code Example

searchText

default SearchTextResponse searchText(SearchTextRequest searchTextRequest)
                               throws InternalServerException,
AccessDeniedException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
GeoPlacesException

SearchText searches for geocode and place information. You can then complete a follow-up query suggested from the Suggest API via a query id.

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

Parameters:

searchTextRequest -

Returns:

Result of the SearchText operation returned by the service.

See Also:

• AWS API Documentation
• Code Example

searchText

default SearchTextResponse searchText(Consumer<SearchTextRequest.Builder> searchTextRequest)
                               throws InternalServerException,
AccessDeniedException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
GeoPlacesException

SearchText searches for geocode and place information. You can then complete a follow-up query suggested from the Suggest API via a query id.

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

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

Parameters:

searchTextRequest - A Consumer that will call methods on SearchTextRequest.Builder to create a request.

Returns:

Result of the SearchText operation returned by the service.

See Also:

• AWS API Documentation
• Code Example

suggest

default SuggestResponse suggest(SuggestRequest suggestRequest)
                         throws InternalServerException,
AccessDeniedException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
GeoPlacesException

Suggest provides intelligent predictions or recommendations based on the user's input or context, such as relevant places, points of interest, query terms or search category. It is designed to help users find places or point of interests candidates or identify a follow on query based on incomplete or misspelled queries. It returns a list of possible matches or refinements that can be used to formulate a more accurate query. Users can select the most appropriate suggestion and use it for further searching. The API provides options for filtering results by location and other attributes, and allows for additional features like phonemes and timezones. The response includes refined query terms and detailed place information.

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

Parameters:

suggestRequest -

Returns:

Result of the Suggest operation returned by the service.

See Also:

• AWS API Documentation

suggest

default SuggestResponse suggest(Consumer<SuggestRequest.Builder> suggestRequest)
                         throws InternalServerException,
AccessDeniedException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
GeoPlacesException

Suggest provides intelligent predictions or recommendations based on the user's input or context, such as relevant places, points of interest, query terms or search category. It is designed to help users find places or point of interests candidates or identify a follow on query based on incomplete or misspelled queries. It returns a list of possible matches or refinements that can be used to formulate a more accurate query. Users can select the most appropriate suggestion and use it for further searching. The API provides options for filtering results by location and other attributes, and allows for additional features like phonemes and timezones. The response includes refined query terms and detailed place information.

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

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

Parameters:

suggestRequest - A Consumer that will call methods on SuggestRequest.Builder to create a request.

Returns:

Result of the Suggest operation returned by the service.

See Also:

• AWS API Documentation

create

static GeoPlacesClient create()

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

builder

static GeoPlacesClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default GeoPlacesServiceClientConfiguration 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