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
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.
client = boto3.client("location")
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.ConflictException,
client.InternalServerException,
client.ResourceNotFoundException,
client.ServiceQuotaExceededException,
client.ThrottlingException,
client.ValidationException,
) as e:
print(e)
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
def associate_tracker_consumer(
self,
*,
ConsumerArn: str,
TrackerName: str,
) -> Dict[str, Any]:
...
kwargs: AssociateTrackerConsumerRequestRequestTypeDef = { # (1)
"ConsumerArn": ...,
"TrackerName": ...,
}
parent.associate_tracker_consumer(**kwargs)
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
def batch_delete_device_position_history(
self,
*,
DeviceIds: Sequence[str],
TrackerName: str,
) -> BatchDeleteDevicePositionHistoryResponseTypeDef: # (1)
...
kwargs: BatchDeleteDevicePositionHistoryRequestRequestTypeDef = { # (1)
"DeviceIds": ...,
"TrackerName": ...,
}
parent.batch_delete_device_position_history(**kwargs)
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
def batch_delete_geofence(
self,
*,
CollectionName: str,
GeofenceIds: Sequence[str],
) -> BatchDeleteGeofenceResponseTypeDef: # (1)
...
kwargs: BatchDeleteGeofenceRequestRequestTypeDef = { # (1)
"CollectionName": ...,
"GeofenceIds": ...,
}
parent.batch_delete_geofence(**kwargs)
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
def batch_evaluate_geofences(
self,
*,
CollectionName: str,
DevicePositionUpdates: Sequence[DevicePositionUpdateTypeDef], # (1)
) -> BatchEvaluateGeofencesResponseTypeDef: # (2)
...
kwargs: BatchEvaluateGeofencesRequestRequestTypeDef = { # (1)
"CollectionName": ...,
"DevicePositionUpdates": ...,
}
parent.batch_evaluate_geofences(**kwargs)
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
def batch_get_device_position(
self,
*,
DeviceIds: Sequence[str],
TrackerName: str,
) -> BatchGetDevicePositionResponseTypeDef: # (1)
...
kwargs: BatchGetDevicePositionRequestRequestTypeDef = { # (1)
"DeviceIds": ...,
"TrackerName": ...,
}
parent.batch_get_device_position(**kwargs)
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
def batch_put_geofence(
self,
*,
CollectionName: str,
Entries: Sequence[BatchPutGeofenceRequestEntryTypeDef], # (1)
) -> BatchPutGeofenceResponseTypeDef: # (2)
...
kwargs: BatchPutGeofenceRequestRequestTypeDef = { # (1)
"CollectionName": ...,
"Entries": ...,
}
parent.batch_put_geofence(**kwargs)
batch_update_device_position
Uploads position update data for one or more devices to a tracker resource.
Type annotations and code completion for boto3.client("location").batch_update_device_position
method.
boto3 documentation
def batch_update_device_position(
self,
*,
TrackerName: str,
Updates: Sequence[DevicePositionUpdateTypeDef], # (1)
) -> BatchUpdateDevicePositionResponseTypeDef: # (2)
...
kwargs: BatchUpdateDevicePositionRequestRequestTypeDef = { # (1)
"TrackerName": ...,
"Updates": ...,
}
parent.batch_update_device_position(**kwargs)
calculate_route
Type annotations and code completion for boto3.client("location").calculate_route
method.
boto3 documentation
def calculate_route(
self,
*,
CalculatorName: str,
DeparturePosition: Sequence[float],
DestinationPosition: Sequence[float],
CarModeOptions: CalculateRouteCarModeOptionsTypeDef = ..., # (1)
DepartNow: bool = ...,
DepartureTime: Union[datetime, str] = ...,
DistanceUnit: DistanceUnitType = ..., # (2)
IncludeLegGeometry: bool = ...,
TravelMode: TravelModeType = ..., # (3)
TruckModeOptions: CalculateRouteTruckModeOptionsTypeDef = ..., # (4)
WaypointPositions: Sequence[Sequence[float]] = ...,
) -> CalculateRouteResponseTypeDef: # (5)
...
- See CalculateRouteCarModeOptionsTypeDef
- See DistanceUnitType
- See TravelModeType
- See CalculateRouteTruckModeOptionsTypeDef
- See CalculateRouteResponseTypeDef
kwargs: CalculateRouteRequestRequestTypeDef = { # (1)
"CalculatorName": ...,
"DeparturePosition": ...,
"DestinationPosition": ...,
}
parent.calculate_route(**kwargs)
calculate_route_matrix
Type annotations and code completion for boto3.client("location").calculate_route_matrix
method.
boto3 documentation
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)
TravelMode: TravelModeType = ..., # (3)
TruckModeOptions: CalculateRouteTruckModeOptionsTypeDef = ..., # (4)
) -> CalculateRouteMatrixResponseTypeDef: # (5)
...
- See CalculateRouteCarModeOptionsTypeDef
- See DistanceUnitType
- See TravelModeType
- See CalculateRouteTruckModeOptionsTypeDef
- See CalculateRouteMatrixResponseTypeDef
kwargs: CalculateRouteMatrixRequestRequestTypeDef = { # (1)
"CalculatorName": ...,
"DeparturePositions": ...,
"DestinationPositions": ...,
}
parent.calculate_route_matrix(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("location").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("location").close
method.
boto3 documentation
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
def create_geofence_collection(
self,
*,
CollectionName: str,
Description: str = ...,
KmsKeyId: str = ...,
PricingPlan: PricingPlanType = ..., # (1)
PricingPlanDataSource: str = ...,
Tags: Mapping[str, str] = ...,
) -> CreateGeofenceCollectionResponseTypeDef: # (2)
...
kwargs: CreateGeofenceCollectionRequestRequestTypeDef = { # (1)
"CollectionName": ...,
}
parent.create_geofence_collection(**kwargs)
create_key
Creates an API key resource in your Amazon Web Services account, which lets you
grant geo:GetMap*
actions for Amazon Location Map resources to the API key
bearer.
Type annotations and code completion for boto3.client("location").create_key
method.
boto3 documentation
def create_key(
self,
*,
KeyName: str,
Restrictions: ApiKeyRestrictionsTypeDef, # (1)
Description: str = ...,
ExpireTime: Union[datetime, str] = ...,
NoExpiry: bool = ...,
Tags: Mapping[str, str] = ...,
) -> CreateKeyResponseTypeDef: # (2)
...
kwargs: CreateKeyRequestRequestTypeDef = { # (1)
"KeyName": ...,
"Restrictions": ...,
}
parent.create_key(**kwargs)
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
def create_map(
self,
*,
Configuration: MapConfigurationTypeDef, # (1)
MapName: str,
Description: str = ...,
PricingPlan: PricingPlanType = ..., # (2)
Tags: Mapping[str, str] = ...,
) -> CreateMapResponseTypeDef: # (3)
...
kwargs: CreateMapRequestRequestTypeDef = { # (1)
"Configuration": ...,
"MapName": ...,
}
parent.create_map(**kwargs)
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
def create_place_index(
self,
*,
DataSource: str,
IndexName: str,
DataSourceConfiguration: DataSourceConfigurationTypeDef = ..., # (1)
Description: str = ...,
PricingPlan: PricingPlanType = ..., # (2)
Tags: Mapping[str, str] = ...,
) -> CreatePlaceIndexResponseTypeDef: # (3)
...
kwargs: CreatePlaceIndexRequestRequestTypeDef = { # (1)
"DataSource": ...,
"IndexName": ...,
}
parent.create_place_index(**kwargs)
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
def create_route_calculator(
self,
*,
CalculatorName: str,
DataSource: str,
Description: str = ...,
PricingPlan: PricingPlanType = ..., # (1)
Tags: Mapping[str, str] = ...,
) -> CreateRouteCalculatorResponseTypeDef: # (2)
...
kwargs: CreateRouteCalculatorRequestRequestTypeDef = { # (1)
"CalculatorName": ...,
"DataSource": ...,
}
parent.create_route_calculator(**kwargs)
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
def create_tracker(
self,
*,
TrackerName: str,
Description: str = ...,
KmsKeyId: str = ...,
PositionFiltering: PositionFilteringType = ..., # (1)
PricingPlan: PricingPlanType = ..., # (2)
PricingPlanDataSource: str = ...,
Tags: Mapping[str, str] = ...,
) -> CreateTrackerResponseTypeDef: # (3)
...
kwargs: CreateTrackerRequestRequestTypeDef = { # (1)
"TrackerName": ...,
}
parent.create_tracker(**kwargs)
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
def delete_geofence_collection(
self,
*,
CollectionName: str,
) -> Dict[str, Any]:
...
kwargs: DeleteGeofenceCollectionRequestRequestTypeDef = { # (1)
"CollectionName": ...,
}
parent.delete_geofence_collection(**kwargs)
delete_key
Deletes the specified API key.
Type annotations and code completion for boto3.client("location").delete_key
method.
boto3 documentation
kwargs: DeleteKeyRequestRequestTypeDef = { # (1)
"KeyName": ...,
}
parent.delete_key(**kwargs)
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
kwargs: DeleteMapRequestRequestTypeDef = { # (1)
"MapName": ...,
}
parent.delete_map(**kwargs)
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
kwargs: DeletePlaceIndexRequestRequestTypeDef = { # (1)
"IndexName": ...,
}
parent.delete_place_index(**kwargs)
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
def delete_route_calculator(
self,
*,
CalculatorName: str,
) -> Dict[str, Any]:
...
kwargs: DeleteRouteCalculatorRequestRequestTypeDef = { # (1)
"CalculatorName": ...,
}
parent.delete_route_calculator(**kwargs)
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
kwargs: DeleteTrackerRequestRequestTypeDef = { # (1)
"TrackerName": ...,
}
parent.delete_tracker(**kwargs)
describe_geofence_collection
Retrieves the geofence collection details.
Type annotations and code completion for boto3.client("location").describe_geofence_collection
method.
boto3 documentation
def describe_geofence_collection(
self,
*,
CollectionName: str,
) -> DescribeGeofenceCollectionResponseTypeDef: # (1)
...
kwargs: DescribeGeofenceCollectionRequestRequestTypeDef = { # (1)
"CollectionName": ...,
}
parent.describe_geofence_collection(**kwargs)
describe_key
Retrieves the API key resource details.
Type annotations and code completion for boto3.client("location").describe_key
method.
boto3 documentation
def describe_key(
self,
*,
KeyName: str,
) -> DescribeKeyResponseTypeDef: # (1)
...
kwargs: DescribeKeyRequestRequestTypeDef = { # (1)
"KeyName": ...,
}
parent.describe_key(**kwargs)
describe_map
Retrieves the map resource details.
Type annotations and code completion for boto3.client("location").describe_map
method.
boto3 documentation
def describe_map(
self,
*,
MapName: str,
) -> DescribeMapResponseTypeDef: # (1)
...
kwargs: DescribeMapRequestRequestTypeDef = { # (1)
"MapName": ...,
}
parent.describe_map(**kwargs)
describe_place_index
Retrieves the place index resource details.
Type annotations and code completion for boto3.client("location").describe_place_index
method.
boto3 documentation
def describe_place_index(
self,
*,
IndexName: str,
) -> DescribePlaceIndexResponseTypeDef: # (1)
...
kwargs: DescribePlaceIndexRequestRequestTypeDef = { # (1)
"IndexName": ...,
}
parent.describe_place_index(**kwargs)
describe_route_calculator
Retrieves the route calculator resource details.
Type annotations and code completion for boto3.client("location").describe_route_calculator
method.
boto3 documentation
def describe_route_calculator(
self,
*,
CalculatorName: str,
) -> DescribeRouteCalculatorResponseTypeDef: # (1)
...
kwargs: DescribeRouteCalculatorRequestRequestTypeDef = { # (1)
"CalculatorName": ...,
}
parent.describe_route_calculator(**kwargs)
describe_tracker
Retrieves the tracker resource details.
Type annotations and code completion for boto3.client("location").describe_tracker
method.
boto3 documentation
def describe_tracker(
self,
*,
TrackerName: str,
) -> DescribeTrackerResponseTypeDef: # (1)
...
kwargs: DescribeTrackerRequestRequestTypeDef = { # (1)
"TrackerName": ...,
}
parent.describe_tracker(**kwargs)
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
def disassociate_tracker_consumer(
self,
*,
ConsumerArn: str,
TrackerName: str,
) -> Dict[str, Any]:
...
kwargs: DisassociateTrackerConsumerRequestRequestTypeDef = { # (1)
"ConsumerArn": ...,
"TrackerName": ...,
}
parent.disassociate_tracker_consumer(**kwargs)
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
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
def get_device_position(
self,
*,
DeviceId: str,
TrackerName: str,
) -> GetDevicePositionResponseTypeDef: # (1)
...
kwargs: GetDevicePositionRequestRequestTypeDef = { # (1)
"DeviceId": ...,
"TrackerName": ...,
}
parent.get_device_position(**kwargs)
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
def get_device_position_history(
self,
*,
DeviceId: str,
TrackerName: str,
EndTimeExclusive: Union[datetime, str] = ...,
MaxResults: int = ...,
NextToken: str = ...,
StartTimeInclusive: Union[datetime, str] = ...,
) -> GetDevicePositionHistoryResponseTypeDef: # (1)
...
kwargs: GetDevicePositionHistoryRequestRequestTypeDef = { # (1)
"DeviceId": ...,
"TrackerName": ...,
}
parent.get_device_position_history(**kwargs)
get_geofence
Retrieves the geofence details from a geofence collection.
Type annotations and code completion for boto3.client("location").get_geofence
method.
boto3 documentation
def get_geofence(
self,
*,
CollectionName: str,
GeofenceId: str,
) -> GetGeofenceResponseTypeDef: # (1)
...
kwargs: GetGeofenceRequestRequestTypeDef = { # (1)
"CollectionName": ...,
"GeofenceId": ...,
}
parent.get_geofence(**kwargs)
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
def get_map_glyphs(
self,
*,
FontStack: str,
FontUnicodeRange: str,
MapName: str,
Key: str = ...,
) -> GetMapGlyphsResponseTypeDef: # (1)
...
kwargs: GetMapGlyphsRequestRequestTypeDef = { # (1)
"FontStack": ...,
"FontUnicodeRange": ...,
"MapName": ...,
}
parent.get_map_glyphs(**kwargs)
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
def get_map_sprites(
self,
*,
FileName: str,
MapName: str,
Key: str = ...,
) -> GetMapSpritesResponseTypeDef: # (1)
...
kwargs: GetMapSpritesRequestRequestTypeDef = { # (1)
"FileName": ...,
"MapName": ...,
}
parent.get_map_sprites(**kwargs)
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
def get_map_style_descriptor(
self,
*,
MapName: str,
Key: str = ...,
) -> GetMapStyleDescriptorResponseTypeDef: # (1)
...
kwargs: GetMapStyleDescriptorRequestRequestTypeDef = { # (1)
"MapName": ...,
}
parent.get_map_style_descriptor(**kwargs)
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
def get_map_tile(
self,
*,
MapName: str,
X: str,
Y: str,
Z: str,
Key: str = ...,
) -> GetMapTileResponseTypeDef: # (1)
...
kwargs: GetMapTileRequestRequestTypeDef = { # (1)
"MapName": ...,
"X": ...,
"Y": ...,
"Z": ...,
}
parent.get_map_tile(**kwargs)
get_place
Finds a place by its unique ID.
Type annotations and code completion for boto3.client("location").get_place
method.
boto3 documentation
def get_place(
self,
*,
IndexName: str,
PlaceId: str,
Language: str = ...,
) -> GetPlaceResponseTypeDef: # (1)
...
kwargs: GetPlaceRequestRequestTypeDef = { # (1)
"IndexName": ...,
"PlaceId": ...,
}
parent.get_place(**kwargs)
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
def list_device_positions(
self,
*,
TrackerName: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListDevicePositionsResponseTypeDef: # (1)
...
kwargs: ListDevicePositionsRequestRequestTypeDef = { # (1)
"TrackerName": ...,
}
parent.list_device_positions(**kwargs)
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
def list_geofence_collections(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListGeofenceCollectionsResponseTypeDef: # (1)
...
kwargs: ListGeofenceCollectionsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_geofence_collections(**kwargs)
list_geofences
Lists geofences stored in a given geofence collection.
Type annotations and code completion for boto3.client("location").list_geofences
method.
boto3 documentation
def list_geofences(
self,
*,
CollectionName: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListGeofencesResponseTypeDef: # (1)
...
kwargs: ListGeofencesRequestRequestTypeDef = { # (1)
"CollectionName": ...,
}
parent.list_geofences(**kwargs)
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
def list_keys(
self,
*,
Filter: ApiKeyFilterTypeDef = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListKeysResponseTypeDef: # (2)
...
kwargs: ListKeysRequestRequestTypeDef = { # (1)
"Filter": ...,
}
parent.list_keys(**kwargs)
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
def list_maps(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListMapsResponseTypeDef: # (1)
...
kwargs: ListMapsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_maps(**kwargs)
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
def list_place_indexes(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListPlaceIndexesResponseTypeDef: # (1)
...
kwargs: ListPlaceIndexesRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_place_indexes(**kwargs)
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
def list_route_calculators(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListRouteCalculatorsResponseTypeDef: # (1)
...
kwargs: ListRouteCalculatorsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_route_calculators(**kwargs)
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
def list_tags_for_resource(
self,
*,
ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
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
def list_tracker_consumers(
self,
*,
TrackerName: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListTrackerConsumersResponseTypeDef: # (1)
...
kwargs: ListTrackerConsumersRequestRequestTypeDef = { # (1)
"TrackerName": ...,
}
parent.list_tracker_consumers(**kwargs)
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
def list_trackers(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListTrackersResponseTypeDef: # (1)
...
kwargs: ListTrackersRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_trackers(**kwargs)
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
def put_geofence(
self,
*,
CollectionName: str,
GeofenceId: str,
Geometry: GeofenceGeometryTypeDef, # (1)
) -> PutGeofenceResponseTypeDef: # (2)
...
kwargs: PutGeofenceRequestRequestTypeDef = { # (1)
"CollectionName": ...,
"GeofenceId": ...,
"Geometry": ...,
}
parent.put_geofence(**kwargs)
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
def search_place_index_for_position(
self,
*,
IndexName: str,
Position: Sequence[float],
Language: str = ...,
MaxResults: int = ...,
) -> SearchPlaceIndexForPositionResponseTypeDef: # (1)
...
kwargs: SearchPlaceIndexForPositionRequestRequestTypeDef = { # (1)
"IndexName": ...,
"Position": ...,
}
parent.search_place_index_for_position(**kwargs)
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
def search_place_index_for_suggestions(
self,
*,
IndexName: str,
Text: str,
BiasPosition: Sequence[float] = ...,
FilterBBox: Sequence[float] = ...,
FilterCountries: Sequence[str] = ...,
Language: str = ...,
MaxResults: int = ...,
) -> SearchPlaceIndexForSuggestionsResponseTypeDef: # (1)
...
kwargs: SearchPlaceIndexForSuggestionsRequestRequestTypeDef = { # (1)
"IndexName": ...,
"Text": ...,
}
parent.search_place_index_for_suggestions(**kwargs)
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
def search_place_index_for_text(
self,
*,
IndexName: str,
Text: str,
BiasPosition: Sequence[float] = ...,
FilterBBox: Sequence[float] = ...,
FilterCountries: Sequence[str] = ...,
Language: str = ...,
MaxResults: int = ...,
) -> SearchPlaceIndexForTextResponseTypeDef: # (1)
...
kwargs: SearchPlaceIndexForTextRequestRequestTypeDef = { # (1)
"IndexName": ...,
"Text": ...,
}
parent.search_place_index_for_text(**kwargs)
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
def tag_resource(
self,
*,
ResourceArn: str,
Tags: Mapping[str, str],
) -> Dict[str, Any]:
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
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
def untag_resource(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
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
def update_geofence_collection(
self,
*,
CollectionName: str,
Description: str = ...,
PricingPlan: PricingPlanType = ..., # (1)
PricingPlanDataSource: str = ...,
) -> UpdateGeofenceCollectionResponseTypeDef: # (2)
...
kwargs: UpdateGeofenceCollectionRequestRequestTypeDef = { # (1)
"CollectionName": ...,
}
parent.update_geofence_collection(**kwargs)
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
def update_key(
self,
*,
KeyName: str,
Description: str = ...,
ExpireTime: Union[datetime, str] = ...,
ForceUpdate: bool = ...,
NoExpiry: bool = ...,
Restrictions: ApiKeyRestrictionsTypeDef = ..., # (1)
) -> UpdateKeyResponseTypeDef: # (2)
...
kwargs: UpdateKeyRequestRequestTypeDef = { # (1)
"KeyName": ...,
}
parent.update_key(**kwargs)
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
def update_map(
self,
*,
MapName: str,
Description: str = ...,
PricingPlan: PricingPlanType = ..., # (1)
) -> UpdateMapResponseTypeDef: # (2)
...
kwargs: UpdateMapRequestRequestTypeDef = { # (1)
"MapName": ...,
}
parent.update_map(**kwargs)
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
def update_place_index(
self,
*,
IndexName: str,
DataSourceConfiguration: DataSourceConfigurationTypeDef = ..., # (1)
Description: str = ...,
PricingPlan: PricingPlanType = ..., # (2)
) -> UpdatePlaceIndexResponseTypeDef: # (3)
...
kwargs: UpdatePlaceIndexRequestRequestTypeDef = { # (1)
"IndexName": ...,
}
parent.update_place_index(**kwargs)
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
def update_route_calculator(
self,
*,
CalculatorName: str,
Description: str = ...,
PricingPlan: PricingPlanType = ..., # (1)
) -> UpdateRouteCalculatorResponseTypeDef: # (2)
...
kwargs: UpdateRouteCalculatorRequestRequestTypeDef = { # (1)
"CalculatorName": ...,
}
parent.update_route_calculator(**kwargs)
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
def update_tracker(
self,
*,
TrackerName: str,
Description: str = ...,
PositionFiltering: PositionFilteringType = ..., # (1)
PricingPlan: PricingPlanType = ..., # (2)
PricingPlanDataSource: str = ...,
) -> UpdateTrackerResponseTypeDef: # (3)
...
kwargs: UpdateTrackerRequestRequestTypeDef = { # (1)
"TrackerName": ...,
}
parent.update_tracker(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("location").get_paginator
method with overloads.
client.get_paginator("get_device_position_history")
-> GetDevicePositionHistoryPaginatorclient.get_paginator("list_device_positions")
-> ListDevicePositionsPaginatorclient.get_paginator("list_geofence_collections")
-> ListGeofenceCollectionsPaginatorclient.get_paginator("list_geofences")
-> ListGeofencesPaginatorclient.get_paginator("list_keys")
-> ListKeysPaginatorclient.get_paginator("list_maps")
-> ListMapsPaginatorclient.get_paginator("list_place_indexes")
-> ListPlaceIndexesPaginatorclient.get_paginator("list_route_calculators")
-> ListRouteCalculatorsPaginatorclient.get_paginator("list_tracker_consumers")
-> ListTrackerConsumersPaginatorclient.get_paginator("list_trackers")
-> ListTrackersPaginator