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

can_paginate

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:
    ...

generate_presigned_url

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:
    ...

autocomplete

Autocomplete completes potential places and addresses as the user types, based on the partial input.

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 Sequence[Literal['Core']]
4. See AutocompleteIntendedUseType
5. See AutocompleteResponseTypeDef

# autocomplete method usage example with argument unpacking

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

parent.autocomplete(**kwargs)

1. See AutocompleteRequestTypeDef

geocode

Geocode converts a textual address or place into geographic coordinates.

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 Sequence[GeocodeAdditionalFeatureType]
4. See GeocodeIntendedUseType
5. See GeocodeResponseTypeDef

# geocode method usage example with argument unpacking

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

parent.geocode(**kwargs)

1. See GeocodeRequestTypeDef

get_place

GetPlace 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 Sequence[GetPlaceAdditionalFeatureType]
2. See GetPlaceIntendedUseType
3. See GetPlaceResponseTypeDef

# get_place method usage example with argument unpacking

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

parent.get_place(**kwargs)

1. See GetPlaceRequestTypeDef

reverse_geocode

ReverseGeocode converts geographic coordinates into a human-readable address or place.

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 Sequence[ReverseGeocodeAdditionalFeatureType]
3. See ReverseGeocodeIntendedUseType
4. See ReverseGeocodeResponseTypeDef

# reverse_geocode method usage example with argument unpacking

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

parent.reverse_geocode(**kwargs)

1. See ReverseGeocodeRequestTypeDef

search_nearby

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.

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 Sequence[SearchNearbyAdditionalFeatureType]
3. See SearchNearbyIntendedUseType
4. See SearchNearbyResponseTypeDef

# search_nearby method usage example with argument unpacking

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

parent.search_nearby(**kwargs)

1. See SearchNearbyRequestTypeDef

search_text

SearchText searches 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 Sequence[SearchTextAdditionalFeatureType]
3. See SearchTextIntendedUseType
4. See SearchTextResponseTypeDef

# search_text method usage example with argument unpacking

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

parent.search_text(**kwargs)

1. See SearchTextRequestTypeDef

suggest

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.

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 Sequence[SuggestAdditionalFeatureType]
3. See SuggestIntendedUseType
4. See SuggestResponseTypeDef

# suggest method usage example with argument unpacking

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

parent.suggest(**kwargs)

1. See SuggestRequestTypeDef