Skip to content

LocationServiceClient#

Index > LocationService > LocationServiceClient

Auto-generated documentation for LocationService type annotations stubs module mypy-boto3-location.

LocationServiceClient#

Type annotations and code completion for boto3.client("location"). boto3 documentation

# LocationServiceClient usage example

from boto3.session import Session
from mypy_boto3_location.client import LocationServiceClient

def get_location_client() -> LocationServiceClient:
    return Session().client("location")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("location")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_location.client import Exceptions

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

Methods#

associate_tracker_consumer#

Creates an association between a geofence collection and a tracker resource.

Type annotations and code completion for boto3.client("location").associate_tracker_consumer method. boto3 documentation

# associate_tracker_consumer method definition

def associate_tracker_consumer(
    self,
    *,
    ConsumerArn: str,
    TrackerName: str,
) -> Dict[str, Any]:
    ...
# associate_tracker_consumer method usage example with argument unpacking

kwargs: AssociateTrackerConsumerRequestRequestTypeDef = {  # (1)
    "ConsumerArn": ...,
    "TrackerName": ...,
}

parent.associate_tracker_consumer(**kwargs)
  1. See AssociateTrackerConsumerRequestRequestTypeDef

batch_delete_device_position_history#

Deletes the position history of one or more devices from a tracker resource.

Type annotations and code completion for boto3.client("location").batch_delete_device_position_history method. boto3 documentation

# batch_delete_device_position_history method definition

def batch_delete_device_position_history(
    self,
    *,
    DeviceIds: Sequence[str],
    TrackerName: str,
) -> BatchDeleteDevicePositionHistoryResponseTypeDef:  # (1)
    ...
  1. See BatchDeleteDevicePositionHistoryResponseTypeDef
# batch_delete_device_position_history method usage example with argument unpacking

kwargs: BatchDeleteDevicePositionHistoryRequestRequestTypeDef = {  # (1)
    "DeviceIds": ...,
    "TrackerName": ...,
}

parent.batch_delete_device_position_history(**kwargs)
  1. See BatchDeleteDevicePositionHistoryRequestRequestTypeDef

batch_delete_geofence#

Deletes a batch of geofences from a geofence collection.

Type annotations and code completion for boto3.client("location").batch_delete_geofence method. boto3 documentation

# batch_delete_geofence method definition

def batch_delete_geofence(
    self,
    *,
    CollectionName: str,
    GeofenceIds: Sequence[str],
) -> BatchDeleteGeofenceResponseTypeDef:  # (1)
    ...
  1. See BatchDeleteGeofenceResponseTypeDef
# batch_delete_geofence method usage example with argument unpacking

kwargs: BatchDeleteGeofenceRequestRequestTypeDef = {  # (1)
    "CollectionName": ...,
    "GeofenceIds": ...,
}

parent.batch_delete_geofence(**kwargs)
  1. See BatchDeleteGeofenceRequestRequestTypeDef

batch_evaluate_geofences#

Evaluates device positions against the geofence geometries from a given geofence collection.

Type annotations and code completion for boto3.client("location").batch_evaluate_geofences method. boto3 documentation

# batch_evaluate_geofences method definition

def batch_evaluate_geofences(
    self,
    *,
    CollectionName: str,
    DevicePositionUpdates: Sequence[DevicePositionUpdateTypeDef],  # (1)
) -> BatchEvaluateGeofencesResponseTypeDef:  # (2)
    ...
  1. See DevicePositionUpdateTypeDef
  2. See BatchEvaluateGeofencesResponseTypeDef
# batch_evaluate_geofences method usage example with argument unpacking

kwargs: BatchEvaluateGeofencesRequestRequestTypeDef = {  # (1)
    "CollectionName": ...,
    "DevicePositionUpdates": ...,
}

parent.batch_evaluate_geofences(**kwargs)
  1. See BatchEvaluateGeofencesRequestRequestTypeDef

batch_get_device_position#

Lists the latest device positions for requested devices.

Type annotations and code completion for boto3.client("location").batch_get_device_position method. boto3 documentation

# batch_get_device_position method definition

def batch_get_device_position(
    self,
    *,
    DeviceIds: Sequence[str],
    TrackerName: str,
) -> BatchGetDevicePositionResponseTypeDef:  # (1)
    ...
  1. See BatchGetDevicePositionResponseTypeDef
# batch_get_device_position method usage example with argument unpacking

kwargs: BatchGetDevicePositionRequestRequestTypeDef = {  # (1)
    "DeviceIds": ...,
    "TrackerName": ...,
}

parent.batch_get_device_position(**kwargs)
  1. See BatchGetDevicePositionRequestRequestTypeDef

batch_put_geofence#

A batch request for storing geofence geometries into a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.

Type annotations and code completion for boto3.client("location").batch_put_geofence method. boto3 documentation

# batch_put_geofence method definition

def batch_put_geofence(
    self,
    *,
    CollectionName: str,
    Entries: Sequence[BatchPutGeofenceRequestEntryTypeDef],  # (1)
) -> BatchPutGeofenceResponseTypeDef:  # (2)
    ...
  1. See BatchPutGeofenceRequestEntryTypeDef
  2. See BatchPutGeofenceResponseTypeDef
# batch_put_geofence method usage example with argument unpacking

kwargs: BatchPutGeofenceRequestRequestTypeDef = {  # (1)
    "CollectionName": ...,
    "Entries": ...,
}

parent.batch_put_geofence(**kwargs)
  1. See BatchPutGeofenceRequestRequestTypeDef

batch_update_device_position#

Uploads position update data for one or more devices to a tracker resource (up to 10 devices per batch).

Type annotations and code completion for boto3.client("location").batch_update_device_position method. boto3 documentation

# batch_update_device_position method definition

def batch_update_device_position(
    self,
    *,
    TrackerName: str,
    Updates: Sequence[DevicePositionUpdateTypeDef],  # (1)
) -> BatchUpdateDevicePositionResponseTypeDef:  # (2)
    ...
  1. See DevicePositionUpdateTypeDef
  2. See BatchUpdateDevicePositionResponseTypeDef
# batch_update_device_position method usage example with argument unpacking

kwargs: BatchUpdateDevicePositionRequestRequestTypeDef = {  # (1)
    "TrackerName": ...,
    "Updates": ...,
}

parent.batch_update_device_position(**kwargs)
  1. See BatchUpdateDevicePositionRequestRequestTypeDef

calculate_route#

Type annotations and code completion for boto3.client("location").calculate_route method. boto3 documentation

# calculate_route method definition

def calculate_route(
    self,
    *,
    CalculatorName: str,
    DeparturePosition: Sequence[float],
    DestinationPosition: Sequence[float],
    ArrivalTime: Union[datetime, str] = ...,
    CarModeOptions: CalculateRouteCarModeOptionsTypeDef = ...,  # (1)
    DepartNow: bool = ...,
    DepartureTime: Union[datetime, str] = ...,
    DistanceUnit: DistanceUnitType = ...,  # (2)
    IncludeLegGeometry: bool = ...,
    Key: str = ...,
    OptimizeFor: OptimizationModeType = ...,  # (3)
    TravelMode: TravelModeType = ...,  # (4)
    TruckModeOptions: CalculateRouteTruckModeOptionsTypeDef = ...,  # (5)
    WaypointPositions: Sequence[Sequence[float]] = ...,
) -> CalculateRouteResponseTypeDef:  # (6)
    ...
  1. See CalculateRouteCarModeOptionsTypeDef
  2. See DistanceUnitType
  3. See OptimizationModeType
  4. See TravelModeType
  5. See CalculateRouteTruckModeOptionsTypeDef
  6. See CalculateRouteResponseTypeDef
# calculate_route method usage example with argument unpacking

kwargs: CalculateRouteRequestRequestTypeDef = {  # (1)
    "CalculatorName": ...,
    "DeparturePosition": ...,
    "DestinationPosition": ...,
}

parent.calculate_route(**kwargs)
  1. See CalculateRouteRequestRequestTypeDef

calculate_route_matrix#

Type annotations and code completion for boto3.client("location").calculate_route_matrix method. boto3 documentation

# calculate_route_matrix method definition

def calculate_route_matrix(
    self,
    *,
    CalculatorName: str,
    DeparturePositions: Sequence[Sequence[float]],
    DestinationPositions: Sequence[Sequence[float]],
    CarModeOptions: CalculateRouteCarModeOptionsTypeDef = ...,  # (1)
    DepartNow: bool = ...,
    DepartureTime: Union[datetime, str] = ...,
    DistanceUnit: DistanceUnitType = ...,  # (2)
    Key: str = ...,
    TravelMode: TravelModeType = ...,  # (3)
    TruckModeOptions: CalculateRouteTruckModeOptionsTypeDef = ...,  # (4)
) -> CalculateRouteMatrixResponseTypeDef:  # (5)
    ...
  1. See CalculateRouteCarModeOptionsTypeDef
  2. See DistanceUnitType
  3. See TravelModeType
  4. See CalculateRouteTruckModeOptionsTypeDef
  5. See CalculateRouteMatrixResponseTypeDef
# calculate_route_matrix method usage example with argument unpacking

kwargs: CalculateRouteMatrixRequestRequestTypeDef = {  # (1)
    "CalculatorName": ...,
    "DeparturePositions": ...,
    "DestinationPositions": ...,
}

parent.calculate_route_matrix(**kwargs)
  1. See CalculateRouteMatrixRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("location").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("location").close method. boto3 documentation

# close method definition

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

create_geofence_collection#

Creates a geofence collection, which manages and stores geofences.

Type annotations and code completion for boto3.client("location").create_geofence_collection method. boto3 documentation

# create_geofence_collection method definition

def create_geofence_collection(
    self,
    *,
    CollectionName: str,
    Description: str = ...,
    KmsKeyId: str = ...,
    PricingPlan: PricingPlanType = ...,  # (1)
    PricingPlanDataSource: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateGeofenceCollectionResponseTypeDef:  # (2)
    ...
  1. See PricingPlanType
  2. See CreateGeofenceCollectionResponseTypeDef
# create_geofence_collection method usage example with argument unpacking

kwargs: CreateGeofenceCollectionRequestRequestTypeDef = {  # (1)
    "CollectionName": ...,
}

parent.create_geofence_collection(**kwargs)
  1. See CreateGeofenceCollectionRequestRequestTypeDef

create_key#

Creates an API key resource in your Amazon Web Services account, which lets you grant actions for Amazon Location resources to the API key bearer.

Type annotations and code completion for boto3.client("location").create_key method. boto3 documentation

# create_key method definition

def create_key(
    self,
    *,
    KeyName: str,
    Restrictions: ApiKeyRestrictionsTypeDef,  # (1)
    Description: str = ...,
    ExpireTime: Union[datetime, str] = ...,
    NoExpiry: bool = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateKeyResponseTypeDef:  # (2)
    ...
  1. See ApiKeyRestrictionsTypeDef
  2. See CreateKeyResponseTypeDef
# create_key method usage example with argument unpacking

kwargs: CreateKeyRequestRequestTypeDef = {  # (1)
    "KeyName": ...,
    "Restrictions": ...,
}

parent.create_key(**kwargs)
  1. See CreateKeyRequestRequestTypeDef

create_map#

Creates a map resource in your Amazon Web Services account, which provides map tiles of different styles sourced from global location data providers.

Type annotations and code completion for boto3.client("location").create_map method. boto3 documentation

# create_map method definition

def create_map(
    self,
    *,
    Configuration: MapConfigurationTypeDef,  # (1)
    MapName: str,
    Description: str = ...,
    PricingPlan: PricingPlanType = ...,  # (2)
    Tags: Mapping[str, str] = ...,
) -> CreateMapResponseTypeDef:  # (3)
    ...
  1. See MapConfigurationTypeDef
  2. See PricingPlanType
  3. See CreateMapResponseTypeDef
# create_map method usage example with argument unpacking

kwargs: CreateMapRequestRequestTypeDef = {  # (1)
    "Configuration": ...,
    "MapName": ...,
}

parent.create_map(**kwargs)
  1. See CreateMapRequestRequestTypeDef

create_place_index#

Creates a place index resource in your Amazon Web Services account.

Type annotations and code completion for boto3.client("location").create_place_index method. boto3 documentation

# create_place_index method definition

def create_place_index(
    self,
    *,
    DataSource: str,
    IndexName: str,
    DataSourceConfiguration: DataSourceConfigurationTypeDef = ...,  # (1)
    Description: str = ...,
    PricingPlan: PricingPlanType = ...,  # (2)
    Tags: Mapping[str, str] = ...,
) -> CreatePlaceIndexResponseTypeDef:  # (3)
    ...
  1. See DataSourceConfigurationTypeDef
  2. See PricingPlanType
  3. See CreatePlaceIndexResponseTypeDef
# create_place_index method usage example with argument unpacking

kwargs: CreatePlaceIndexRequestRequestTypeDef = {  # (1)
    "DataSource": ...,
    "IndexName": ...,
}

parent.create_place_index(**kwargs)
  1. See CreatePlaceIndexRequestRequestTypeDef

create_route_calculator#

Creates a route calculator resource in your Amazon Web Services account.

Type annotations and code completion for boto3.client("location").create_route_calculator method. boto3 documentation

# create_route_calculator method definition

def create_route_calculator(
    self,
    *,
    CalculatorName: str,
    DataSource: str,
    Description: str = ...,
    PricingPlan: PricingPlanType = ...,  # (1)
    Tags: Mapping[str, str] = ...,
) -> CreateRouteCalculatorResponseTypeDef:  # (2)
    ...
  1. See PricingPlanType
  2. See CreateRouteCalculatorResponseTypeDef
# create_route_calculator method usage example with argument unpacking

kwargs: CreateRouteCalculatorRequestRequestTypeDef = {  # (1)
    "CalculatorName": ...,
    "DataSource": ...,
}

parent.create_route_calculator(**kwargs)
  1. See CreateRouteCalculatorRequestRequestTypeDef

create_tracker#

Creates a tracker resource in your Amazon Web Services account, which lets you retrieve current and historical location of devices.

Type annotations and code completion for boto3.client("location").create_tracker method. boto3 documentation

# create_tracker method definition

def create_tracker(
    self,
    *,
    TrackerName: str,
    Description: str = ...,
    EventBridgeEnabled: bool = ...,
    KmsKeyEnableGeospatialQueries: bool = ...,
    KmsKeyId: str = ...,
    PositionFiltering: PositionFilteringType = ...,  # (1)
    PricingPlan: PricingPlanType = ...,  # (2)
    PricingPlanDataSource: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateTrackerResponseTypeDef:  # (3)
    ...
  1. See PositionFilteringType
  2. See PricingPlanType
  3. See CreateTrackerResponseTypeDef
# create_tracker method usage example with argument unpacking

kwargs: CreateTrackerRequestRequestTypeDef = {  # (1)
    "TrackerName": ...,
}

parent.create_tracker(**kwargs)
  1. See CreateTrackerRequestRequestTypeDef

delete_geofence_collection#

Deletes a geofence collection from your Amazon Web Services account.

Type annotations and code completion for boto3.client("location").delete_geofence_collection method. boto3 documentation

# delete_geofence_collection method definition

def delete_geofence_collection(
    self,
    *,
    CollectionName: str,
) -> Dict[str, Any]:
    ...
# delete_geofence_collection method usage example with argument unpacking

kwargs: DeleteGeofenceCollectionRequestRequestTypeDef = {  # (1)
    "CollectionName": ...,
}

parent.delete_geofence_collection(**kwargs)
  1. See DeleteGeofenceCollectionRequestRequestTypeDef

delete_key#

Deletes the specified API key.

Type annotations and code completion for boto3.client("location").delete_key method. boto3 documentation

# delete_key method definition

def delete_key(
    self,
    *,
    KeyName: str,
    ForceDelete: bool = ...,
) -> Dict[str, Any]:
    ...
# delete_key method usage example with argument unpacking

kwargs: DeleteKeyRequestRequestTypeDef = {  # (1)
    "KeyName": ...,
}

parent.delete_key(**kwargs)
  1. See DeleteKeyRequestRequestTypeDef

delete_map#

Deletes a map resource from your Amazon Web Services account.

Type annotations and code completion for boto3.client("location").delete_map method. boto3 documentation

# delete_map method definition

def delete_map(
    self,
    *,
    MapName: str,
) -> Dict[str, Any]:
    ...
# delete_map method usage example with argument unpacking

kwargs: DeleteMapRequestRequestTypeDef = {  # (1)
    "MapName": ...,
}

parent.delete_map(**kwargs)
  1. See DeleteMapRequestRequestTypeDef

delete_place_index#

Deletes a place index resource from your Amazon Web Services account.

Type annotations and code completion for boto3.client("location").delete_place_index method. boto3 documentation

# delete_place_index method definition

def delete_place_index(
    self,
    *,
    IndexName: str,
) -> Dict[str, Any]:
    ...
# delete_place_index method usage example with argument unpacking

kwargs: DeletePlaceIndexRequestRequestTypeDef = {  # (1)
    "IndexName": ...,
}

parent.delete_place_index(**kwargs)
  1. See DeletePlaceIndexRequestRequestTypeDef

delete_route_calculator#

Deletes a route calculator resource from your Amazon Web Services account.

Type annotations and code completion for boto3.client("location").delete_route_calculator method. boto3 documentation

# delete_route_calculator method definition

def delete_route_calculator(
    self,
    *,
    CalculatorName: str,
) -> Dict[str, Any]:
    ...
# delete_route_calculator method usage example with argument unpacking

kwargs: DeleteRouteCalculatorRequestRequestTypeDef = {  # (1)
    "CalculatorName": ...,
}

parent.delete_route_calculator(**kwargs)
  1. See DeleteRouteCalculatorRequestRequestTypeDef

delete_tracker#

Deletes a tracker resource from your Amazon Web Services account.

Type annotations and code completion for boto3.client("location").delete_tracker method. boto3 documentation

# delete_tracker method definition

def delete_tracker(
    self,
    *,
    TrackerName: str,
) -> Dict[str, Any]:
    ...
# delete_tracker method usage example with argument unpacking

kwargs: DeleteTrackerRequestRequestTypeDef = {  # (1)
    "TrackerName": ...,
}

parent.delete_tracker(**kwargs)
  1. See DeleteTrackerRequestRequestTypeDef

describe_geofence_collection#

Retrieves the geofence collection details.

Type annotations and code completion for boto3.client("location").describe_geofence_collection method. boto3 documentation

# describe_geofence_collection method definition

def describe_geofence_collection(
    self,
    *,
    CollectionName: str,
) -> DescribeGeofenceCollectionResponseTypeDef:  # (1)
    ...
  1. See DescribeGeofenceCollectionResponseTypeDef
# describe_geofence_collection method usage example with argument unpacking

kwargs: DescribeGeofenceCollectionRequestRequestTypeDef = {  # (1)
    "CollectionName": ...,
}

parent.describe_geofence_collection(**kwargs)
  1. See DescribeGeofenceCollectionRequestRequestTypeDef

describe_key#

Retrieves the API key resource details.

Type annotations and code completion for boto3.client("location").describe_key method. boto3 documentation

# describe_key method definition

def describe_key(
    self,
    *,
    KeyName: str,
) -> DescribeKeyResponseTypeDef:  # (1)
    ...
  1. See DescribeKeyResponseTypeDef
# describe_key method usage example with argument unpacking

kwargs: DescribeKeyRequestRequestTypeDef = {  # (1)
    "KeyName": ...,
}

parent.describe_key(**kwargs)
  1. See DescribeKeyRequestRequestTypeDef

describe_map#

Retrieves the map resource details.

Type annotations and code completion for boto3.client("location").describe_map method. boto3 documentation

# describe_map method definition

def describe_map(
    self,
    *,
    MapName: str,
) -> DescribeMapResponseTypeDef:  # (1)
    ...
  1. See DescribeMapResponseTypeDef
# describe_map method usage example with argument unpacking

kwargs: DescribeMapRequestRequestTypeDef = {  # (1)
    "MapName": ...,
}

parent.describe_map(**kwargs)
  1. See DescribeMapRequestRequestTypeDef

describe_place_index#

Retrieves the place index resource details.

Type annotations and code completion for boto3.client("location").describe_place_index method. boto3 documentation

# describe_place_index method definition

def describe_place_index(
    self,
    *,
    IndexName: str,
) -> DescribePlaceIndexResponseTypeDef:  # (1)
    ...
  1. See DescribePlaceIndexResponseTypeDef
# describe_place_index method usage example with argument unpacking

kwargs: DescribePlaceIndexRequestRequestTypeDef = {  # (1)
    "IndexName": ...,
}

parent.describe_place_index(**kwargs)
  1. See DescribePlaceIndexRequestRequestTypeDef

describe_route_calculator#

Retrieves the route calculator resource details.

Type annotations and code completion for boto3.client("location").describe_route_calculator method. boto3 documentation

# describe_route_calculator method definition

def describe_route_calculator(
    self,
    *,
    CalculatorName: str,
) -> DescribeRouteCalculatorResponseTypeDef:  # (1)
    ...
  1. See DescribeRouteCalculatorResponseTypeDef
# describe_route_calculator method usage example with argument unpacking

kwargs: DescribeRouteCalculatorRequestRequestTypeDef = {  # (1)
    "CalculatorName": ...,
}

parent.describe_route_calculator(**kwargs)
  1. See DescribeRouteCalculatorRequestRequestTypeDef

describe_tracker#

Retrieves the tracker resource details.

Type annotations and code completion for boto3.client("location").describe_tracker method. boto3 documentation

# describe_tracker method definition

def describe_tracker(
    self,
    *,
    TrackerName: str,
) -> DescribeTrackerResponseTypeDef:  # (1)
    ...
  1. See DescribeTrackerResponseTypeDef
# describe_tracker method usage example with argument unpacking

kwargs: DescribeTrackerRequestRequestTypeDef = {  # (1)
    "TrackerName": ...,
}

parent.describe_tracker(**kwargs)
  1. See DescribeTrackerRequestRequestTypeDef

disassociate_tracker_consumer#

Removes the association between a tracker resource and a geofence collection.

Type annotations and code completion for boto3.client("location").disassociate_tracker_consumer method. boto3 documentation

# disassociate_tracker_consumer method definition

def disassociate_tracker_consumer(
    self,
    *,
    ConsumerArn: str,
    TrackerName: str,
) -> Dict[str, Any]:
    ...
# disassociate_tracker_consumer method usage example with argument unpacking

kwargs: DisassociateTrackerConsumerRequestRequestTypeDef = {  # (1)
    "ConsumerArn": ...,
    "TrackerName": ...,
}

parent.disassociate_tracker_consumer(**kwargs)
  1. See DisassociateTrackerConsumerRequestRequestTypeDef

generate_presigned_url#

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

Type annotations and code completion for boto3.client("location").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:
    ...

get_device_position#

Retrieves a device's most recent position according to its sample time.

Type annotations and code completion for boto3.client("location").get_device_position method. boto3 documentation

# get_device_position method definition

def get_device_position(
    self,
    *,
    DeviceId: str,
    TrackerName: str,
) -> GetDevicePositionResponseTypeDef:  # (1)
    ...
  1. See GetDevicePositionResponseTypeDef
# get_device_position method usage example with argument unpacking

kwargs: GetDevicePositionRequestRequestTypeDef = {  # (1)
    "DeviceId": ...,
    "TrackerName": ...,
}

parent.get_device_position(**kwargs)
  1. See GetDevicePositionRequestRequestTypeDef

get_device_position_history#

Retrieves the device position history from a tracker resource within a specified range of time.

Type annotations and code completion for boto3.client("location").get_device_position_history method. boto3 documentation

# get_device_position_history method definition

def get_device_position_history(
    self,
    *,
    DeviceId: str,
    TrackerName: str,
    EndTimeExclusive: Union[datetime, str] = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
    StartTimeInclusive: Union[datetime, str] = ...,
) -> GetDevicePositionHistoryResponseTypeDef:  # (1)
    ...
  1. See GetDevicePositionHistoryResponseTypeDef
# get_device_position_history method usage example with argument unpacking

kwargs: GetDevicePositionHistoryRequestRequestTypeDef = {  # (1)
    "DeviceId": ...,
    "TrackerName": ...,
}

parent.get_device_position_history(**kwargs)
  1. See GetDevicePositionHistoryRequestRequestTypeDef

get_geofence#

Retrieves the geofence details from a geofence collection.

Type annotations and code completion for boto3.client("location").get_geofence method. boto3 documentation

# get_geofence method definition

def get_geofence(
    self,
    *,
    CollectionName: str,
    GeofenceId: str,
) -> GetGeofenceResponseTypeDef:  # (1)
    ...
  1. See GetGeofenceResponseTypeDef
# get_geofence method usage example with argument unpacking

kwargs: GetGeofenceRequestRequestTypeDef = {  # (1)
    "CollectionName": ...,
    "GeofenceId": ...,
}

parent.get_geofence(**kwargs)
  1. See GetGeofenceRequestRequestTypeDef

get_map_glyphs#

Retrieves glyphs used to display labels on a map.

Type annotations and code completion for boto3.client("location").get_map_glyphs method. boto3 documentation

# get_map_glyphs method definition

def get_map_glyphs(
    self,
    *,
    FontStack: str,
    FontUnicodeRange: str,
    MapName: str,
    Key: str = ...,
) -> GetMapGlyphsResponseTypeDef:  # (1)
    ...
  1. See GetMapGlyphsResponseTypeDef
# get_map_glyphs method usage example with argument unpacking

kwargs: GetMapGlyphsRequestRequestTypeDef = {  # (1)
    "FontStack": ...,
    "FontUnicodeRange": ...,
    "MapName": ...,
}

parent.get_map_glyphs(**kwargs)
  1. See GetMapGlyphsRequestRequestTypeDef

get_map_sprites#

Retrieves the sprite sheet corresponding to a map resource.

Type annotations and code completion for boto3.client("location").get_map_sprites method. boto3 documentation

# get_map_sprites method definition

def get_map_sprites(
    self,
    *,
    FileName: str,
    MapName: str,
    Key: str = ...,
) -> GetMapSpritesResponseTypeDef:  # (1)
    ...
  1. See GetMapSpritesResponseTypeDef
# get_map_sprites method usage example with argument unpacking

kwargs: GetMapSpritesRequestRequestTypeDef = {  # (1)
    "FileName": ...,
    "MapName": ...,
}

parent.get_map_sprites(**kwargs)
  1. See GetMapSpritesRequestRequestTypeDef

get_map_style_descriptor#

Retrieves the map style descriptor from a map resource.

Type annotations and code completion for boto3.client("location").get_map_style_descriptor method. boto3 documentation

# get_map_style_descriptor method definition

def get_map_style_descriptor(
    self,
    *,
    MapName: str,
    Key: str = ...,
) -> GetMapStyleDescriptorResponseTypeDef:  # (1)
    ...
  1. See GetMapStyleDescriptorResponseTypeDef
# get_map_style_descriptor method usage example with argument unpacking

kwargs: GetMapStyleDescriptorRequestRequestTypeDef = {  # (1)
    "MapName": ...,
}

parent.get_map_style_descriptor(**kwargs)
  1. See GetMapStyleDescriptorRequestRequestTypeDef

get_map_tile#

Retrieves a vector data tile from the map resource.

Type annotations and code completion for boto3.client("location").get_map_tile method. boto3 documentation

# get_map_tile method definition

def get_map_tile(
    self,
    *,
    MapName: str,
    X: str,
    Y: str,
    Z: str,
    Key: str = ...,
) -> GetMapTileResponseTypeDef:  # (1)
    ...
  1. See GetMapTileResponseTypeDef
# get_map_tile method usage example with argument unpacking

kwargs: GetMapTileRequestRequestTypeDef = {  # (1)
    "MapName": ...,
    "X": ...,
    "Y": ...,
    "Z": ...,
}

parent.get_map_tile(**kwargs)
  1. See GetMapTileRequestRequestTypeDef

get_place#

Finds a place by its unique ID.

Type annotations and code completion for boto3.client("location").get_place method. boto3 documentation

# get_place method definition

def get_place(
    self,
    *,
    IndexName: str,
    PlaceId: str,
    Key: str = ...,
    Language: str = ...,
) -> GetPlaceResponseTypeDef:  # (1)
    ...
  1. See GetPlaceResponseTypeDef
# get_place method usage example with argument unpacking

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

parent.get_place(**kwargs)
  1. See GetPlaceRequestRequestTypeDef

list_device_positions#

A batch request to retrieve all device positions.

Type annotations and code completion for boto3.client("location").list_device_positions method. boto3 documentation

# list_device_positions method definition

def list_device_positions(
    self,
    *,
    TrackerName: str,
    FilterGeometry: TrackingFilterGeometryTypeDef = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListDevicePositionsResponseTypeDef:  # (2)
    ...
  1. See TrackingFilterGeometryTypeDef
  2. See ListDevicePositionsResponseTypeDef
# list_device_positions method usage example with argument unpacking

kwargs: ListDevicePositionsRequestRequestTypeDef = {  # (1)
    "TrackerName": ...,
}

parent.list_device_positions(**kwargs)
  1. See ListDevicePositionsRequestRequestTypeDef

list_geofence_collections#

Lists geofence collections in your Amazon Web Services account.

Type annotations and code completion for boto3.client("location").list_geofence_collections method. boto3 documentation

# list_geofence_collections method definition

def list_geofence_collections(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListGeofenceCollectionsResponseTypeDef:  # (1)
    ...
  1. See ListGeofenceCollectionsResponseTypeDef
# list_geofence_collections method usage example with argument unpacking

kwargs: ListGeofenceCollectionsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_geofence_collections(**kwargs)
  1. See ListGeofenceCollectionsRequestRequestTypeDef

list_geofences#

Lists geofences stored in a given geofence collection.

Type annotations and code completion for boto3.client("location").list_geofences method. boto3 documentation

# list_geofences method definition

def list_geofences(
    self,
    *,
    CollectionName: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListGeofencesResponseTypeDef:  # (1)
    ...
  1. See ListGeofencesResponseTypeDef
# list_geofences method usage example with argument unpacking

kwargs: ListGeofencesRequestRequestTypeDef = {  # (1)
    "CollectionName": ...,
}

parent.list_geofences(**kwargs)
  1. See ListGeofencesRequestRequestTypeDef

list_keys#

Lists API key resources in your Amazon Web Services account.

Type annotations and code completion for boto3.client("location").list_keys method. boto3 documentation

# list_keys method definition

def list_keys(
    self,
    *,
    Filter: ApiKeyFilterTypeDef = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListKeysResponseTypeDef:  # (2)
    ...
  1. See ApiKeyFilterTypeDef
  2. See ListKeysResponseTypeDef
# list_keys method usage example with argument unpacking

kwargs: ListKeysRequestRequestTypeDef = {  # (1)
    "Filter": ...,
}

parent.list_keys(**kwargs)
  1. See ListKeysRequestRequestTypeDef

list_maps#

Lists map resources in your Amazon Web Services account.

Type annotations and code completion for boto3.client("location").list_maps method. boto3 documentation

# list_maps method definition

def list_maps(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListMapsResponseTypeDef:  # (1)
    ...
  1. See ListMapsResponseTypeDef
# list_maps method usage example with argument unpacking

kwargs: ListMapsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_maps(**kwargs)
  1. See ListMapsRequestRequestTypeDef

list_place_indexes#

Lists place index resources in your Amazon Web Services account.

Type annotations and code completion for boto3.client("location").list_place_indexes method. boto3 documentation

# list_place_indexes method definition

def list_place_indexes(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListPlaceIndexesResponseTypeDef:  # (1)
    ...
  1. See ListPlaceIndexesResponseTypeDef
# list_place_indexes method usage example with argument unpacking

kwargs: ListPlaceIndexesRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_place_indexes(**kwargs)
  1. See ListPlaceIndexesRequestRequestTypeDef

list_route_calculators#

Lists route calculator resources in your Amazon Web Services account.

Type annotations and code completion for boto3.client("location").list_route_calculators method. boto3 documentation

# list_route_calculators method definition

def list_route_calculators(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListRouteCalculatorsResponseTypeDef:  # (1)
    ...
  1. See ListRouteCalculatorsResponseTypeDef
# list_route_calculators method usage example with argument unpacking

kwargs: ListRouteCalculatorsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_route_calculators(**kwargs)
  1. See ListRouteCalculatorsRequestRequestTypeDef

list_tags_for_resource#

Returns a list of tags that are applied to the specified Amazon Location resource.

Type annotations and code completion for boto3.client("location").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

list_tracker_consumers#

Lists geofence collections currently associated to the given tracker resource.

Type annotations and code completion for boto3.client("location").list_tracker_consumers method. boto3 documentation

# list_tracker_consumers method definition

def list_tracker_consumers(
    self,
    *,
    TrackerName: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListTrackerConsumersResponseTypeDef:  # (1)
    ...
  1. See ListTrackerConsumersResponseTypeDef
# list_tracker_consumers method usage example with argument unpacking

kwargs: ListTrackerConsumersRequestRequestTypeDef = {  # (1)
    "TrackerName": ...,
}

parent.list_tracker_consumers(**kwargs)
  1. See ListTrackerConsumersRequestRequestTypeDef

list_trackers#

Lists tracker resources in your Amazon Web Services account.

Type annotations and code completion for boto3.client("location").list_trackers method. boto3 documentation

# list_trackers method definition

def list_trackers(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListTrackersResponseTypeDef:  # (1)
    ...
  1. See ListTrackersResponseTypeDef
# list_trackers method usage example with argument unpacking

kwargs: ListTrackersRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_trackers(**kwargs)
  1. See ListTrackersRequestRequestTypeDef

put_geofence#

Stores a geofence geometry in a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.

Type annotations and code completion for boto3.client("location").put_geofence method. boto3 documentation

# put_geofence method definition

def put_geofence(
    self,
    *,
    CollectionName: str,
    GeofenceId: str,
    Geometry: GeofenceGeometryTypeDef,  # (1)
    GeofenceProperties: Mapping[str, str] = ...,
) -> PutGeofenceResponseTypeDef:  # (2)
    ...
  1. See GeofenceGeometryTypeDef
  2. See PutGeofenceResponseTypeDef
# put_geofence method usage example with argument unpacking

kwargs: PutGeofenceRequestRequestTypeDef = {  # (1)
    "CollectionName": ...,
    "GeofenceId": ...,
    "Geometry": ...,
}

parent.put_geofence(**kwargs)
  1. See PutGeofenceRequestRequestTypeDef

search_place_index_for_position#

Reverse geocodes a given coordinate and returns a legible address.

Type annotations and code completion for boto3.client("location").search_place_index_for_position method. boto3 documentation

# search_place_index_for_position method definition

def search_place_index_for_position(
    self,
    *,
    IndexName: str,
    Position: Sequence[float],
    Key: str = ...,
    Language: str = ...,
    MaxResults: int = ...,
) -> SearchPlaceIndexForPositionResponseTypeDef:  # (1)
    ...
  1. See SearchPlaceIndexForPositionResponseTypeDef
# search_place_index_for_position method usage example with argument unpacking

kwargs: SearchPlaceIndexForPositionRequestRequestTypeDef = {  # (1)
    "IndexName": ...,
    "Position": ...,
}

parent.search_place_index_for_position(**kwargs)
  1. See SearchPlaceIndexForPositionRequestRequestTypeDef

search_place_index_for_suggestions#

Generates suggestions for addresses and points of interest based on partial or misspelled free-form text.

Type annotations and code completion for boto3.client("location").search_place_index_for_suggestions method. boto3 documentation

# search_place_index_for_suggestions method definition

def search_place_index_for_suggestions(
    self,
    *,
    IndexName: str,
    Text: str,
    BiasPosition: Sequence[float] = ...,
    FilterBBox: Sequence[float] = ...,
    FilterCategories: Sequence[str] = ...,
    FilterCountries: Sequence[str] = ...,
    Key: str = ...,
    Language: str = ...,
    MaxResults: int = ...,
) -> SearchPlaceIndexForSuggestionsResponseTypeDef:  # (1)
    ...
  1. See SearchPlaceIndexForSuggestionsResponseTypeDef
# search_place_index_for_suggestions method usage example with argument unpacking

kwargs: SearchPlaceIndexForSuggestionsRequestRequestTypeDef = {  # (1)
    "IndexName": ...,
    "Text": ...,
}

parent.search_place_index_for_suggestions(**kwargs)
  1. See SearchPlaceIndexForSuggestionsRequestRequestTypeDef

search_place_index_for_text#

Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.

Type annotations and code completion for boto3.client("location").search_place_index_for_text method. boto3 documentation

# search_place_index_for_text method definition

def search_place_index_for_text(
    self,
    *,
    IndexName: str,
    Text: str,
    BiasPosition: Sequence[float] = ...,
    FilterBBox: Sequence[float] = ...,
    FilterCategories: Sequence[str] = ...,
    FilterCountries: Sequence[str] = ...,
    Key: str = ...,
    Language: str = ...,
    MaxResults: int = ...,
) -> SearchPlaceIndexForTextResponseTypeDef:  # (1)
    ...
  1. See SearchPlaceIndexForTextResponseTypeDef
# search_place_index_for_text method usage example with argument unpacking

kwargs: SearchPlaceIndexForTextRequestRequestTypeDef = {  # (1)
    "IndexName": ...,
    "Text": ...,
}

parent.search_place_index_for_text(**kwargs)
  1. See SearchPlaceIndexForTextRequestRequestTypeDef

tag_resource#

Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource.

Type annotations and code completion for boto3.client("location").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource#

Removes one or more tags from the specified Amazon Location resource.

Type annotations and code completion for boto3.client("location").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_geofence_collection#

Updates the specified properties of a given geofence collection.

Type annotations and code completion for boto3.client("location").update_geofence_collection method. boto3 documentation

# update_geofence_collection method definition

def update_geofence_collection(
    self,
    *,
    CollectionName: str,
    Description: str = ...,
    PricingPlan: PricingPlanType = ...,  # (1)
    PricingPlanDataSource: str = ...,
) -> UpdateGeofenceCollectionResponseTypeDef:  # (2)
    ...
  1. See PricingPlanType
  2. See UpdateGeofenceCollectionResponseTypeDef
# update_geofence_collection method usage example with argument unpacking

kwargs: UpdateGeofenceCollectionRequestRequestTypeDef = {  # (1)
    "CollectionName": ...,
}

parent.update_geofence_collection(**kwargs)
  1. See UpdateGeofenceCollectionRequestRequestTypeDef

update_key#

Updates the specified properties of a given API key resource.

Type annotations and code completion for boto3.client("location").update_key method. boto3 documentation

# update_key method definition

def update_key(
    self,
    *,
    KeyName: str,
    Description: str = ...,
    ExpireTime: Union[datetime, str] = ...,
    ForceUpdate: bool = ...,
    NoExpiry: bool = ...,
    Restrictions: ApiKeyRestrictionsTypeDef = ...,  # (1)
) -> UpdateKeyResponseTypeDef:  # (2)
    ...
  1. See ApiKeyRestrictionsTypeDef
  2. See UpdateKeyResponseTypeDef
# update_key method usage example with argument unpacking

kwargs: UpdateKeyRequestRequestTypeDef = {  # (1)
    "KeyName": ...,
}

parent.update_key(**kwargs)
  1. See UpdateKeyRequestRequestTypeDef

update_map#

Updates the specified properties of a given map resource.

Type annotations and code completion for boto3.client("location").update_map method. boto3 documentation

# update_map method definition

def update_map(
    self,
    *,
    MapName: str,
    ConfigurationUpdate: MapConfigurationUpdateTypeDef = ...,  # (1)
    Description: str = ...,
    PricingPlan: PricingPlanType = ...,  # (2)
) -> UpdateMapResponseTypeDef:  # (3)
    ...
  1. See MapConfigurationUpdateTypeDef
  2. See PricingPlanType
  3. See UpdateMapResponseTypeDef
# update_map method usage example with argument unpacking

kwargs: UpdateMapRequestRequestTypeDef = {  # (1)
    "MapName": ...,
}

parent.update_map(**kwargs)
  1. See UpdateMapRequestRequestTypeDef

update_place_index#

Updates the specified properties of a given place index resource.

Type annotations and code completion for boto3.client("location").update_place_index method. boto3 documentation

# update_place_index method definition

def update_place_index(
    self,
    *,
    IndexName: str,
    DataSourceConfiguration: DataSourceConfigurationTypeDef = ...,  # (1)
    Description: str = ...,
    PricingPlan: PricingPlanType = ...,  # (2)
) -> UpdatePlaceIndexResponseTypeDef:  # (3)
    ...
  1. See DataSourceConfigurationTypeDef
  2. See PricingPlanType
  3. See UpdatePlaceIndexResponseTypeDef
# update_place_index method usage example with argument unpacking

kwargs: UpdatePlaceIndexRequestRequestTypeDef = {  # (1)
    "IndexName": ...,
}

parent.update_place_index(**kwargs)
  1. See UpdatePlaceIndexRequestRequestTypeDef

update_route_calculator#

Updates the specified properties for a given route calculator resource.

Type annotations and code completion for boto3.client("location").update_route_calculator method. boto3 documentation

# update_route_calculator method definition

def update_route_calculator(
    self,
    *,
    CalculatorName: str,
    Description: str = ...,
    PricingPlan: PricingPlanType = ...,  # (1)
) -> UpdateRouteCalculatorResponseTypeDef:  # (2)
    ...
  1. See PricingPlanType
  2. See UpdateRouteCalculatorResponseTypeDef
# update_route_calculator method usage example with argument unpacking

kwargs: UpdateRouteCalculatorRequestRequestTypeDef = {  # (1)
    "CalculatorName": ...,
}

parent.update_route_calculator(**kwargs)
  1. See UpdateRouteCalculatorRequestRequestTypeDef

update_tracker#

Updates the specified properties of a given tracker resource.

Type annotations and code completion for boto3.client("location").update_tracker method. boto3 documentation

# update_tracker method definition

def update_tracker(
    self,
    *,
    TrackerName: str,
    Description: str = ...,
    EventBridgeEnabled: bool = ...,
    KmsKeyEnableGeospatialQueries: bool = ...,
    PositionFiltering: PositionFilteringType = ...,  # (1)
    PricingPlan: PricingPlanType = ...,  # (2)
    PricingPlanDataSource: str = ...,
) -> UpdateTrackerResponseTypeDef:  # (3)
    ...
  1. See PositionFilteringType
  2. See PricingPlanType
  3. See UpdateTrackerResponseTypeDef
# update_tracker method usage example with argument unpacking

kwargs: UpdateTrackerRequestRequestTypeDef = {  # (1)
    "TrackerName": ...,
}

parent.update_tracker(**kwargs)
  1. See UpdateTrackerRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("location").get_paginator method with overloads.