LocationService module#
Index > LocationService
Auto-generated documentation for LocationService type annotations stubs module mypy-boto3-location.
How to install#
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("...")
.
# GetDevicePositionHistoryPaginator usage example
from boto3.session import Session
from mypy_boto3_location.paginator import GetDevicePositionHistoryPaginator
def get_get_device_position_history_paginator() -> GetDevicePositionHistoryPaginator:
return Session().client("location").get_paginator("get_device_position_history"))
- GetDevicePositionHistoryPaginator
- ListDevicePositionsPaginator
- ListGeofenceCollectionsPaginator
- ListGeofencesPaginator
- ListKeysPaginator
- ListMapsPaginator
- ListPlaceIndexesPaginator
- ListRouteCalculatorsPaginator
- ListTrackerConsumersPaginator
- ListTrackersPaginator
Literals#
Type annotations for literals used in methods and schemas.
# BatchItemErrorCodeType usage example
from mypy_boto3_location.literals import BatchItemErrorCodeType
def get_value() -> BatchItemErrorCodeType:
return "AccessDeniedError"
- BatchItemErrorCodeType
- DimensionUnitType
- DistanceUnitType
- GetDevicePositionHistoryPaginatorName
- IntendedUseType
- ListDevicePositionsPaginatorName
- ListGeofenceCollectionsPaginatorName
- ListGeofencesPaginatorName
- ListKeysPaginatorName
- ListMapsPaginatorName
- ListPlaceIndexesPaginatorName
- ListRouteCalculatorsPaginatorName
- ListTrackerConsumersPaginatorName
- ListTrackersPaginatorName
- PositionFilteringType
- PricingPlanType
- RouteMatrixErrorCodeType
- StatusType
- TravelModeType
- VehicleWeightUnitType
- LocationServiceServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Typed dictionaries#
Type annotations for typed dictionaries used in methods and schema.
# ApiKeyFilterTypeDef usage example
from mypy_boto3_location.type_defs import ApiKeyFilterTypeDef
def get_value() -> ApiKeyFilterTypeDef:
return {
"KeyStatus": ...,
}
- ApiKeyFilterTypeDef
- ApiKeyRestrictionsTypeDef
- AssociateTrackerConsumerRequestRequestTypeDef
- BatchItemErrorTypeDef
- BatchDeleteDevicePositionHistoryRequestRequestTypeDef
- BatchDeleteGeofenceRequestRequestTypeDef
- BatchGetDevicePositionRequestRequestTypeDef
- BatchPutGeofenceSuccessTypeDef
- CalculateRouteCarModeOptionsTypeDef
- CalculateRouteMatrixSummaryTypeDef
- CalculateRouteSummaryTypeDef
- TruckDimensionsTypeDef
- TruckWeightTypeDef
- CircleTypeDef
- CreateGeofenceCollectionRequestRequestTypeDef
- CreateGeofenceCollectionResponseTypeDef
- CreateKeyResponseTypeDef
- MapConfigurationTypeDef
- CreateMapResponseTypeDef
- DataSourceConfigurationTypeDef
- CreatePlaceIndexResponseTypeDef
- CreateRouteCalculatorRequestRequestTypeDef
- CreateRouteCalculatorResponseTypeDef
- CreateTrackerRequestRequestTypeDef
- CreateTrackerResponseTypeDef
- DeleteGeofenceCollectionRequestRequestTypeDef
- DeleteKeyRequestRequestTypeDef
- DeleteMapRequestRequestTypeDef
- DeletePlaceIndexRequestRequestTypeDef
- DeleteRouteCalculatorRequestRequestTypeDef
- DeleteTrackerRequestRequestTypeDef
- DescribeGeofenceCollectionRequestRequestTypeDef
- DescribeGeofenceCollectionResponseTypeDef
- DescribeKeyRequestRequestTypeDef
- DescribeMapRequestRequestTypeDef
- DescribePlaceIndexRequestRequestTypeDef
- DescribeRouteCalculatorRequestRequestTypeDef
- DescribeRouteCalculatorResponseTypeDef
- DescribeTrackerRequestRequestTypeDef
- DescribeTrackerResponseTypeDef
- PositionalAccuracyTypeDef
- DisassociateTrackerConsumerRequestRequestTypeDef
- GetDevicePositionHistoryRequestGetDevicePositionHistoryPaginateTypeDef
- GetDevicePositionHistoryRequestRequestTypeDef
- GetDevicePositionRequestRequestTypeDef
- GetGeofenceRequestRequestTypeDef
- GetMapGlyphsRequestRequestTypeDef
- GetMapGlyphsResponseTypeDef
- GetMapSpritesRequestRequestTypeDef
- GetMapSpritesResponseTypeDef
- GetMapStyleDescriptorRequestRequestTypeDef
- GetMapStyleDescriptorResponseTypeDef
- GetMapTileRequestRequestTypeDef
- GetMapTileResponseTypeDef
- GetPlaceRequestRequestTypeDef
- LegGeometryTypeDef
- StepTypeDef
- ListDevicePositionsRequestListDevicePositionsPaginateTypeDef
- ListDevicePositionsRequestRequestTypeDef
- ListGeofenceCollectionsRequestListGeofenceCollectionsPaginateTypeDef
- ListGeofenceCollectionsRequestRequestTypeDef
- ListGeofenceCollectionsResponseEntryTypeDef
- ListGeofencesRequestListGeofencesPaginateTypeDef
- ListGeofencesRequestRequestTypeDef
- ListMapsRequestListMapsPaginateTypeDef
- ListMapsRequestRequestTypeDef
- ListMapsResponseEntryTypeDef
- ListPlaceIndexesRequestListPlaceIndexesPaginateTypeDef
- ListPlaceIndexesRequestRequestTypeDef
- ListPlaceIndexesResponseEntryTypeDef
- ListRouteCalculatorsRequestListRouteCalculatorsPaginateTypeDef
- ListRouteCalculatorsRequestRequestTypeDef
- ListRouteCalculatorsResponseEntryTypeDef
- ListTagsForResourceRequestRequestTypeDef
- ListTagsForResourceResponseTypeDef
- ListTrackerConsumersRequestListTrackerConsumersPaginateTypeDef
- ListTrackerConsumersRequestRequestTypeDef
- ListTrackerConsumersResponseTypeDef
- ListTrackersRequestListTrackersPaginateTypeDef
- ListTrackersRequestRequestTypeDef
- ListTrackersResponseEntryTypeDef
- MapConfigurationUpdateTypeDef
- PaginatorConfigTypeDef
- PlaceGeometryTypeDef
- TimeZoneTypeDef
- PutGeofenceResponseTypeDef
- ResponseMetadataTypeDef
- RouteMatrixEntryErrorTypeDef
- SearchForSuggestionsResultTypeDef
- SearchPlaceIndexForPositionRequestRequestTypeDef
- SearchPlaceIndexForPositionSummaryTypeDef
- SearchPlaceIndexForSuggestionsRequestRequestTypeDef
- SearchPlaceIndexForSuggestionsSummaryTypeDef
- SearchPlaceIndexForTextRequestRequestTypeDef
- SearchPlaceIndexForTextSummaryTypeDef
- TagResourceRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateGeofenceCollectionRequestRequestTypeDef
- UpdateGeofenceCollectionResponseTypeDef
- UpdateKeyResponseTypeDef
- UpdateMapResponseTypeDef
- UpdatePlaceIndexResponseTypeDef
- UpdateRouteCalculatorRequestRequestTypeDef
- UpdateRouteCalculatorResponseTypeDef
- UpdateTrackerRequestRequestTypeDef
- UpdateTrackerResponseTypeDef
- ListKeysRequestListKeysPaginateTypeDef
- ListKeysRequestRequestTypeDef
- CreateKeyRequestRequestTypeDef
- DescribeKeyResponseTypeDef
- ListKeysResponseEntryTypeDef
- UpdateKeyRequestRequestTypeDef
- BatchDeleteDevicePositionHistoryErrorTypeDef
- BatchDeleteGeofenceErrorTypeDef
- BatchEvaluateGeofencesErrorTypeDef
- BatchGetDevicePositionErrorTypeDef
- BatchPutGeofenceErrorTypeDef
- BatchUpdateDevicePositionErrorTypeDef
- CalculateRouteTruckModeOptionsTypeDef
- GeofenceGeometryTypeDef
- CreateMapRequestRequestTypeDef
- DescribeMapResponseTypeDef
- CreatePlaceIndexRequestRequestTypeDef
- DescribePlaceIndexResponseTypeDef
- UpdatePlaceIndexRequestRequestTypeDef
- DevicePositionTypeDef
- DevicePositionUpdateTypeDef
- GetDevicePositionResponseTypeDef
- ListDevicePositionsResponseEntryTypeDef
- LegTypeDef
- ListGeofenceCollectionsResponseTypeDef
- ListMapsResponseTypeDef
- ListPlaceIndexesResponseTypeDef
- ListRouteCalculatorsResponseTypeDef
- ListTrackersResponseTypeDef
- UpdateMapRequestRequestTypeDef
- PlaceTypeDef
- RouteMatrixEntryTypeDef
- SearchPlaceIndexForSuggestionsResponseTypeDef
- ListKeysResponseTypeDef
- BatchDeleteDevicePositionHistoryResponseTypeDef
- BatchDeleteGeofenceResponseTypeDef
- BatchEvaluateGeofencesResponseTypeDef
- BatchPutGeofenceResponseTypeDef
- BatchUpdateDevicePositionResponseTypeDef
- CalculateRouteMatrixRequestRequestTypeDef
- CalculateRouteRequestRequestTypeDef
- BatchPutGeofenceRequestEntryTypeDef
- GetGeofenceResponseTypeDef
- ListGeofenceResponseEntryTypeDef
- PutGeofenceRequestRequestTypeDef
- BatchGetDevicePositionResponseTypeDef
- GetDevicePositionHistoryResponseTypeDef
- BatchEvaluateGeofencesRequestRequestTypeDef
- BatchUpdateDevicePositionRequestRequestTypeDef
- ListDevicePositionsResponseTypeDef
- CalculateRouteResponseTypeDef
- GetPlaceResponseTypeDef
- SearchForPositionResultTypeDef
- SearchForTextResultTypeDef
- CalculateRouteMatrixResponseTypeDef
- BatchPutGeofenceRequestRequestTypeDef
- ListGeofencesResponseTypeDef
- SearchPlaceIndexForPositionResponseTypeDef
- SearchPlaceIndexForTextResponseTypeDef