LocationServicePlacesV2Client

Index > LocationServicePlacesV2 > LocationServicePlacesV2Client

Auto-generated documentation for LocationServicePlacesV2 type annotations stubs module mypy-boto3-geo-places.

LocationServicePlacesV2Client

Type annotations and code completion for boto3.client("geo-places"). boto3 documentation

# LocationServicePlacesV2Client usage example

from boto3.session import Session
from mypy_boto3_geo_places.client import LocationServicePlacesV2Client

def get_geo-places_client() -> LocationServicePlacesV2Client:
    return Session().client("geo-places")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("geo-places").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("geo-places")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.InternalServerException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_geo_places.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

autocomplete

The autocomplete operation speeds up and increases the accuracy of entering addresses by providing a list of address candidates matching a partially entered address.

Type annotations and code completion for boto3.client("geo-places").autocomplete method. boto3 documentation

# autocomplete method definition

def autocomplete(
    self,
    *,
    QueryText: str,
    MaxResults: int = ...,
    BiasPosition: Sequence[float] = ...,
    Filter: AutocompleteFilterTypeDef = ...,  # (1)
    PostalCodeMode: PostalCodeModeType = ...,  # (2)
    AdditionalFeatures: Sequence[AutocompleteAdditionalFeatureType] = ...,  # (3)
    Language: str = ...,
    PoliticalView: str = ...,
    IntendedUse: AutocompleteIntendedUseType = ...,  # (4)
    Key: str = ...,
) -> AutocompleteResponseTypeDef:  # (5)
    ...

1. See AutocompleteFilterTypeDef
2. See PostalCodeModeType
3. See AutocompleteAdditionalFeatureType
4. See AutocompleteIntendedUseType
5. See AutocompleteResponseTypeDef

# autocomplete method usage example with argument unpacking

kwargs: AutocompleteRequestRequestTypeDef = {  # (1)
    "QueryText": ...,
}

parent.autocomplete(**kwargs)

1. See AutocompleteRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("geo-places").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("geo-places").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("geo-places").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

geocode

The Geocode action allows you to obtain coordinates, addresses, and other information about places.

Type annotations and code completion for boto3.client("geo-places").geocode method. boto3 documentation

# geocode method definition

def geocode(
    self,
    *,
    QueryText: str = ...,
    QueryComponents: GeocodeQueryComponentsTypeDef = ...,  # (1)
    MaxResults: int = ...,
    BiasPosition: Sequence[float] = ...,
    Filter: GeocodeFilterTypeDef = ...,  # (2)
    AdditionalFeatures: Sequence[GeocodeAdditionalFeatureType] = ...,  # (3)
    Language: str = ...,
    PoliticalView: str = ...,
    IntendedUse: GeocodeIntendedUseType = ...,  # (4)
    Key: str = ...,
) -> GeocodeResponseTypeDef:  # (5)
    ...

1. See GeocodeQueryComponentsTypeDef
2. See GeocodeFilterTypeDef
3. See GeocodeAdditionalFeatureType
4. See GeocodeIntendedUseType
5. See GeocodeResponseTypeDef

# geocode method usage example with argument unpacking

kwargs: GeocodeRequestRequestTypeDef = {  # (1)
    "QueryText": ...,
}

parent.geocode(**kwargs)

1. See GeocodeRequestRequestTypeDef

get_place

Finds a place by its unique ID.

Type annotations and code completion for boto3.client("geo-places").get_place method. boto3 documentation

# get_place method definition

def get_place(
    self,
    *,
    PlaceId: str,
    AdditionalFeatures: Sequence[GetPlaceAdditionalFeatureType] = ...,  # (1)
    Language: str = ...,
    PoliticalView: str = ...,
    IntendedUse: GetPlaceIntendedUseType = ...,  # (2)
    Key: str = ...,
) -> GetPlaceResponseTypeDef:  # (3)
    ...

1. See GetPlaceAdditionalFeatureType
2. See GetPlaceIntendedUseType
3. See GetPlaceResponseTypeDef

# get_place method usage example with argument unpacking

kwargs: GetPlaceRequestRequestTypeDef = {  # (1)
    "PlaceId": ...,
}

parent.get_place(**kwargs)

1. See GetPlaceRequestRequestTypeDef

reverse_geocode

The ReverseGeocode operation allows you to retrieve addresses and place information from coordinates.

Type annotations and code completion for boto3.client("geo-places").reverse_geocode method. boto3 documentation

# reverse_geocode method definition

def reverse_geocode(
    self,
    *,
    QueryPosition: Sequence[float],
    QueryRadius: int = ...,
    MaxResults: int = ...,
    Filter: ReverseGeocodeFilterTypeDef = ...,  # (1)
    AdditionalFeatures: Sequence[ReverseGeocodeAdditionalFeatureType] = ...,  # (2)
    Language: str = ...,
    PoliticalView: str = ...,
    IntendedUse: ReverseGeocodeIntendedUseType = ...,  # (3)
    Key: str = ...,
) -> ReverseGeocodeResponseTypeDef:  # (4)
    ...

1. See ReverseGeocodeFilterTypeDef
2. See ReverseGeocodeAdditionalFeatureType
3. See ReverseGeocodeIntendedUseType
4. See ReverseGeocodeResponseTypeDef

# reverse_geocode method usage example with argument unpacking

kwargs: ReverseGeocodeRequestRequestTypeDef = {  # (1)
    "QueryPosition": ...,
}

parent.reverse_geocode(**kwargs)

1. See ReverseGeocodeRequestRequestTypeDef

search_nearby

Search nearby a specified location.

Type annotations and code completion for boto3.client("geo-places").search_nearby method. boto3 documentation

# search_nearby method definition

def search_nearby(
    self,
    *,
    QueryPosition: Sequence[float],
    QueryRadius: int = ...,
    MaxResults: int = ...,
    Filter: SearchNearbyFilterTypeDef = ...,  # (1)
    AdditionalFeatures: Sequence[SearchNearbyAdditionalFeatureType] = ...,  # (2)
    Language: str = ...,
    PoliticalView: str = ...,
    IntendedUse: SearchNearbyIntendedUseType = ...,  # (3)
    NextToken: str = ...,
    Key: str = ...,
) -> SearchNearbyResponseTypeDef:  # (4)
    ...

1. See SearchNearbyFilterTypeDef
2. See SearchNearbyAdditionalFeatureType
3. See SearchNearbyIntendedUseType
4. See SearchNearbyResponseTypeDef

# search_nearby method usage example with argument unpacking

kwargs: SearchNearbyRequestRequestTypeDef = {  # (1)
    "QueryPosition": ...,
}

parent.search_nearby(**kwargs)

1. See SearchNearbyRequestRequestTypeDef

search_text

Use the SearchText operation to search for geocode and place information.

Type annotations and code completion for boto3.client("geo-places").search_text method. boto3 documentation

# search_text method definition

def search_text(
    self,
    *,
    QueryText: str = ...,
    QueryId: str = ...,
    MaxResults: int = ...,
    BiasPosition: Sequence[float] = ...,
    Filter: SearchTextFilterTypeDef = ...,  # (1)
    AdditionalFeatures: Sequence[SearchTextAdditionalFeatureType] = ...,  # (2)
    Language: str = ...,
    PoliticalView: str = ...,
    IntendedUse: SearchTextIntendedUseType = ...,  # (3)
    NextToken: str = ...,
    Key: str = ...,
) -> SearchTextResponseTypeDef:  # (4)
    ...

1. See SearchTextFilterTypeDef
2. See SearchTextAdditionalFeatureType
3. See SearchTextIntendedUseType
4. See SearchTextResponseTypeDef

# search_text method usage example with argument unpacking

kwargs: SearchTextRequestRequestTypeDef = {  # (1)
    "QueryText": ...,
}

parent.search_text(**kwargs)

1. See SearchTextRequestRequestTypeDef

suggest

The Suggest operation finds addresses or place candidates based on incomplete or misspelled queries.

Type annotations and code completion for boto3.client("geo-places").suggest method. boto3 documentation

# suggest method definition

def suggest(
    self,
    *,
    QueryText: str,
    MaxResults: int = ...,
    MaxQueryRefinements: int = ...,
    BiasPosition: Sequence[float] = ...,
    Filter: SuggestFilterTypeDef = ...,  # (1)
    AdditionalFeatures: Sequence[SuggestAdditionalFeatureType] = ...,  # (2)
    Language: str = ...,
    PoliticalView: str = ...,
    IntendedUse: SuggestIntendedUseType = ...,  # (3)
    Key: str = ...,
) -> SuggestResponseTypeDef:  # (4)
    ...

1. See SuggestFilterTypeDef
2. See SuggestAdditionalFeatureType
3. See SuggestIntendedUseType
4. See SuggestResponseTypeDef

# suggest method usage example with argument unpacking

kwargs: SuggestRequestRequestTypeDef = {  # (1)
    "QueryText": ...,
}

parent.suggest(**kwargs)

1. See SuggestRequestRequestTypeDef