LocationService module#
Index > LocationService
Auto-generated documentation for LocationService type annotations stubs module mypy-boto3-location.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy_boto3_builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.35.86' mypy_boto3_builder
- Select
boto3-stubs
AWS SDK. - Add
LocationService
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and LocationService
.
From PyPI with pip#
Install boto3-stubs
for LocationService
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[location]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[location]'
# standalone installation
python -m pip install mypy-boto3-location
How to uninstall#
python -m pip uninstall -y mypy-boto3-location
Usage#
Code samples can be found in Examples.
LocationServiceClient#
Type annotations and code completion for boto3.client("location")
as LocationServiceClient
boto3 documentation
# LocationServiceClient usage example
from boto3.session import Session
from mypy_boto3_location.client import LocationServiceClient
def get_client() -> LocationServiceClient:
return Session().client("location")
Paginators#
Type annotations and code completion for paginators
from boto3.client("location").get_paginator("...")
.
# ForecastGeofenceEventsPaginator usage example
from boto3.session import Session
from mypy_boto3_location.paginator import ForecastGeofenceEventsPaginator
def get_forecast_geofence_events_paginator() -> ForecastGeofenceEventsPaginator:
return Session().client("location").get_paginator("forecast_geofence_events"))
- ForecastGeofenceEventsPaginator
- GetDevicePositionHistoryPaginator
- ListDevicePositionsPaginator
- ListGeofenceCollectionsPaginator
- ListGeofencesPaginator
- ListKeysPaginator
- ListMapsPaginator
- ListPlaceIndexesPaginator
- ListRouteCalculatorsPaginator
- ListTrackerConsumersPaginator
- ListTrackersPaginator
Literals#
Type annotations for literals used in methods and schema.
# BatchItemErrorCodeType usage example
from mypy_boto3_location.literals import BatchItemErrorCodeType
def get_value() -> BatchItemErrorCodeType:
return "AccessDeniedError"
- BatchItemErrorCodeType
- DimensionUnitType
- DistanceUnitType
- ForecastGeofenceEventsPaginatorName
- ForecastedGeofenceEventTypeType
- GetDevicePositionHistoryPaginatorName
- IntendedUseType
- ListDevicePositionsPaginatorName
- ListGeofenceCollectionsPaginatorName
- ListGeofencesPaginatorName
- ListKeysPaginatorName
- ListMapsPaginatorName
- ListPlaceIndexesPaginatorName
- ListRouteCalculatorsPaginatorName
- ListTrackerConsumersPaginatorName
- ListTrackersPaginatorName
- OptimizationModeType
- PositionFilteringType
- PricingPlanType
- RouteMatrixErrorCodeType
- SpeedUnitType
- StatusType
- TravelModeType
- VehicleWeightUnitType
- LocationServiceServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- ApiKeyFilterTypeDef
- ApiKeyRestrictionsOutputTypeDef
- ApiKeyRestrictionsTypeDef
- AssociateTrackerConsumerRequestRequestTypeDef
- BatchItemErrorTypeDef
- BatchDeleteDevicePositionHistoryRequestRequestTypeDef
- ResponseMetadataTypeDef
- BatchDeleteGeofenceRequestRequestTypeDef
- BatchGetDevicePositionRequestRequestTypeDef
- BatchPutGeofenceSuccessTypeDef
- BlobTypeDef
- CalculateRouteCarModeOptionsTypeDef
- TimestampTypeDef
- CalculateRouteMatrixSummaryTypeDef
- CalculateRouteSummaryTypeDef
- TruckDimensionsTypeDef
- TruckWeightTypeDef
- CircleOutputTypeDef
- CircleTypeDef
- CreateGeofenceCollectionRequestRequestTypeDef
- MapConfigurationTypeDef
- DataSourceConfigurationTypeDef
- CreateRouteCalculatorRequestRequestTypeDef
- CreateTrackerRequestRequestTypeDef
- DeleteGeofenceCollectionRequestRequestTypeDef
- DeleteKeyRequestRequestTypeDef
- DeleteMapRequestRequestTypeDef
- DeletePlaceIndexRequestRequestTypeDef
- DeleteRouteCalculatorRequestRequestTypeDef
- DeleteTrackerRequestRequestTypeDef
- DescribeGeofenceCollectionRequestRequestTypeDef
- DescribeKeyRequestRequestTypeDef
- DescribeMapRequestRequestTypeDef
- MapConfigurationOutputTypeDef
- DescribePlaceIndexRequestRequestTypeDef
- DescribeRouteCalculatorRequestRequestTypeDef
- DescribeTrackerRequestRequestTypeDef
- PositionalAccuracyTypeDef
- WiFiAccessPointTypeDef
- DisassociateTrackerConsumerRequestRequestTypeDef
- ForecastGeofenceEventsDeviceStateTypeDef
- PaginatorConfigTypeDef
- ForecastedEventTypeDef
- GetDevicePositionRequestRequestTypeDef
- GetGeofenceRequestRequestTypeDef
- GetMapGlyphsRequestRequestTypeDef
- GetMapSpritesRequestRequestTypeDef
- GetMapStyleDescriptorRequestRequestTypeDef
- GetMapTileRequestRequestTypeDef
- GetPlaceRequestRequestTypeDef
- LegGeometryTypeDef
- StepTypeDef
- TrackingFilterGeometryTypeDef
- ListGeofenceCollectionsRequestRequestTypeDef
- ListGeofenceCollectionsResponseEntryTypeDef
- ListGeofencesRequestRequestTypeDef
- ListMapsRequestRequestTypeDef
- ListMapsResponseEntryTypeDef
- ListPlaceIndexesRequestRequestTypeDef
- ListPlaceIndexesResponseEntryTypeDef
- ListRouteCalculatorsRequestRequestTypeDef
- ListRouteCalculatorsResponseEntryTypeDef
- ListTagsForResourceRequestRequestTypeDef
- ListTrackerConsumersRequestRequestTypeDef
- ListTrackersRequestRequestTypeDef
- ListTrackersResponseEntryTypeDef
- LteLocalIdTypeDef
- LteNetworkMeasurementsTypeDef
- MapConfigurationUpdateTypeDef
- PlaceGeometryTypeDef
- TimeZoneTypeDef
- RouteMatrixEntryErrorTypeDef
- SearchForSuggestionsResultTypeDef
- SearchPlaceIndexForPositionRequestRequestTypeDef
- SearchPlaceIndexForPositionSummaryTypeDef
- SearchPlaceIndexForSuggestionsRequestRequestTypeDef
- SearchPlaceIndexForSuggestionsSummaryTypeDef
- SearchPlaceIndexForTextRequestRequestTypeDef
- SearchPlaceIndexForTextSummaryTypeDef
- TagResourceRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateGeofenceCollectionRequestRequestTypeDef
- UpdateRouteCalculatorRequestRequestTypeDef
- UpdateTrackerRequestRequestTypeDef
- ListKeysRequestRequestTypeDef
- ListKeysResponseEntryTypeDef
- BatchDeleteDevicePositionHistoryErrorTypeDef
- BatchDeleteGeofenceErrorTypeDef
- BatchEvaluateGeofencesErrorTypeDef
- BatchGetDevicePositionErrorTypeDef
- BatchPutGeofenceErrorTypeDef
- BatchUpdateDevicePositionErrorTypeDef
- CreateGeofenceCollectionResponseTypeDef
- CreateKeyResponseTypeDef
- CreateMapResponseTypeDef
- CreatePlaceIndexResponseTypeDef
- CreateRouteCalculatorResponseTypeDef
- CreateTrackerResponseTypeDef
- DescribeGeofenceCollectionResponseTypeDef
- DescribeKeyResponseTypeDef
- DescribeRouteCalculatorResponseTypeDef
- DescribeTrackerResponseTypeDef
- GetMapGlyphsResponseTypeDef
- GetMapSpritesResponseTypeDef
- GetMapStyleDescriptorResponseTypeDef
- GetMapTileResponseTypeDef
- ListTagsForResourceResponseTypeDef
- ListTrackerConsumersResponseTypeDef
- PutGeofenceResponseTypeDef
- UpdateGeofenceCollectionResponseTypeDef
- UpdateKeyResponseTypeDef
- UpdateMapResponseTypeDef
- UpdatePlaceIndexResponseTypeDef
- UpdateRouteCalculatorResponseTypeDef
- UpdateTrackerResponseTypeDef
- CreateKeyRequestRequestTypeDef
- GetDevicePositionHistoryRequestRequestTypeDef
- UpdateKeyRequestRequestTypeDef
- CalculateRouteTruckModeOptionsTypeDef
- GeofenceGeometryOutputTypeDef
- CircleUnionTypeDef
- CreateMapRequestRequestTypeDef
- CreatePlaceIndexRequestRequestTypeDef
- DescribePlaceIndexResponseTypeDef
- UpdatePlaceIndexRequestRequestTypeDef
- DescribeMapResponseTypeDef
- DevicePositionTypeDef
- DevicePositionUpdateTypeDef
- GetDevicePositionResponseTypeDef
- InferredStateTypeDef
- ListDevicePositionsResponseEntryTypeDef
- ForecastGeofenceEventsRequestRequestTypeDef
- ForecastGeofenceEventsRequestPaginateTypeDef
- GetDevicePositionHistoryRequestPaginateTypeDef
- ListGeofenceCollectionsRequestPaginateTypeDef
- ListGeofencesRequestPaginateTypeDef
- ListKeysRequestPaginateTypeDef
- ListMapsRequestPaginateTypeDef
- ListPlaceIndexesRequestPaginateTypeDef
- ListRouteCalculatorsRequestPaginateTypeDef
- ListTrackerConsumersRequestPaginateTypeDef
- ListTrackersRequestPaginateTypeDef
- ForecastGeofenceEventsResponseTypeDef
- LegTypeDef
- ListDevicePositionsRequestPaginateTypeDef
- ListDevicePositionsRequestRequestTypeDef
- ListGeofenceCollectionsResponseTypeDef
- ListMapsResponseTypeDef
- ListPlaceIndexesResponseTypeDef
- ListRouteCalculatorsResponseTypeDef
- ListTrackersResponseTypeDef
- LteCellDetailsTypeDef
- UpdateMapRequestRequestTypeDef
- PlaceTypeDef
- RouteMatrixEntryTypeDef
- SearchPlaceIndexForSuggestionsResponseTypeDef
- ListKeysResponseTypeDef
- BatchDeleteDevicePositionHistoryResponseTypeDef
- BatchDeleteGeofenceResponseTypeDef
- BatchEvaluateGeofencesResponseTypeDef
- BatchPutGeofenceResponseTypeDef
- BatchUpdateDevicePositionResponseTypeDef
- CalculateRouteMatrixRequestRequestTypeDef
- CalculateRouteRequestRequestTypeDef
- GetGeofenceResponseTypeDef
- ListGeofenceResponseEntryTypeDef
- GeofenceGeometryTypeDef
- BatchGetDevicePositionResponseTypeDef
- GetDevicePositionHistoryResponseTypeDef
- BatchEvaluateGeofencesRequestRequestTypeDef
- BatchUpdateDevicePositionRequestRequestTypeDef
- VerifyDevicePositionResponseTypeDef
- ListDevicePositionsResponseTypeDef
- CalculateRouteResponseTypeDef
- CellSignalsTypeDef
- GetPlaceResponseTypeDef
- SearchForPositionResultTypeDef
- SearchForTextResultTypeDef
- CalculateRouteMatrixResponseTypeDef
- ListGeofencesResponseTypeDef
- GeofenceGeometryUnionTypeDef
- PutGeofenceRequestRequestTypeDef
- DeviceStateTypeDef
- SearchPlaceIndexForPositionResponseTypeDef
- SearchPlaceIndexForTextResponseTypeDef
- BatchPutGeofenceRequestEntryTypeDef
- VerifyDevicePositionRequestRequestTypeDef
- BatchPutGeofenceRequestRequestTypeDef