Type definitions#
Index > LocationService > Type definitions
Auto-generated documentation for LocationService type annotations stubs module mypy-boto3-location.
BlobTypeDef#
# BlobTypeDef Union usage example
from mypy_boto3_location.type_defs import BlobTypeDef
def get_value() -> BlobTypeDef:
return ...
# BlobTypeDef definition
BlobTypeDef = Union[
str,
bytes,
IO[Any],
botocore.response.StreamingBody,
]TimestampTypeDef#
# TimestampTypeDef Union usage example
from mypy_boto3_location.type_defs import TimestampTypeDef
def get_value() -> TimestampTypeDef:
return ...
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime.datetime,
str,
]ApiKeyRestrictionsUnionTypeDef#
# ApiKeyRestrictionsUnionTypeDef Union usage example
from mypy_boto3_location.type_defs import ApiKeyRestrictionsUnionTypeDef
def get_value() -> ApiKeyRestrictionsUnionTypeDef:
return ...
# ApiKeyRestrictionsUnionTypeDef definition
ApiKeyRestrictionsUnionTypeDef = Union[
ApiKeyRestrictionsTypeDef, # (1)
ApiKeyRestrictionsOutputTypeDef, # (2)
]CircleUnionTypeDef#
# CircleUnionTypeDef Union usage example
from mypy_boto3_location.type_defs import CircleUnionTypeDef
def get_value() -> CircleUnionTypeDef:
return ...
# CircleUnionTypeDef definition
CircleUnionTypeDef = Union[
CircleTypeDef, # (1)
CircleOutputTypeDef, # (2)
]- See CircleTypeDef
- See CircleOutputTypeDef
MapConfigurationUnionTypeDef#
# MapConfigurationUnionTypeDef Union usage example
from mypy_boto3_location.type_defs import MapConfigurationUnionTypeDef
def get_value() -> MapConfigurationUnionTypeDef:
return ...
# MapConfigurationUnionTypeDef definition
MapConfigurationUnionTypeDef = Union[
MapConfigurationTypeDef, # (1)
MapConfigurationOutputTypeDef, # (2)
]GeofenceGeometryUnionTypeDef#
# GeofenceGeometryUnionTypeDef Union usage example
from mypy_boto3_location.type_defs import GeofenceGeometryUnionTypeDef
def get_value() -> GeofenceGeometryUnionTypeDef:
return ...
# GeofenceGeometryUnionTypeDef definition
GeofenceGeometryUnionTypeDef = Union[
GeofenceGeometryTypeDef, # (1)
GeofenceGeometryOutputTypeDef, # (2)
]ApiKeyFilterTypeDef#
# ApiKeyFilterTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ApiKeyFilterTypeDef
def get_value() -> ApiKeyFilterTypeDef:
return {
"KeyStatus": ...,
}
# ApiKeyFilterTypeDef definition
class ApiKeyFilterTypeDef(TypedDict):
KeyStatus: NotRequired[StatusType], # (1)- See StatusType
ApiKeyRestrictionsOutputTypeDef#
# ApiKeyRestrictionsOutputTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ApiKeyRestrictionsOutputTypeDef
def get_value() -> ApiKeyRestrictionsOutputTypeDef:
return {
"AllowActions": ...,
}
# ApiKeyRestrictionsOutputTypeDef definition
class ApiKeyRestrictionsOutputTypeDef(TypedDict):
AllowActions: List[str],
AllowResources: List[str],
AllowReferers: NotRequired[List[str]],ApiKeyRestrictionsTypeDef#
# ApiKeyRestrictionsTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ApiKeyRestrictionsTypeDef
def get_value() -> ApiKeyRestrictionsTypeDef:
return {
"AllowActions": ...,
}
# ApiKeyRestrictionsTypeDef definition
class ApiKeyRestrictionsTypeDef(TypedDict):
AllowActions: Sequence[str],
AllowResources: Sequence[str],
AllowReferers: NotRequired[Sequence[str]],AssociateTrackerConsumerRequestTypeDef#
# AssociateTrackerConsumerRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import AssociateTrackerConsumerRequestTypeDef
def get_value() -> AssociateTrackerConsumerRequestTypeDef:
return {
"TrackerName": ...,
}
# AssociateTrackerConsumerRequestTypeDef definition
class AssociateTrackerConsumerRequestTypeDef(TypedDict):
TrackerName: str,
ConsumerArn: str,BatchItemErrorTypeDef#
# BatchItemErrorTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import BatchItemErrorTypeDef
def get_value() -> BatchItemErrorTypeDef:
return {
"Code": ...,
}
# BatchItemErrorTypeDef definition
class BatchItemErrorTypeDef(TypedDict):
Code: NotRequired[BatchItemErrorCodeType], # (1)
Message: NotRequired[str],BatchDeleteDevicePositionHistoryRequestTypeDef#
# BatchDeleteDevicePositionHistoryRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import BatchDeleteDevicePositionHistoryRequestTypeDef
def get_value() -> BatchDeleteDevicePositionHistoryRequestTypeDef:
return {
"TrackerName": ...,
}
# BatchDeleteDevicePositionHistoryRequestTypeDef definition
class BatchDeleteDevicePositionHistoryRequestTypeDef(TypedDict):
TrackerName: str,
DeviceIds: Sequence[str],ResponseMetadataTypeDef#
# ResponseMetadataTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],BatchDeleteGeofenceRequestTypeDef#
# BatchDeleteGeofenceRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import BatchDeleteGeofenceRequestTypeDef
def get_value() -> BatchDeleteGeofenceRequestTypeDef:
return {
"CollectionName": ...,
}
# BatchDeleteGeofenceRequestTypeDef definition
class BatchDeleteGeofenceRequestTypeDef(TypedDict):
CollectionName: str,
GeofenceIds: Sequence[str],BatchGetDevicePositionRequestTypeDef#
# BatchGetDevicePositionRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import BatchGetDevicePositionRequestTypeDef
def get_value() -> BatchGetDevicePositionRequestTypeDef:
return {
"TrackerName": ...,
}
# BatchGetDevicePositionRequestTypeDef definition
class BatchGetDevicePositionRequestTypeDef(TypedDict):
TrackerName: str,
DeviceIds: Sequence[str],BatchPutGeofenceSuccessTypeDef#
# BatchPutGeofenceSuccessTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import BatchPutGeofenceSuccessTypeDef
def get_value() -> BatchPutGeofenceSuccessTypeDef:
return {
"GeofenceId": ...,
}
# BatchPutGeofenceSuccessTypeDef definition
class BatchPutGeofenceSuccessTypeDef(TypedDict):
GeofenceId: str,
CreateTime: datetime.datetime,
UpdateTime: datetime.datetime,CalculateRouteCarModeOptionsTypeDef#
# CalculateRouteCarModeOptionsTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import CalculateRouteCarModeOptionsTypeDef
def get_value() -> CalculateRouteCarModeOptionsTypeDef:
return {
"AvoidFerries": ...,
}
# CalculateRouteCarModeOptionsTypeDef definition
class CalculateRouteCarModeOptionsTypeDef(TypedDict):
AvoidFerries: NotRequired[bool],
AvoidTolls: NotRequired[bool],CalculateRouteMatrixSummaryTypeDef#
# CalculateRouteMatrixSummaryTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import CalculateRouteMatrixSummaryTypeDef
def get_value() -> CalculateRouteMatrixSummaryTypeDef:
return {
"DataSource": ...,
}
# CalculateRouteMatrixSummaryTypeDef definition
class CalculateRouteMatrixSummaryTypeDef(TypedDict):
DataSource: str,
RouteCount: int,
ErrorCount: int,
DistanceUnit: DistanceUnitType, # (1)- See DistanceUnitType
CalculateRouteSummaryTypeDef#
# CalculateRouteSummaryTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import CalculateRouteSummaryTypeDef
def get_value() -> CalculateRouteSummaryTypeDef:
return {
"RouteBBox": ...,
}
# CalculateRouteSummaryTypeDef definition
class CalculateRouteSummaryTypeDef(TypedDict):
RouteBBox: List[float],
DataSource: str,
Distance: float,
DurationSeconds: float,
DistanceUnit: DistanceUnitType, # (1)- See DistanceUnitType
TruckDimensionsTypeDef#
# TruckDimensionsTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import TruckDimensionsTypeDef
def get_value() -> TruckDimensionsTypeDef:
return {
"Length": ...,
}
# TruckDimensionsTypeDef definition
class TruckDimensionsTypeDef(TypedDict):
Length: NotRequired[float],
Height: NotRequired[float],
Width: NotRequired[float],
Unit: NotRequired[DimensionUnitType], # (1)TruckWeightTypeDef#
# TruckWeightTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import TruckWeightTypeDef
def get_value() -> TruckWeightTypeDef:
return {
"Total": ...,
}
# TruckWeightTypeDef definition
class TruckWeightTypeDef(TypedDict):
Total: NotRequired[float],
Unit: NotRequired[VehicleWeightUnitType], # (1)CircleOutputTypeDef#
# CircleOutputTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import CircleOutputTypeDef
def get_value() -> CircleOutputTypeDef:
return {
"Center": ...,
}
# CircleOutputTypeDef definition
class CircleOutputTypeDef(TypedDict):
Center: List[float],
Radius: float,CircleTypeDef#
# CircleTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import CircleTypeDef
def get_value() -> CircleTypeDef:
return {
"Center": ...,
}
# CircleTypeDef definition
class CircleTypeDef(TypedDict):
Center: Sequence[float],
Radius: float,CreateGeofenceCollectionRequestTypeDef#
# CreateGeofenceCollectionRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import CreateGeofenceCollectionRequestTypeDef
def get_value() -> CreateGeofenceCollectionRequestTypeDef:
return {
"CollectionName": ...,
}
# CreateGeofenceCollectionRequestTypeDef definition
class CreateGeofenceCollectionRequestTypeDef(TypedDict):
CollectionName: str,
PricingPlan: NotRequired[PricingPlanType], # (1)
PricingPlanDataSource: NotRequired[str],
Description: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],
KmsKeyId: NotRequired[str],- See PricingPlanType
DataSourceConfigurationTypeDef#
# DataSourceConfigurationTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import DataSourceConfigurationTypeDef
def get_value() -> DataSourceConfigurationTypeDef:
return {
"IntendedUse": ...,
}
# DataSourceConfigurationTypeDef definition
class DataSourceConfigurationTypeDef(TypedDict):
IntendedUse: NotRequired[IntendedUseType], # (1)- See IntendedUseType
CreateRouteCalculatorRequestTypeDef#
# CreateRouteCalculatorRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import CreateRouteCalculatorRequestTypeDef
def get_value() -> CreateRouteCalculatorRequestTypeDef:
return {
"CalculatorName": ...,
}
# CreateRouteCalculatorRequestTypeDef definition
class CreateRouteCalculatorRequestTypeDef(TypedDict):
CalculatorName: str,
DataSource: str,
PricingPlan: NotRequired[PricingPlanType], # (1)
Description: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],- See PricingPlanType
CreateTrackerRequestTypeDef#
# CreateTrackerRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import CreateTrackerRequestTypeDef
def get_value() -> CreateTrackerRequestTypeDef:
return {
"TrackerName": ...,
}
# CreateTrackerRequestTypeDef definition
class CreateTrackerRequestTypeDef(TypedDict):
TrackerName: str,
PricingPlan: NotRequired[PricingPlanType], # (1)
KmsKeyId: NotRequired[str],
PricingPlanDataSource: NotRequired[str],
Description: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],
PositionFiltering: NotRequired[PositionFilteringType], # (2)
EventBridgeEnabled: NotRequired[bool],
KmsKeyEnableGeospatialQueries: NotRequired[bool],- See PricingPlanType
- See PositionFilteringType
DeleteGeofenceCollectionRequestTypeDef#
# DeleteGeofenceCollectionRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import DeleteGeofenceCollectionRequestTypeDef
def get_value() -> DeleteGeofenceCollectionRequestTypeDef:
return {
"CollectionName": ...,
}
# DeleteGeofenceCollectionRequestTypeDef definition
class DeleteGeofenceCollectionRequestTypeDef(TypedDict):
CollectionName: str,DeleteKeyRequestTypeDef#
# DeleteKeyRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import DeleteKeyRequestTypeDef
def get_value() -> DeleteKeyRequestTypeDef:
return {
"KeyName": ...,
}
# DeleteKeyRequestTypeDef definition
class DeleteKeyRequestTypeDef(TypedDict):
KeyName: str,
ForceDelete: NotRequired[bool],DeleteMapRequestTypeDef#
# DeleteMapRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import DeleteMapRequestTypeDef
def get_value() -> DeleteMapRequestTypeDef:
return {
"MapName": ...,
}
# DeleteMapRequestTypeDef definition
class DeleteMapRequestTypeDef(TypedDict):
MapName: str,DeletePlaceIndexRequestTypeDef#
# DeletePlaceIndexRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import DeletePlaceIndexRequestTypeDef
def get_value() -> DeletePlaceIndexRequestTypeDef:
return {
"IndexName": ...,
}
# DeletePlaceIndexRequestTypeDef definition
class DeletePlaceIndexRequestTypeDef(TypedDict):
IndexName: str,DeleteRouteCalculatorRequestTypeDef#
# DeleteRouteCalculatorRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import DeleteRouteCalculatorRequestTypeDef
def get_value() -> DeleteRouteCalculatorRequestTypeDef:
return {
"CalculatorName": ...,
}
# DeleteRouteCalculatorRequestTypeDef definition
class DeleteRouteCalculatorRequestTypeDef(TypedDict):
CalculatorName: str,DeleteTrackerRequestTypeDef#
# DeleteTrackerRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import DeleteTrackerRequestTypeDef
def get_value() -> DeleteTrackerRequestTypeDef:
return {
"TrackerName": ...,
}
# DeleteTrackerRequestTypeDef definition
class DeleteTrackerRequestTypeDef(TypedDict):
TrackerName: str,DescribeGeofenceCollectionRequestTypeDef#
# DescribeGeofenceCollectionRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import DescribeGeofenceCollectionRequestTypeDef
def get_value() -> DescribeGeofenceCollectionRequestTypeDef:
return {
"CollectionName": ...,
}
# DescribeGeofenceCollectionRequestTypeDef definition
class DescribeGeofenceCollectionRequestTypeDef(TypedDict):
CollectionName: str,DescribeKeyRequestTypeDef#
# DescribeKeyRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import DescribeKeyRequestTypeDef
def get_value() -> DescribeKeyRequestTypeDef:
return {
"KeyName": ...,
}
# DescribeKeyRequestTypeDef definition
class DescribeKeyRequestTypeDef(TypedDict):
KeyName: str,DescribeMapRequestTypeDef#
# DescribeMapRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import DescribeMapRequestTypeDef
def get_value() -> DescribeMapRequestTypeDef:
return {
"MapName": ...,
}
# DescribeMapRequestTypeDef definition
class DescribeMapRequestTypeDef(TypedDict):
MapName: str,MapConfigurationOutputTypeDef#
# MapConfigurationOutputTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import MapConfigurationOutputTypeDef
def get_value() -> MapConfigurationOutputTypeDef:
return {
"Style": ...,
}
# MapConfigurationOutputTypeDef definition
class MapConfigurationOutputTypeDef(TypedDict):
Style: str,
PoliticalView: NotRequired[str],
CustomLayers: NotRequired[List[str]],DescribePlaceIndexRequestTypeDef#
# DescribePlaceIndexRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import DescribePlaceIndexRequestTypeDef
def get_value() -> DescribePlaceIndexRequestTypeDef:
return {
"IndexName": ...,
}
# DescribePlaceIndexRequestTypeDef definition
class DescribePlaceIndexRequestTypeDef(TypedDict):
IndexName: str,DescribeRouteCalculatorRequestTypeDef#
# DescribeRouteCalculatorRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import DescribeRouteCalculatorRequestTypeDef
def get_value() -> DescribeRouteCalculatorRequestTypeDef:
return {
"CalculatorName": ...,
}
# DescribeRouteCalculatorRequestTypeDef definition
class DescribeRouteCalculatorRequestTypeDef(TypedDict):
CalculatorName: str,DescribeTrackerRequestTypeDef#
# DescribeTrackerRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import DescribeTrackerRequestTypeDef
def get_value() -> DescribeTrackerRequestTypeDef:
return {
"TrackerName": ...,
}
# DescribeTrackerRequestTypeDef definition
class DescribeTrackerRequestTypeDef(TypedDict):
TrackerName: str,PositionalAccuracyTypeDef#
# PositionalAccuracyTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import PositionalAccuracyTypeDef
def get_value() -> PositionalAccuracyTypeDef:
return {
"Horizontal": ...,
}
# PositionalAccuracyTypeDef definition
class PositionalAccuracyTypeDef(TypedDict):
Horizontal: float,WiFiAccessPointTypeDef#
# WiFiAccessPointTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import WiFiAccessPointTypeDef
def get_value() -> WiFiAccessPointTypeDef:
return {
"MacAddress": ...,
}
# WiFiAccessPointTypeDef definition
class WiFiAccessPointTypeDef(TypedDict):
MacAddress: str,
Rss: int,DisassociateTrackerConsumerRequestTypeDef#
# DisassociateTrackerConsumerRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import DisassociateTrackerConsumerRequestTypeDef
def get_value() -> DisassociateTrackerConsumerRequestTypeDef:
return {
"TrackerName": ...,
}
# DisassociateTrackerConsumerRequestTypeDef definition
class DisassociateTrackerConsumerRequestTypeDef(TypedDict):
TrackerName: str,
ConsumerArn: str,ForecastGeofenceEventsDeviceStateTypeDef#
# ForecastGeofenceEventsDeviceStateTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ForecastGeofenceEventsDeviceStateTypeDef
def get_value() -> ForecastGeofenceEventsDeviceStateTypeDef:
return {
"Position": ...,
}
# ForecastGeofenceEventsDeviceStateTypeDef definition
class ForecastGeofenceEventsDeviceStateTypeDef(TypedDict):
Position: Sequence[float],
Speed: NotRequired[float],PaginatorConfigTypeDef#
# PaginatorConfigTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],ForecastedEventTypeDef#
# ForecastedEventTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ForecastedEventTypeDef
def get_value() -> ForecastedEventTypeDef:
return {
"EventId": ...,
}
# ForecastedEventTypeDef definition
class ForecastedEventTypeDef(TypedDict):
EventId: str,
GeofenceId: str,
IsDeviceInGeofence: bool,
NearestDistance: float,
EventType: ForecastedGeofenceEventTypeType, # (1)
ForecastedBreachTime: NotRequired[datetime.datetime],
GeofenceProperties: NotRequired[Dict[str, str]],GetDevicePositionRequestTypeDef#
# GetDevicePositionRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import GetDevicePositionRequestTypeDef
def get_value() -> GetDevicePositionRequestTypeDef:
return {
"TrackerName": ...,
}
# GetDevicePositionRequestTypeDef definition
class GetDevicePositionRequestTypeDef(TypedDict):
TrackerName: str,
DeviceId: str,GetGeofenceRequestTypeDef#
# GetGeofenceRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import GetGeofenceRequestTypeDef
def get_value() -> GetGeofenceRequestTypeDef:
return {
"CollectionName": ...,
}
# GetGeofenceRequestTypeDef definition
class GetGeofenceRequestTypeDef(TypedDict):
CollectionName: str,
GeofenceId: str,GetMapGlyphsRequestTypeDef#
# GetMapGlyphsRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import GetMapGlyphsRequestTypeDef
def get_value() -> GetMapGlyphsRequestTypeDef:
return {
"MapName": ...,
}
# GetMapGlyphsRequestTypeDef definition
class GetMapGlyphsRequestTypeDef(TypedDict):
MapName: str,
FontStack: str,
FontUnicodeRange: str,
Key: NotRequired[str],GetMapSpritesRequestTypeDef#
# GetMapSpritesRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import GetMapSpritesRequestTypeDef
def get_value() -> GetMapSpritesRequestTypeDef:
return {
"MapName": ...,
}
# GetMapSpritesRequestTypeDef definition
class GetMapSpritesRequestTypeDef(TypedDict):
MapName: str,
FileName: str,
Key: NotRequired[str],GetMapStyleDescriptorRequestTypeDef#
# GetMapStyleDescriptorRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import GetMapStyleDescriptorRequestTypeDef
def get_value() -> GetMapStyleDescriptorRequestTypeDef:
return {
"MapName": ...,
}
# GetMapStyleDescriptorRequestTypeDef definition
class GetMapStyleDescriptorRequestTypeDef(TypedDict):
MapName: str,
Key: NotRequired[str],GetMapTileRequestTypeDef#
# GetMapTileRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import GetMapTileRequestTypeDef
def get_value() -> GetMapTileRequestTypeDef:
return {
"MapName": ...,
}
# GetMapTileRequestTypeDef definition
class GetMapTileRequestTypeDef(TypedDict):
MapName: str,
Z: str,
X: str,
Y: str,
Key: NotRequired[str],GetPlaceRequestTypeDef#
# GetPlaceRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import GetPlaceRequestTypeDef
def get_value() -> GetPlaceRequestTypeDef:
return {
"IndexName": ...,
}
# GetPlaceRequestTypeDef definition
class GetPlaceRequestTypeDef(TypedDict):
IndexName: str,
PlaceId: str,
Language: NotRequired[str],
Key: NotRequired[str],LegGeometryTypeDef#
# LegGeometryTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import LegGeometryTypeDef
def get_value() -> LegGeometryTypeDef:
return {
"LineString": ...,
}
# LegGeometryTypeDef definition
class LegGeometryTypeDef(TypedDict):
LineString: NotRequired[List[List[float]]],StepTypeDef#
# StepTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import StepTypeDef
def get_value() -> StepTypeDef:
return {
"StartPosition": ...,
}
# StepTypeDef definition
class StepTypeDef(TypedDict):
StartPosition: List[float],
EndPosition: List[float],
Distance: float,
DurationSeconds: float,
GeometryOffset: NotRequired[int],TrackingFilterGeometryTypeDef#
# TrackingFilterGeometryTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import TrackingFilterGeometryTypeDef
def get_value() -> TrackingFilterGeometryTypeDef:
return {
"Polygon": ...,
}
# TrackingFilterGeometryTypeDef definition
class TrackingFilterGeometryTypeDef(TypedDict):
Polygon: NotRequired[Sequence[Sequence[Sequence[float]]]],ListGeofenceCollectionsRequestTypeDef#
# ListGeofenceCollectionsRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListGeofenceCollectionsRequestTypeDef
def get_value() -> ListGeofenceCollectionsRequestTypeDef:
return {
"MaxResults": ...,
}
# ListGeofenceCollectionsRequestTypeDef definition
class ListGeofenceCollectionsRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],ListGeofenceCollectionsResponseEntryTypeDef#
# ListGeofenceCollectionsResponseEntryTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListGeofenceCollectionsResponseEntryTypeDef
def get_value() -> ListGeofenceCollectionsResponseEntryTypeDef:
return {
"CollectionName": ...,
}
# ListGeofenceCollectionsResponseEntryTypeDef definition
class ListGeofenceCollectionsResponseEntryTypeDef(TypedDict):
CollectionName: str,
Description: str,
CreateTime: datetime.datetime,
UpdateTime: datetime.datetime,
PricingPlan: NotRequired[PricingPlanType], # (1)
PricingPlanDataSource: NotRequired[str],- See PricingPlanType
ListGeofencesRequestTypeDef#
# ListGeofencesRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListGeofencesRequestTypeDef
def get_value() -> ListGeofencesRequestTypeDef:
return {
"CollectionName": ...,
}
# ListGeofencesRequestTypeDef definition
class ListGeofencesRequestTypeDef(TypedDict):
CollectionName: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],ListMapsRequestTypeDef#
# ListMapsRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListMapsRequestTypeDef
def get_value() -> ListMapsRequestTypeDef:
return {
"MaxResults": ...,
}
# ListMapsRequestTypeDef definition
class ListMapsRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],ListMapsResponseEntryTypeDef#
# ListMapsResponseEntryTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListMapsResponseEntryTypeDef
def get_value() -> ListMapsResponseEntryTypeDef:
return {
"MapName": ...,
}
# ListMapsResponseEntryTypeDef definition
class ListMapsResponseEntryTypeDef(TypedDict):
MapName: str,
Description: str,
DataSource: str,
CreateTime: datetime.datetime,
UpdateTime: datetime.datetime,
PricingPlan: NotRequired[PricingPlanType], # (1)- See PricingPlanType
ListPlaceIndexesRequestTypeDef#
# ListPlaceIndexesRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListPlaceIndexesRequestTypeDef
def get_value() -> ListPlaceIndexesRequestTypeDef:
return {
"MaxResults": ...,
}
# ListPlaceIndexesRequestTypeDef definition
class ListPlaceIndexesRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],ListPlaceIndexesResponseEntryTypeDef#
# ListPlaceIndexesResponseEntryTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListPlaceIndexesResponseEntryTypeDef
def get_value() -> ListPlaceIndexesResponseEntryTypeDef:
return {
"IndexName": ...,
}
# ListPlaceIndexesResponseEntryTypeDef definition
class ListPlaceIndexesResponseEntryTypeDef(TypedDict):
IndexName: str,
Description: str,
DataSource: str,
CreateTime: datetime.datetime,
UpdateTime: datetime.datetime,
PricingPlan: NotRequired[PricingPlanType], # (1)- See PricingPlanType
ListRouteCalculatorsRequestTypeDef#
# ListRouteCalculatorsRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListRouteCalculatorsRequestTypeDef
def get_value() -> ListRouteCalculatorsRequestTypeDef:
return {
"MaxResults": ...,
}
# ListRouteCalculatorsRequestTypeDef definition
class ListRouteCalculatorsRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],ListRouteCalculatorsResponseEntryTypeDef#
# ListRouteCalculatorsResponseEntryTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListRouteCalculatorsResponseEntryTypeDef
def get_value() -> ListRouteCalculatorsResponseEntryTypeDef:
return {
"CalculatorName": ...,
}
# ListRouteCalculatorsResponseEntryTypeDef definition
class ListRouteCalculatorsResponseEntryTypeDef(TypedDict):
CalculatorName: str,
Description: str,
DataSource: str,
CreateTime: datetime.datetime,
UpdateTime: datetime.datetime,
PricingPlan: NotRequired[PricingPlanType], # (1)- See PricingPlanType
ListTagsForResourceRequestTypeDef#
# ListTagsForResourceRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListTagsForResourceRequestTypeDef
def get_value() -> ListTagsForResourceRequestTypeDef:
return {
"ResourceArn": ...,
}
# ListTagsForResourceRequestTypeDef definition
class ListTagsForResourceRequestTypeDef(TypedDict):
ResourceArn: str,ListTrackerConsumersRequestTypeDef#
# ListTrackerConsumersRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListTrackerConsumersRequestTypeDef
def get_value() -> ListTrackerConsumersRequestTypeDef:
return {
"TrackerName": ...,
}
# ListTrackerConsumersRequestTypeDef definition
class ListTrackerConsumersRequestTypeDef(TypedDict):
TrackerName: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],ListTrackersRequestTypeDef#
# ListTrackersRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListTrackersRequestTypeDef
def get_value() -> ListTrackersRequestTypeDef:
return {
"MaxResults": ...,
}
# ListTrackersRequestTypeDef definition
class ListTrackersRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],ListTrackersResponseEntryTypeDef#
# ListTrackersResponseEntryTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListTrackersResponseEntryTypeDef
def get_value() -> ListTrackersResponseEntryTypeDef:
return {
"TrackerName": ...,
}
# ListTrackersResponseEntryTypeDef definition
class ListTrackersResponseEntryTypeDef(TypedDict):
TrackerName: str,
Description: str,
CreateTime: datetime.datetime,
UpdateTime: datetime.datetime,
PricingPlan: NotRequired[PricingPlanType], # (1)
PricingPlanDataSource: NotRequired[str],- See PricingPlanType
LteLocalIdTypeDef#
# LteLocalIdTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import LteLocalIdTypeDef
def get_value() -> LteLocalIdTypeDef:
return {
"Earfcn": ...,
}
# LteLocalIdTypeDef definition
class LteLocalIdTypeDef(TypedDict):
Earfcn: int,
Pci: int,LteNetworkMeasurementsTypeDef#
# LteNetworkMeasurementsTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import LteNetworkMeasurementsTypeDef
def get_value() -> LteNetworkMeasurementsTypeDef:
return {
"Earfcn": ...,
}
# LteNetworkMeasurementsTypeDef definition
class LteNetworkMeasurementsTypeDef(TypedDict):
Earfcn: int,
CellId: int,
Pci: int,
Rsrp: NotRequired[int],
Rsrq: NotRequired[float],MapConfigurationTypeDef#
# MapConfigurationTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import MapConfigurationTypeDef
def get_value() -> MapConfigurationTypeDef:
return {
"Style": ...,
}
# MapConfigurationTypeDef definition
class MapConfigurationTypeDef(TypedDict):
Style: str,
PoliticalView: NotRequired[str],
CustomLayers: NotRequired[Sequence[str]],MapConfigurationUpdateTypeDef#
# MapConfigurationUpdateTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import MapConfigurationUpdateTypeDef
def get_value() -> MapConfigurationUpdateTypeDef:
return {
"PoliticalView": ...,
}
# MapConfigurationUpdateTypeDef definition
class MapConfigurationUpdateTypeDef(TypedDict):
PoliticalView: NotRequired[str],
CustomLayers: NotRequired[Sequence[str]],PlaceGeometryTypeDef#
# PlaceGeometryTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import PlaceGeometryTypeDef
def get_value() -> PlaceGeometryTypeDef:
return {
"Point": ...,
}
# PlaceGeometryTypeDef definition
class PlaceGeometryTypeDef(TypedDict):
Point: NotRequired[List[float]],TimeZoneTypeDef#
# TimeZoneTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import TimeZoneTypeDef
def get_value() -> TimeZoneTypeDef:
return {
"Name": ...,
}
# TimeZoneTypeDef definition
class TimeZoneTypeDef(TypedDict):
Name: str,
Offset: NotRequired[int],RouteMatrixEntryErrorTypeDef#
# RouteMatrixEntryErrorTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import RouteMatrixEntryErrorTypeDef
def get_value() -> RouteMatrixEntryErrorTypeDef:
return {
"Code": ...,
}
# RouteMatrixEntryErrorTypeDef definition
class RouteMatrixEntryErrorTypeDef(TypedDict):
Code: RouteMatrixErrorCodeType, # (1)
Message: NotRequired[str],SearchForSuggestionsResultTypeDef#
# SearchForSuggestionsResultTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import SearchForSuggestionsResultTypeDef
def get_value() -> SearchForSuggestionsResultTypeDef:
return {
"Text": ...,
}
# SearchForSuggestionsResultTypeDef definition
class SearchForSuggestionsResultTypeDef(TypedDict):
Text: str,
PlaceId: NotRequired[str],
Categories: NotRequired[List[str]],
SupplementalCategories: NotRequired[List[str]],SearchPlaceIndexForPositionRequestTypeDef#
# SearchPlaceIndexForPositionRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import SearchPlaceIndexForPositionRequestTypeDef
def get_value() -> SearchPlaceIndexForPositionRequestTypeDef:
return {
"IndexName": ...,
}
# SearchPlaceIndexForPositionRequestTypeDef definition
class SearchPlaceIndexForPositionRequestTypeDef(TypedDict):
IndexName: str,
Position: Sequence[float],
MaxResults: NotRequired[int],
Language: NotRequired[str],
Key: NotRequired[str],SearchPlaceIndexForPositionSummaryTypeDef#
# SearchPlaceIndexForPositionSummaryTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import SearchPlaceIndexForPositionSummaryTypeDef
def get_value() -> SearchPlaceIndexForPositionSummaryTypeDef:
return {
"Position": ...,
}
# SearchPlaceIndexForPositionSummaryTypeDef definition
class SearchPlaceIndexForPositionSummaryTypeDef(TypedDict):
Position: List[float],
DataSource: str,
MaxResults: NotRequired[int],
Language: NotRequired[str],SearchPlaceIndexForSuggestionsRequestTypeDef#
# SearchPlaceIndexForSuggestionsRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import SearchPlaceIndexForSuggestionsRequestTypeDef
def get_value() -> SearchPlaceIndexForSuggestionsRequestTypeDef:
return {
"IndexName": ...,
}
# SearchPlaceIndexForSuggestionsRequestTypeDef definition
class SearchPlaceIndexForSuggestionsRequestTypeDef(TypedDict):
IndexName: str,
Text: str,
BiasPosition: NotRequired[Sequence[float]],
FilterBBox: NotRequired[Sequence[float]],
FilterCountries: NotRequired[Sequence[str]],
MaxResults: NotRequired[int],
Language: NotRequired[str],
FilterCategories: NotRequired[Sequence[str]],
Key: NotRequired[str],SearchPlaceIndexForSuggestionsSummaryTypeDef#
# SearchPlaceIndexForSuggestionsSummaryTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import SearchPlaceIndexForSuggestionsSummaryTypeDef
def get_value() -> SearchPlaceIndexForSuggestionsSummaryTypeDef:
return {
"Text": ...,
}
# SearchPlaceIndexForSuggestionsSummaryTypeDef definition
class SearchPlaceIndexForSuggestionsSummaryTypeDef(TypedDict):
Text: str,
DataSource: str,
BiasPosition: NotRequired[List[float]],
FilterBBox: NotRequired[List[float]],
FilterCountries: NotRequired[List[str]],
MaxResults: NotRequired[int],
Language: NotRequired[str],
FilterCategories: NotRequired[List[str]],SearchPlaceIndexForTextRequestTypeDef#
# SearchPlaceIndexForTextRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import SearchPlaceIndexForTextRequestTypeDef
def get_value() -> SearchPlaceIndexForTextRequestTypeDef:
return {
"IndexName": ...,
}
# SearchPlaceIndexForTextRequestTypeDef definition
class SearchPlaceIndexForTextRequestTypeDef(TypedDict):
IndexName: str,
Text: str,
BiasPosition: NotRequired[Sequence[float]],
FilterBBox: NotRequired[Sequence[float]],
FilterCountries: NotRequired[Sequence[str]],
MaxResults: NotRequired[int],
Language: NotRequired[str],
FilterCategories: NotRequired[Sequence[str]],
Key: NotRequired[str],SearchPlaceIndexForTextSummaryTypeDef#
# SearchPlaceIndexForTextSummaryTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import SearchPlaceIndexForTextSummaryTypeDef
def get_value() -> SearchPlaceIndexForTextSummaryTypeDef:
return {
"Text": ...,
}
# SearchPlaceIndexForTextSummaryTypeDef definition
class SearchPlaceIndexForTextSummaryTypeDef(TypedDict):
Text: str,
DataSource: str,
BiasPosition: NotRequired[List[float]],
FilterBBox: NotRequired[List[float]],
FilterCountries: NotRequired[List[str]],
MaxResults: NotRequired[int],
ResultBBox: NotRequired[List[float]],
Language: NotRequired[str],
FilterCategories: NotRequired[List[str]],TagResourceRequestTypeDef#
# TagResourceRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import TagResourceRequestTypeDef
def get_value() -> TagResourceRequestTypeDef:
return {
"ResourceArn": ...,
}
# TagResourceRequestTypeDef definition
class TagResourceRequestTypeDef(TypedDict):
ResourceArn: str,
Tags: Mapping[str, str],UntagResourceRequestTypeDef#
# UntagResourceRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import UntagResourceRequestTypeDef
def get_value() -> UntagResourceRequestTypeDef:
return {
"ResourceArn": ...,
}
# UntagResourceRequestTypeDef definition
class UntagResourceRequestTypeDef(TypedDict):
ResourceArn: str,
TagKeys: Sequence[str],UpdateGeofenceCollectionRequestTypeDef#
# UpdateGeofenceCollectionRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import UpdateGeofenceCollectionRequestTypeDef
def get_value() -> UpdateGeofenceCollectionRequestTypeDef:
return {
"CollectionName": ...,
}
# UpdateGeofenceCollectionRequestTypeDef definition
class UpdateGeofenceCollectionRequestTypeDef(TypedDict):
CollectionName: str,
PricingPlan: NotRequired[PricingPlanType], # (1)
PricingPlanDataSource: NotRequired[str],
Description: NotRequired[str],- See PricingPlanType
UpdateRouteCalculatorRequestTypeDef#
# UpdateRouteCalculatorRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import UpdateRouteCalculatorRequestTypeDef
def get_value() -> UpdateRouteCalculatorRequestTypeDef:
return {
"CalculatorName": ...,
}
# UpdateRouteCalculatorRequestTypeDef definition
class UpdateRouteCalculatorRequestTypeDef(TypedDict):
CalculatorName: str,
PricingPlan: NotRequired[PricingPlanType], # (1)
Description: NotRequired[str],- See PricingPlanType
UpdateTrackerRequestTypeDef#
# UpdateTrackerRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import UpdateTrackerRequestTypeDef
def get_value() -> UpdateTrackerRequestTypeDef:
return {
"TrackerName": ...,
}
# UpdateTrackerRequestTypeDef definition
class UpdateTrackerRequestTypeDef(TypedDict):
TrackerName: str,
PricingPlan: NotRequired[PricingPlanType], # (1)
PricingPlanDataSource: NotRequired[str],
Description: NotRequired[str],
PositionFiltering: NotRequired[PositionFilteringType], # (2)
EventBridgeEnabled: NotRequired[bool],
KmsKeyEnableGeospatialQueries: NotRequired[bool],- See PricingPlanType
- See PositionFilteringType
ListKeysRequestTypeDef#
# ListKeysRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListKeysRequestTypeDef
def get_value() -> ListKeysRequestTypeDef:
return {
"MaxResults": ...,
}
# ListKeysRequestTypeDef definition
class ListKeysRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
Filter: NotRequired[ApiKeyFilterTypeDef], # (1)ListKeysResponseEntryTypeDef#
# ListKeysResponseEntryTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListKeysResponseEntryTypeDef
def get_value() -> ListKeysResponseEntryTypeDef:
return {
"KeyName": ...,
}
# ListKeysResponseEntryTypeDef definition
class ListKeysResponseEntryTypeDef(TypedDict):
KeyName: str,
ExpireTime: datetime.datetime,
Restrictions: ApiKeyRestrictionsOutputTypeDef, # (1)
CreateTime: datetime.datetime,
UpdateTime: datetime.datetime,
Description: NotRequired[str],BatchDeleteDevicePositionHistoryErrorTypeDef#
# BatchDeleteDevicePositionHistoryErrorTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import BatchDeleteDevicePositionHistoryErrorTypeDef
def get_value() -> BatchDeleteDevicePositionHistoryErrorTypeDef:
return {
"DeviceId": ...,
}
# BatchDeleteDevicePositionHistoryErrorTypeDef definition
class BatchDeleteDevicePositionHistoryErrorTypeDef(TypedDict):
DeviceId: str,
Error: BatchItemErrorTypeDef, # (1)BatchDeleteGeofenceErrorTypeDef#
# BatchDeleteGeofenceErrorTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import BatchDeleteGeofenceErrorTypeDef
def get_value() -> BatchDeleteGeofenceErrorTypeDef:
return {
"GeofenceId": ...,
}
# BatchDeleteGeofenceErrorTypeDef definition
class BatchDeleteGeofenceErrorTypeDef(TypedDict):
GeofenceId: str,
Error: BatchItemErrorTypeDef, # (1)BatchEvaluateGeofencesErrorTypeDef#
# BatchEvaluateGeofencesErrorTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import BatchEvaluateGeofencesErrorTypeDef
def get_value() -> BatchEvaluateGeofencesErrorTypeDef:
return {
"DeviceId": ...,
}
# BatchEvaluateGeofencesErrorTypeDef definition
class BatchEvaluateGeofencesErrorTypeDef(TypedDict):
DeviceId: str,
SampleTime: datetime.datetime,
Error: BatchItemErrorTypeDef, # (1)BatchGetDevicePositionErrorTypeDef#
# BatchGetDevicePositionErrorTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import BatchGetDevicePositionErrorTypeDef
def get_value() -> BatchGetDevicePositionErrorTypeDef:
return {
"DeviceId": ...,
}
# BatchGetDevicePositionErrorTypeDef definition
class BatchGetDevicePositionErrorTypeDef(TypedDict):
DeviceId: str,
Error: BatchItemErrorTypeDef, # (1)BatchPutGeofenceErrorTypeDef#
# BatchPutGeofenceErrorTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import BatchPutGeofenceErrorTypeDef
def get_value() -> BatchPutGeofenceErrorTypeDef:
return {
"GeofenceId": ...,
}
# BatchPutGeofenceErrorTypeDef definition
class BatchPutGeofenceErrorTypeDef(TypedDict):
GeofenceId: str,
Error: BatchItemErrorTypeDef, # (1)BatchUpdateDevicePositionErrorTypeDef#
# BatchUpdateDevicePositionErrorTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import BatchUpdateDevicePositionErrorTypeDef
def get_value() -> BatchUpdateDevicePositionErrorTypeDef:
return {
"DeviceId": ...,
}
# BatchUpdateDevicePositionErrorTypeDef definition
class BatchUpdateDevicePositionErrorTypeDef(TypedDict):
DeviceId: str,
SampleTime: datetime.datetime,
Error: BatchItemErrorTypeDef, # (1)CreateGeofenceCollectionResponseTypeDef#
# CreateGeofenceCollectionResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import CreateGeofenceCollectionResponseTypeDef
def get_value() -> CreateGeofenceCollectionResponseTypeDef:
return {
"CollectionName": ...,
}
# CreateGeofenceCollectionResponseTypeDef definition
class CreateGeofenceCollectionResponseTypeDef(TypedDict):
CollectionName: str,
CollectionArn: str,
CreateTime: datetime.datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateKeyResponseTypeDef#
# CreateKeyResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import CreateKeyResponseTypeDef
def get_value() -> CreateKeyResponseTypeDef:
return {
"Key": ...,
}
# CreateKeyResponseTypeDef definition
class CreateKeyResponseTypeDef(TypedDict):
Key: str,
KeyArn: str,
KeyName: str,
CreateTime: datetime.datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateMapResponseTypeDef#
# CreateMapResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import CreateMapResponseTypeDef
def get_value() -> CreateMapResponseTypeDef:
return {
"MapName": ...,
}
# CreateMapResponseTypeDef definition
class CreateMapResponseTypeDef(TypedDict):
MapName: str,
MapArn: str,
CreateTime: datetime.datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreatePlaceIndexResponseTypeDef#
# CreatePlaceIndexResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import CreatePlaceIndexResponseTypeDef
def get_value() -> CreatePlaceIndexResponseTypeDef:
return {
"IndexName": ...,
}
# CreatePlaceIndexResponseTypeDef definition
class CreatePlaceIndexResponseTypeDef(TypedDict):
IndexName: str,
IndexArn: str,
CreateTime: datetime.datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateRouteCalculatorResponseTypeDef#
# CreateRouteCalculatorResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import CreateRouteCalculatorResponseTypeDef
def get_value() -> CreateRouteCalculatorResponseTypeDef:
return {
"CalculatorName": ...,
}
# CreateRouteCalculatorResponseTypeDef definition
class CreateRouteCalculatorResponseTypeDef(TypedDict):
CalculatorName: str,
CalculatorArn: str,
CreateTime: datetime.datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateTrackerResponseTypeDef#
# CreateTrackerResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import CreateTrackerResponseTypeDef
def get_value() -> CreateTrackerResponseTypeDef:
return {
"TrackerName": ...,
}
# CreateTrackerResponseTypeDef definition
class CreateTrackerResponseTypeDef(TypedDict):
TrackerName: str,
TrackerArn: str,
CreateTime: datetime.datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)DescribeGeofenceCollectionResponseTypeDef#
# DescribeGeofenceCollectionResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import DescribeGeofenceCollectionResponseTypeDef
def get_value() -> DescribeGeofenceCollectionResponseTypeDef:
return {
"CollectionName": ...,
}
# DescribeGeofenceCollectionResponseTypeDef definition
class DescribeGeofenceCollectionResponseTypeDef(TypedDict):
CollectionName: str,
CollectionArn: str,
Description: str,
PricingPlan: PricingPlanType, # (1)
PricingPlanDataSource: str,
KmsKeyId: str,
Tags: Dict[str, str],
CreateTime: datetime.datetime,
UpdateTime: datetime.datetime,
GeofenceCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeKeyResponseTypeDef#
# DescribeKeyResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import DescribeKeyResponseTypeDef
def get_value() -> DescribeKeyResponseTypeDef:
return {
"Key": ...,
}
# DescribeKeyResponseTypeDef definition
class DescribeKeyResponseTypeDef(TypedDict):
Key: str,
KeyArn: str,
KeyName: str,
Restrictions: ApiKeyRestrictionsOutputTypeDef, # (1)
CreateTime: datetime.datetime,
ExpireTime: datetime.datetime,
UpdateTime: datetime.datetime,
Description: str,
Tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeRouteCalculatorResponseTypeDef#
# DescribeRouteCalculatorResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import DescribeRouteCalculatorResponseTypeDef
def get_value() -> DescribeRouteCalculatorResponseTypeDef:
return {
"CalculatorName": ...,
}
# DescribeRouteCalculatorResponseTypeDef definition
class DescribeRouteCalculatorResponseTypeDef(TypedDict):
CalculatorName: str,
CalculatorArn: str,
PricingPlan: PricingPlanType, # (1)
Description: str,
CreateTime: datetime.datetime,
UpdateTime: datetime.datetime,
DataSource: str,
Tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeTrackerResponseTypeDef#
# DescribeTrackerResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import DescribeTrackerResponseTypeDef
def get_value() -> DescribeTrackerResponseTypeDef:
return {
"TrackerName": ...,
}
# DescribeTrackerResponseTypeDef definition
class DescribeTrackerResponseTypeDef(TypedDict):
TrackerName: str,
TrackerArn: str,
Description: str,
PricingPlan: PricingPlanType, # (1)
PricingPlanDataSource: str,
Tags: Dict[str, str],
CreateTime: datetime.datetime,
UpdateTime: datetime.datetime,
KmsKeyId: str,
PositionFiltering: PositionFilteringType, # (2)
EventBridgeEnabled: bool,
KmsKeyEnableGeospatialQueries: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (3)GetMapGlyphsResponseTypeDef#
# GetMapGlyphsResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import GetMapGlyphsResponseTypeDef
def get_value() -> GetMapGlyphsResponseTypeDef:
return {
"Blob": ...,
}
# GetMapGlyphsResponseTypeDef definition
class GetMapGlyphsResponseTypeDef(TypedDict):
Blob: botocore.response.StreamingBody,
ContentType: str,
CacheControl: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)GetMapSpritesResponseTypeDef#
# GetMapSpritesResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import GetMapSpritesResponseTypeDef
def get_value() -> GetMapSpritesResponseTypeDef:
return {
"Blob": ...,
}
# GetMapSpritesResponseTypeDef definition
class GetMapSpritesResponseTypeDef(TypedDict):
Blob: botocore.response.StreamingBody,
ContentType: str,
CacheControl: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)GetMapStyleDescriptorResponseTypeDef#
# GetMapStyleDescriptorResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import GetMapStyleDescriptorResponseTypeDef
def get_value() -> GetMapStyleDescriptorResponseTypeDef:
return {
"Blob": ...,
}
# GetMapStyleDescriptorResponseTypeDef definition
class GetMapStyleDescriptorResponseTypeDef(TypedDict):
Blob: botocore.response.StreamingBody,
ContentType: str,
CacheControl: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)GetMapTileResponseTypeDef#
# GetMapTileResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import GetMapTileResponseTypeDef
def get_value() -> GetMapTileResponseTypeDef:
return {
"Blob": ...,
}
# GetMapTileResponseTypeDef definition
class GetMapTileResponseTypeDef(TypedDict):
Blob: botocore.response.StreamingBody,
ContentType: str,
CacheControl: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"Tags": ...,
}
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)ListTrackerConsumersResponseTypeDef#
# ListTrackerConsumersResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListTrackerConsumersResponseTypeDef
def get_value() -> ListTrackerConsumersResponseTypeDef:
return {
"ConsumerArns": ...,
}
# ListTrackerConsumersResponseTypeDef definition
class ListTrackerConsumersResponseTypeDef(TypedDict):
ConsumerArns: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
NextToken: NotRequired[str],PutGeofenceResponseTypeDef#
# PutGeofenceResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import PutGeofenceResponseTypeDef
def get_value() -> PutGeofenceResponseTypeDef:
return {
"GeofenceId": ...,
}
# PutGeofenceResponseTypeDef definition
class PutGeofenceResponseTypeDef(TypedDict):
GeofenceId: str,
CreateTime: datetime.datetime,
UpdateTime: datetime.datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdateGeofenceCollectionResponseTypeDef#
# UpdateGeofenceCollectionResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import UpdateGeofenceCollectionResponseTypeDef
def get_value() -> UpdateGeofenceCollectionResponseTypeDef:
return {
"CollectionName": ...,
}
# UpdateGeofenceCollectionResponseTypeDef definition
class UpdateGeofenceCollectionResponseTypeDef(TypedDict):
CollectionName: str,
CollectionArn: str,
UpdateTime: datetime.datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdateKeyResponseTypeDef#
# UpdateKeyResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import UpdateKeyResponseTypeDef
def get_value() -> UpdateKeyResponseTypeDef:
return {
"KeyArn": ...,
}
# UpdateKeyResponseTypeDef definition
class UpdateKeyResponseTypeDef(TypedDict):
KeyArn: str,
KeyName: str,
UpdateTime: datetime.datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdateMapResponseTypeDef#
# UpdateMapResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import UpdateMapResponseTypeDef
def get_value() -> UpdateMapResponseTypeDef:
return {
"MapName": ...,
}
# UpdateMapResponseTypeDef definition
class UpdateMapResponseTypeDef(TypedDict):
MapName: str,
MapArn: str,
UpdateTime: datetime.datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdatePlaceIndexResponseTypeDef#
# UpdatePlaceIndexResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import UpdatePlaceIndexResponseTypeDef
def get_value() -> UpdatePlaceIndexResponseTypeDef:
return {
"IndexName": ...,
}
# UpdatePlaceIndexResponseTypeDef definition
class UpdatePlaceIndexResponseTypeDef(TypedDict):
IndexName: str,
IndexArn: str,
UpdateTime: datetime.datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdateRouteCalculatorResponseTypeDef#
# UpdateRouteCalculatorResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import UpdateRouteCalculatorResponseTypeDef
def get_value() -> UpdateRouteCalculatorResponseTypeDef:
return {
"CalculatorName": ...,
}
# UpdateRouteCalculatorResponseTypeDef definition
class UpdateRouteCalculatorResponseTypeDef(TypedDict):
CalculatorName: str,
CalculatorArn: str,
UpdateTime: datetime.datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdateTrackerResponseTypeDef#
# UpdateTrackerResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import UpdateTrackerResponseTypeDef
def get_value() -> UpdateTrackerResponseTypeDef:
return {
"TrackerName": ...,
}
# UpdateTrackerResponseTypeDef definition
class UpdateTrackerResponseTypeDef(TypedDict):
TrackerName: str,
TrackerArn: str,
UpdateTime: datetime.datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)GetDevicePositionHistoryRequestTypeDef#
# GetDevicePositionHistoryRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import GetDevicePositionHistoryRequestTypeDef
def get_value() -> GetDevicePositionHistoryRequestTypeDef:
return {
"TrackerName": ...,
}
# GetDevicePositionHistoryRequestTypeDef definition
class GetDevicePositionHistoryRequestTypeDef(TypedDict):
TrackerName: str,
DeviceId: str,
NextToken: NotRequired[str],
StartTimeInclusive: NotRequired[TimestampTypeDef],
EndTimeExclusive: NotRequired[TimestampTypeDef],
MaxResults: NotRequired[int],CalculateRouteTruckModeOptionsTypeDef#
# CalculateRouteTruckModeOptionsTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import CalculateRouteTruckModeOptionsTypeDef
def get_value() -> CalculateRouteTruckModeOptionsTypeDef:
return {
"AvoidFerries": ...,
}
# CalculateRouteTruckModeOptionsTypeDef definition
class CalculateRouteTruckModeOptionsTypeDef(TypedDict):
AvoidFerries: NotRequired[bool],
AvoidTolls: NotRequired[bool],
Dimensions: NotRequired[TruckDimensionsTypeDef], # (1)
Weight: NotRequired[TruckWeightTypeDef], # (2)GeofenceGeometryOutputTypeDef#
# GeofenceGeometryOutputTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import GeofenceGeometryOutputTypeDef
def get_value() -> GeofenceGeometryOutputTypeDef:
return {
"Polygon": ...,
}
# GeofenceGeometryOutputTypeDef definition
class GeofenceGeometryOutputTypeDef(TypedDict):
Polygon: NotRequired[List[List[List[float]]]],
Circle: NotRequired[CircleOutputTypeDef], # (1)
Geobuf: NotRequired[bytes],CreatePlaceIndexRequestTypeDef#
# CreatePlaceIndexRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import CreatePlaceIndexRequestTypeDef
def get_value() -> CreatePlaceIndexRequestTypeDef:
return {
"IndexName": ...,
}
# CreatePlaceIndexRequestTypeDef definition
class CreatePlaceIndexRequestTypeDef(TypedDict):
IndexName: str,
DataSource: str,
PricingPlan: NotRequired[PricingPlanType], # (1)
Description: NotRequired[str],
DataSourceConfiguration: NotRequired[DataSourceConfigurationTypeDef], # (2)
Tags: NotRequired[Mapping[str, str]],DescribePlaceIndexResponseTypeDef#
# DescribePlaceIndexResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import DescribePlaceIndexResponseTypeDef
def get_value() -> DescribePlaceIndexResponseTypeDef:
return {
"IndexName": ...,
}
# DescribePlaceIndexResponseTypeDef definition
class DescribePlaceIndexResponseTypeDef(TypedDict):
IndexName: str,
IndexArn: str,
PricingPlan: PricingPlanType, # (1)
Description: str,
CreateTime: datetime.datetime,
UpdateTime: datetime.datetime,
DataSource: str,
DataSourceConfiguration: DataSourceConfigurationTypeDef, # (2)
Tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (3)UpdatePlaceIndexRequestTypeDef#
# UpdatePlaceIndexRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import UpdatePlaceIndexRequestTypeDef
def get_value() -> UpdatePlaceIndexRequestTypeDef:
return {
"IndexName": ...,
}
# UpdatePlaceIndexRequestTypeDef definition
class UpdatePlaceIndexRequestTypeDef(TypedDict):
IndexName: str,
PricingPlan: NotRequired[PricingPlanType], # (1)
Description: NotRequired[str],
DataSourceConfiguration: NotRequired[DataSourceConfigurationTypeDef], # (2)DescribeMapResponseTypeDef#
# DescribeMapResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import DescribeMapResponseTypeDef
def get_value() -> DescribeMapResponseTypeDef:
return {
"MapName": ...,
}
# DescribeMapResponseTypeDef definition
class DescribeMapResponseTypeDef(TypedDict):
MapName: str,
MapArn: str,
PricingPlan: PricingPlanType, # (1)
DataSource: str,
Configuration: MapConfigurationOutputTypeDef, # (2)
Description: str,
Tags: Dict[str, str],
CreateTime: datetime.datetime,
UpdateTime: datetime.datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (3)DevicePositionTypeDef#
# DevicePositionTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import DevicePositionTypeDef
def get_value() -> DevicePositionTypeDef:
return {
"DeviceId": ...,
}
# DevicePositionTypeDef definition
class DevicePositionTypeDef(TypedDict):
SampleTime: datetime.datetime,
ReceivedTime: datetime.datetime,
Position: List[float],
DeviceId: NotRequired[str],
Accuracy: NotRequired[PositionalAccuracyTypeDef], # (1)
PositionProperties: NotRequired[Dict[str, str]],DevicePositionUpdateTypeDef#
# DevicePositionUpdateTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import DevicePositionUpdateTypeDef
def get_value() -> DevicePositionUpdateTypeDef:
return {
"DeviceId": ...,
}
# DevicePositionUpdateTypeDef definition
class DevicePositionUpdateTypeDef(TypedDict):
DeviceId: str,
SampleTime: TimestampTypeDef,
Position: Sequence[float],
Accuracy: NotRequired[PositionalAccuracyTypeDef], # (1)
PositionProperties: NotRequired[Mapping[str, str]],GetDevicePositionResponseTypeDef#
# GetDevicePositionResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import GetDevicePositionResponseTypeDef
def get_value() -> GetDevicePositionResponseTypeDef:
return {
"DeviceId": ...,
}
# GetDevicePositionResponseTypeDef definition
class GetDevicePositionResponseTypeDef(TypedDict):
DeviceId: str,
SampleTime: datetime.datetime,
ReceivedTime: datetime.datetime,
Position: List[float],
Accuracy: PositionalAccuracyTypeDef, # (1)
PositionProperties: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)InferredStateTypeDef#
# InferredStateTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import InferredStateTypeDef
def get_value() -> InferredStateTypeDef:
return {
"Position": ...,
}
# InferredStateTypeDef definition
class InferredStateTypeDef(TypedDict):
ProxyDetected: bool,
Position: NotRequired[List[float]],
Accuracy: NotRequired[PositionalAccuracyTypeDef], # (1)
DeviationDistance: NotRequired[float],ListDevicePositionsResponseEntryTypeDef#
# ListDevicePositionsResponseEntryTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListDevicePositionsResponseEntryTypeDef
def get_value() -> ListDevicePositionsResponseEntryTypeDef:
return {
"DeviceId": ...,
}
# ListDevicePositionsResponseEntryTypeDef definition
class ListDevicePositionsResponseEntryTypeDef(TypedDict):
DeviceId: str,
SampleTime: datetime.datetime,
Position: List[float],
Accuracy: NotRequired[PositionalAccuracyTypeDef], # (1)
PositionProperties: NotRequired[Dict[str, str]],ForecastGeofenceEventsRequestTypeDef#
# ForecastGeofenceEventsRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ForecastGeofenceEventsRequestTypeDef
def get_value() -> ForecastGeofenceEventsRequestTypeDef:
return {
"CollectionName": ...,
}
# ForecastGeofenceEventsRequestTypeDef definition
class ForecastGeofenceEventsRequestTypeDef(TypedDict):
CollectionName: str,
DeviceState: ForecastGeofenceEventsDeviceStateTypeDef, # (1)
TimeHorizonMinutes: NotRequired[float],
DistanceUnit: NotRequired[DistanceUnitType], # (2)
SpeedUnit: NotRequired[SpeedUnitType], # (3)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],ForecastGeofenceEventsRequestPaginateTypeDef#
# ForecastGeofenceEventsRequestPaginateTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ForecastGeofenceEventsRequestPaginateTypeDef
def get_value() -> ForecastGeofenceEventsRequestPaginateTypeDef:
return {
"CollectionName": ...,
}
# ForecastGeofenceEventsRequestPaginateTypeDef definition
class ForecastGeofenceEventsRequestPaginateTypeDef(TypedDict):
CollectionName: str,
DeviceState: ForecastGeofenceEventsDeviceStateTypeDef, # (1)
TimeHorizonMinutes: NotRequired[float],
DistanceUnit: NotRequired[DistanceUnitType], # (2)
SpeedUnit: NotRequired[SpeedUnitType], # (3)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (4)- See ForecastGeofenceEventsDeviceStateTypeDef
- See DistanceUnitType
- See SpeedUnitType
- See PaginatorConfigTypeDef
GetDevicePositionHistoryRequestPaginateTypeDef#
# GetDevicePositionHistoryRequestPaginateTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import GetDevicePositionHistoryRequestPaginateTypeDef
def get_value() -> GetDevicePositionHistoryRequestPaginateTypeDef:
return {
"TrackerName": ...,
}
# GetDevicePositionHistoryRequestPaginateTypeDef definition
class GetDevicePositionHistoryRequestPaginateTypeDef(TypedDict):
TrackerName: str,
DeviceId: str,
StartTimeInclusive: NotRequired[TimestampTypeDef],
EndTimeExclusive: NotRequired[TimestampTypeDef],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListGeofenceCollectionsRequestPaginateTypeDef#
# ListGeofenceCollectionsRequestPaginateTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListGeofenceCollectionsRequestPaginateTypeDef
def get_value() -> ListGeofenceCollectionsRequestPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListGeofenceCollectionsRequestPaginateTypeDef definition
class ListGeofenceCollectionsRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListGeofencesRequestPaginateTypeDef#
# ListGeofencesRequestPaginateTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListGeofencesRequestPaginateTypeDef
def get_value() -> ListGeofencesRequestPaginateTypeDef:
return {
"CollectionName": ...,
}
# ListGeofencesRequestPaginateTypeDef definition
class ListGeofencesRequestPaginateTypeDef(TypedDict):
CollectionName: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListKeysRequestPaginateTypeDef#
# ListKeysRequestPaginateTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListKeysRequestPaginateTypeDef
def get_value() -> ListKeysRequestPaginateTypeDef:
return {
"Filter": ...,
}
# ListKeysRequestPaginateTypeDef definition
class ListKeysRequestPaginateTypeDef(TypedDict):
Filter: NotRequired[ApiKeyFilterTypeDef], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListMapsRequestPaginateTypeDef#
# ListMapsRequestPaginateTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListMapsRequestPaginateTypeDef
def get_value() -> ListMapsRequestPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListMapsRequestPaginateTypeDef definition
class ListMapsRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListPlaceIndexesRequestPaginateTypeDef#
# ListPlaceIndexesRequestPaginateTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListPlaceIndexesRequestPaginateTypeDef
def get_value() -> ListPlaceIndexesRequestPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListPlaceIndexesRequestPaginateTypeDef definition
class ListPlaceIndexesRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListRouteCalculatorsRequestPaginateTypeDef#
# ListRouteCalculatorsRequestPaginateTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListRouteCalculatorsRequestPaginateTypeDef
def get_value() -> ListRouteCalculatorsRequestPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListRouteCalculatorsRequestPaginateTypeDef definition
class ListRouteCalculatorsRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListTrackerConsumersRequestPaginateTypeDef#
# ListTrackerConsumersRequestPaginateTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListTrackerConsumersRequestPaginateTypeDef
def get_value() -> ListTrackerConsumersRequestPaginateTypeDef:
return {
"TrackerName": ...,
}
# ListTrackerConsumersRequestPaginateTypeDef definition
class ListTrackerConsumersRequestPaginateTypeDef(TypedDict):
TrackerName: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListTrackersRequestPaginateTypeDef#
# ListTrackersRequestPaginateTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListTrackersRequestPaginateTypeDef
def get_value() -> ListTrackersRequestPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListTrackersRequestPaginateTypeDef definition
class ListTrackersRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ForecastGeofenceEventsResponseTypeDef#
# ForecastGeofenceEventsResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ForecastGeofenceEventsResponseTypeDef
def get_value() -> ForecastGeofenceEventsResponseTypeDef:
return {
"ForecastedEvents": ...,
}
# ForecastGeofenceEventsResponseTypeDef definition
class ForecastGeofenceEventsResponseTypeDef(TypedDict):
ForecastedEvents: List[ForecastedEventTypeDef], # (1)
DistanceUnit: DistanceUnitType, # (2)
SpeedUnit: SpeedUnitType, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
NextToken: NotRequired[str],- See
List[ForecastedEventTypeDef] - See DistanceUnitType
- See SpeedUnitType
- See ResponseMetadataTypeDef
LegTypeDef#
# LegTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import LegTypeDef
def get_value() -> LegTypeDef:
return {
"StartPosition": ...,
}
# LegTypeDef definition
class LegTypeDef(TypedDict):
StartPosition: List[float],
EndPosition: List[float],
Distance: float,
DurationSeconds: float,
Steps: List[StepTypeDef], # (2)
Geometry: NotRequired[LegGeometryTypeDef], # (1)- See LegGeometryTypeDef
- See
List[StepTypeDef]
ListDevicePositionsRequestPaginateTypeDef#
# ListDevicePositionsRequestPaginateTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListDevicePositionsRequestPaginateTypeDef
def get_value() -> ListDevicePositionsRequestPaginateTypeDef:
return {
"TrackerName": ...,
}
# ListDevicePositionsRequestPaginateTypeDef definition
class ListDevicePositionsRequestPaginateTypeDef(TypedDict):
TrackerName: str,
FilterGeometry: NotRequired[TrackingFilterGeometryTypeDef], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListDevicePositionsRequestTypeDef#
# ListDevicePositionsRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListDevicePositionsRequestTypeDef
def get_value() -> ListDevicePositionsRequestTypeDef:
return {
"TrackerName": ...,
}
# ListDevicePositionsRequestTypeDef definition
class ListDevicePositionsRequestTypeDef(TypedDict):
TrackerName: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
FilterGeometry: NotRequired[TrackingFilterGeometryTypeDef], # (1)ListGeofenceCollectionsResponseTypeDef#
# ListGeofenceCollectionsResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListGeofenceCollectionsResponseTypeDef
def get_value() -> ListGeofenceCollectionsResponseTypeDef:
return {
"Entries": ...,
}
# ListGeofenceCollectionsResponseTypeDef definition
class ListGeofenceCollectionsResponseTypeDef(TypedDict):
Entries: List[ListGeofenceCollectionsResponseEntryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],- See
List[ListGeofenceCollectionsResponseEntryTypeDef] - See ResponseMetadataTypeDef
ListMapsResponseTypeDef#
# ListMapsResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListMapsResponseTypeDef
def get_value() -> ListMapsResponseTypeDef:
return {
"Entries": ...,
}
# ListMapsResponseTypeDef definition
class ListMapsResponseTypeDef(TypedDict):
Entries: List[ListMapsResponseEntryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],- See
List[ListMapsResponseEntryTypeDef] - See ResponseMetadataTypeDef
ListPlaceIndexesResponseTypeDef#
# ListPlaceIndexesResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListPlaceIndexesResponseTypeDef
def get_value() -> ListPlaceIndexesResponseTypeDef:
return {
"Entries": ...,
}
# ListPlaceIndexesResponseTypeDef definition
class ListPlaceIndexesResponseTypeDef(TypedDict):
Entries: List[ListPlaceIndexesResponseEntryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],- See
List[ListPlaceIndexesResponseEntryTypeDef] - See ResponseMetadataTypeDef
ListRouteCalculatorsResponseTypeDef#
# ListRouteCalculatorsResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListRouteCalculatorsResponseTypeDef
def get_value() -> ListRouteCalculatorsResponseTypeDef:
return {
"Entries": ...,
}
# ListRouteCalculatorsResponseTypeDef definition
class ListRouteCalculatorsResponseTypeDef(TypedDict):
Entries: List[ListRouteCalculatorsResponseEntryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],- See
List[ListRouteCalculatorsResponseEntryTypeDef] - See ResponseMetadataTypeDef
ListTrackersResponseTypeDef#
# ListTrackersResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListTrackersResponseTypeDef
def get_value() -> ListTrackersResponseTypeDef:
return {
"Entries": ...,
}
# ListTrackersResponseTypeDef definition
class ListTrackersResponseTypeDef(TypedDict):
Entries: List[ListTrackersResponseEntryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],- See
List[ListTrackersResponseEntryTypeDef] - See ResponseMetadataTypeDef
LteCellDetailsTypeDef#
# LteCellDetailsTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import LteCellDetailsTypeDef
def get_value() -> LteCellDetailsTypeDef:
return {
"CellId": ...,
}
# LteCellDetailsTypeDef definition
class LteCellDetailsTypeDef(TypedDict):
CellId: int,
Mcc: int,
Mnc: int,
LocalId: NotRequired[LteLocalIdTypeDef], # (1)
NetworkMeasurements: NotRequired[Sequence[LteNetworkMeasurementsTypeDef]], # (2)
TimingAdvance: NotRequired[int],
NrCapable: NotRequired[bool],
Rsrp: NotRequired[int],
Rsrq: NotRequired[float],
Tac: NotRequired[int],- See LteLocalIdTypeDef
- See
Sequence[LteNetworkMeasurementsTypeDef]
UpdateMapRequestTypeDef#
# UpdateMapRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import UpdateMapRequestTypeDef
def get_value() -> UpdateMapRequestTypeDef:
return {
"MapName": ...,
}
# UpdateMapRequestTypeDef definition
class UpdateMapRequestTypeDef(TypedDict):
MapName: str,
PricingPlan: NotRequired[PricingPlanType], # (1)
Description: NotRequired[str],
ConfigurationUpdate: NotRequired[MapConfigurationUpdateTypeDef], # (2)PlaceTypeDef#
# PlaceTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import PlaceTypeDef
def get_value() -> PlaceTypeDef:
return {
"Label": ...,
}
# PlaceTypeDef definition
class PlaceTypeDef(TypedDict):
Geometry: PlaceGeometryTypeDef, # (1)
Label: NotRequired[str],
AddressNumber: NotRequired[str],
Street: NotRequired[str],
Neighborhood: NotRequired[str],
Municipality: NotRequired[str],
SubRegion: NotRequired[str],
Region: NotRequired[str],
Country: NotRequired[str],
PostalCode: NotRequired[str],
Interpolated: NotRequired[bool],
TimeZone: NotRequired[TimeZoneTypeDef], # (2)
UnitType: NotRequired[str],
UnitNumber: NotRequired[str],
Categories: NotRequired[List[str]],
SupplementalCategories: NotRequired[List[str]],
SubMunicipality: NotRequired[str],- See PlaceGeometryTypeDef
- See TimeZoneTypeDef
RouteMatrixEntryTypeDef#
# RouteMatrixEntryTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import RouteMatrixEntryTypeDef
def get_value() -> RouteMatrixEntryTypeDef:
return {
"Distance": ...,
}
# RouteMatrixEntryTypeDef definition
class RouteMatrixEntryTypeDef(TypedDict):
Distance: NotRequired[float],
DurationSeconds: NotRequired[float],
Error: NotRequired[RouteMatrixEntryErrorTypeDef], # (1)SearchPlaceIndexForSuggestionsResponseTypeDef#
# SearchPlaceIndexForSuggestionsResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import SearchPlaceIndexForSuggestionsResponseTypeDef
def get_value() -> SearchPlaceIndexForSuggestionsResponseTypeDef:
return {
"Summary": ...,
}
# SearchPlaceIndexForSuggestionsResponseTypeDef definition
class SearchPlaceIndexForSuggestionsResponseTypeDef(TypedDict):
Summary: SearchPlaceIndexForSuggestionsSummaryTypeDef, # (1)
Results: List[SearchForSuggestionsResultTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)- See SearchPlaceIndexForSuggestionsSummaryTypeDef
- See
List[SearchForSuggestionsResultTypeDef] - See ResponseMetadataTypeDef
ListKeysResponseTypeDef#
# ListKeysResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListKeysResponseTypeDef
def get_value() -> ListKeysResponseTypeDef:
return {
"Entries": ...,
}
# ListKeysResponseTypeDef definition
class ListKeysResponseTypeDef(TypedDict):
Entries: List[ListKeysResponseEntryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],- See
List[ListKeysResponseEntryTypeDef] - See ResponseMetadataTypeDef
CreateKeyRequestTypeDef#
# CreateKeyRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import CreateKeyRequestTypeDef
def get_value() -> CreateKeyRequestTypeDef:
return {
"KeyName": ...,
}
# CreateKeyRequestTypeDef definition
class CreateKeyRequestTypeDef(TypedDict):
KeyName: str,
Restrictions: ApiKeyRestrictionsUnionTypeDef, # (1)
Description: NotRequired[str],
ExpireTime: NotRequired[TimestampTypeDef],
NoExpiry: NotRequired[bool],
Tags: NotRequired[Mapping[str, str]],UpdateKeyRequestTypeDef#
# UpdateKeyRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import UpdateKeyRequestTypeDef
def get_value() -> UpdateKeyRequestTypeDef:
return {
"KeyName": ...,
}
# UpdateKeyRequestTypeDef definition
class UpdateKeyRequestTypeDef(TypedDict):
KeyName: str,
Description: NotRequired[str],
ExpireTime: NotRequired[TimestampTypeDef],
NoExpiry: NotRequired[bool],
ForceUpdate: NotRequired[bool],
Restrictions: NotRequired[ApiKeyRestrictionsUnionTypeDef], # (1)BatchDeleteDevicePositionHistoryResponseTypeDef#
# BatchDeleteDevicePositionHistoryResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import BatchDeleteDevicePositionHistoryResponseTypeDef
def get_value() -> BatchDeleteDevicePositionHistoryResponseTypeDef:
return {
"Errors": ...,
}
# BatchDeleteDevicePositionHistoryResponseTypeDef definition
class BatchDeleteDevicePositionHistoryResponseTypeDef(TypedDict):
Errors: List[BatchDeleteDevicePositionHistoryErrorTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See
List[BatchDeleteDevicePositionHistoryErrorTypeDef] - See ResponseMetadataTypeDef
BatchDeleteGeofenceResponseTypeDef#
# BatchDeleteGeofenceResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import BatchDeleteGeofenceResponseTypeDef
def get_value() -> BatchDeleteGeofenceResponseTypeDef:
return {
"Errors": ...,
}
# BatchDeleteGeofenceResponseTypeDef definition
class BatchDeleteGeofenceResponseTypeDef(TypedDict):
Errors: List[BatchDeleteGeofenceErrorTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See
List[BatchDeleteGeofenceErrorTypeDef] - See ResponseMetadataTypeDef
BatchEvaluateGeofencesResponseTypeDef#
# BatchEvaluateGeofencesResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import BatchEvaluateGeofencesResponseTypeDef
def get_value() -> BatchEvaluateGeofencesResponseTypeDef:
return {
"Errors": ...,
}
# BatchEvaluateGeofencesResponseTypeDef definition
class BatchEvaluateGeofencesResponseTypeDef(TypedDict):
Errors: List[BatchEvaluateGeofencesErrorTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See
List[BatchEvaluateGeofencesErrorTypeDef] - See ResponseMetadataTypeDef
BatchPutGeofenceResponseTypeDef#
# BatchPutGeofenceResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import BatchPutGeofenceResponseTypeDef
def get_value() -> BatchPutGeofenceResponseTypeDef:
return {
"Successes": ...,
}
# BatchPutGeofenceResponseTypeDef definition
class BatchPutGeofenceResponseTypeDef(TypedDict):
Successes: List[BatchPutGeofenceSuccessTypeDef], # (1)
Errors: List[BatchPutGeofenceErrorTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)- See
List[BatchPutGeofenceSuccessTypeDef] - See
List[BatchPutGeofenceErrorTypeDef] - See ResponseMetadataTypeDef
BatchUpdateDevicePositionResponseTypeDef#
# BatchUpdateDevicePositionResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import BatchUpdateDevicePositionResponseTypeDef
def get_value() -> BatchUpdateDevicePositionResponseTypeDef:
return {
"Errors": ...,
}
# BatchUpdateDevicePositionResponseTypeDef definition
class BatchUpdateDevicePositionResponseTypeDef(TypedDict):
Errors: List[BatchUpdateDevicePositionErrorTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See
List[BatchUpdateDevicePositionErrorTypeDef] - See ResponseMetadataTypeDef
CalculateRouteMatrixRequestTypeDef#
# CalculateRouteMatrixRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import CalculateRouteMatrixRequestTypeDef
def get_value() -> CalculateRouteMatrixRequestTypeDef:
return {
"CalculatorName": ...,
}
# CalculateRouteMatrixRequestTypeDef definition
class CalculateRouteMatrixRequestTypeDef(TypedDict):
CalculatorName: str,
DeparturePositions: Sequence[Sequence[float]],
DestinationPositions: Sequence[Sequence[float]],
TravelMode: NotRequired[TravelModeType], # (1)
DepartureTime: NotRequired[TimestampTypeDef],
DepartNow: NotRequired[bool],
DistanceUnit: NotRequired[DistanceUnitType], # (2)
CarModeOptions: NotRequired[CalculateRouteCarModeOptionsTypeDef], # (3)
TruckModeOptions: NotRequired[CalculateRouteTruckModeOptionsTypeDef], # (4)
Key: NotRequired[str],- See TravelModeType
- See DistanceUnitType
- See CalculateRouteCarModeOptionsTypeDef
- See CalculateRouteTruckModeOptionsTypeDef
CalculateRouteRequestTypeDef#
# CalculateRouteRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import CalculateRouteRequestTypeDef
def get_value() -> CalculateRouteRequestTypeDef:
return {
"CalculatorName": ...,
}
# CalculateRouteRequestTypeDef definition
class CalculateRouteRequestTypeDef(TypedDict):
CalculatorName: str,
DeparturePosition: Sequence[float],
DestinationPosition: Sequence[float],
WaypointPositions: NotRequired[Sequence[Sequence[float]]],
TravelMode: NotRequired[TravelModeType], # (1)
DepartureTime: NotRequired[TimestampTypeDef],
DepartNow: NotRequired[bool],
DistanceUnit: NotRequired[DistanceUnitType], # (2)
IncludeLegGeometry: NotRequired[bool],
CarModeOptions: NotRequired[CalculateRouteCarModeOptionsTypeDef], # (3)
TruckModeOptions: NotRequired[CalculateRouteTruckModeOptionsTypeDef], # (4)
ArrivalTime: NotRequired[TimestampTypeDef],
OptimizeFor: NotRequired[OptimizationModeType], # (5)
Key: NotRequired[str],- See TravelModeType
- See DistanceUnitType
- See CalculateRouteCarModeOptionsTypeDef
- See CalculateRouteTruckModeOptionsTypeDef
- See OptimizationModeType
GetGeofenceResponseTypeDef#
# GetGeofenceResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import GetGeofenceResponseTypeDef
def get_value() -> GetGeofenceResponseTypeDef:
return {
"GeofenceId": ...,
}
# GetGeofenceResponseTypeDef definition
class GetGeofenceResponseTypeDef(TypedDict):
GeofenceId: str,
Geometry: GeofenceGeometryOutputTypeDef, # (1)
Status: str,
CreateTime: datetime.datetime,
UpdateTime: datetime.datetime,
GeofenceProperties: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListGeofenceResponseEntryTypeDef#
# ListGeofenceResponseEntryTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListGeofenceResponseEntryTypeDef
def get_value() -> ListGeofenceResponseEntryTypeDef:
return {
"GeofenceId": ...,
}
# ListGeofenceResponseEntryTypeDef definition
class ListGeofenceResponseEntryTypeDef(TypedDict):
GeofenceId: str,
Geometry: GeofenceGeometryOutputTypeDef, # (1)
Status: str,
CreateTime: datetime.datetime,
UpdateTime: datetime.datetime,
GeofenceProperties: NotRequired[Dict[str, str]],GeofenceGeometryTypeDef#
# GeofenceGeometryTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import GeofenceGeometryTypeDef
def get_value() -> GeofenceGeometryTypeDef:
return {
"Polygon": ...,
}
# GeofenceGeometryTypeDef definition
class GeofenceGeometryTypeDef(TypedDict):
Polygon: NotRequired[Sequence[Sequence[Sequence[float]]]],
Circle: NotRequired[CircleUnionTypeDef], # (1)
Geobuf: NotRequired[BlobTypeDef],BatchGetDevicePositionResponseTypeDef#
# BatchGetDevicePositionResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import BatchGetDevicePositionResponseTypeDef
def get_value() -> BatchGetDevicePositionResponseTypeDef:
return {
"Errors": ...,
}
# BatchGetDevicePositionResponseTypeDef definition
class BatchGetDevicePositionResponseTypeDef(TypedDict):
Errors: List[BatchGetDevicePositionErrorTypeDef], # (1)
DevicePositions: List[DevicePositionTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)- See
List[BatchGetDevicePositionErrorTypeDef] - See
List[DevicePositionTypeDef] - See ResponseMetadataTypeDef
GetDevicePositionHistoryResponseTypeDef#
# GetDevicePositionHistoryResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import GetDevicePositionHistoryResponseTypeDef
def get_value() -> GetDevicePositionHistoryResponseTypeDef:
return {
"DevicePositions": ...,
}
# GetDevicePositionHistoryResponseTypeDef definition
class GetDevicePositionHistoryResponseTypeDef(TypedDict):
DevicePositions: List[DevicePositionTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],- See
List[DevicePositionTypeDef] - See ResponseMetadataTypeDef
BatchEvaluateGeofencesRequestTypeDef#
# BatchEvaluateGeofencesRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import BatchEvaluateGeofencesRequestTypeDef
def get_value() -> BatchEvaluateGeofencesRequestTypeDef:
return {
"CollectionName": ...,
}
# BatchEvaluateGeofencesRequestTypeDef definition
class BatchEvaluateGeofencesRequestTypeDef(TypedDict):
CollectionName: str,
DevicePositionUpdates: Sequence[DevicePositionUpdateTypeDef], # (1)- See
Sequence[DevicePositionUpdateTypeDef]
BatchUpdateDevicePositionRequestTypeDef#
# BatchUpdateDevicePositionRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import BatchUpdateDevicePositionRequestTypeDef
def get_value() -> BatchUpdateDevicePositionRequestTypeDef:
return {
"TrackerName": ...,
}
# BatchUpdateDevicePositionRequestTypeDef definition
class BatchUpdateDevicePositionRequestTypeDef(TypedDict):
TrackerName: str,
Updates: Sequence[DevicePositionUpdateTypeDef], # (1)- See
Sequence[DevicePositionUpdateTypeDef]
VerifyDevicePositionResponseTypeDef#
# VerifyDevicePositionResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import VerifyDevicePositionResponseTypeDef
def get_value() -> VerifyDevicePositionResponseTypeDef:
return {
"InferredState": ...,
}
# VerifyDevicePositionResponseTypeDef definition
class VerifyDevicePositionResponseTypeDef(TypedDict):
InferredState: InferredStateTypeDef, # (1)
DeviceId: str,
SampleTime: datetime.datetime,
ReceivedTime: datetime.datetime,
DistanceUnit: DistanceUnitType, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)ListDevicePositionsResponseTypeDef#
# ListDevicePositionsResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListDevicePositionsResponseTypeDef
def get_value() -> ListDevicePositionsResponseTypeDef:
return {
"Entries": ...,
}
# ListDevicePositionsResponseTypeDef definition
class ListDevicePositionsResponseTypeDef(TypedDict):
Entries: List[ListDevicePositionsResponseEntryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],- See
List[ListDevicePositionsResponseEntryTypeDef] - See ResponseMetadataTypeDef
CalculateRouteResponseTypeDef#
# CalculateRouteResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import CalculateRouteResponseTypeDef
def get_value() -> CalculateRouteResponseTypeDef:
return {
"Legs": ...,
}
# CalculateRouteResponseTypeDef definition
class CalculateRouteResponseTypeDef(TypedDict):
Legs: List[LegTypeDef], # (1)
Summary: CalculateRouteSummaryTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)- See
List[LegTypeDef] - See CalculateRouteSummaryTypeDef
- See ResponseMetadataTypeDef
CellSignalsTypeDef#
# CellSignalsTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import CellSignalsTypeDef
def get_value() -> CellSignalsTypeDef:
return {
"LteCellDetails": ...,
}
# CellSignalsTypeDef definition
class CellSignalsTypeDef(TypedDict):
LteCellDetails: Sequence[LteCellDetailsTypeDef], # (1)- See
Sequence[LteCellDetailsTypeDef]
CreateMapRequestTypeDef#
# CreateMapRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import CreateMapRequestTypeDef
def get_value() -> CreateMapRequestTypeDef:
return {
"MapName": ...,
}
# CreateMapRequestTypeDef definition
class CreateMapRequestTypeDef(TypedDict):
MapName: str,
Configuration: MapConfigurationUnionTypeDef, # (1)
PricingPlan: NotRequired[PricingPlanType], # (2)
Description: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],GetPlaceResponseTypeDef#
# GetPlaceResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import GetPlaceResponseTypeDef
def get_value() -> GetPlaceResponseTypeDef:
return {
"Place": ...,
}
# GetPlaceResponseTypeDef definition
class GetPlaceResponseTypeDef(TypedDict):
Place: PlaceTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See PlaceTypeDef
- See ResponseMetadataTypeDef
SearchForPositionResultTypeDef#
# SearchForPositionResultTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import SearchForPositionResultTypeDef
def get_value() -> SearchForPositionResultTypeDef:
return {
"Place": ...,
}
# SearchForPositionResultTypeDef definition
class SearchForPositionResultTypeDef(TypedDict):
Place: PlaceTypeDef, # (1)
Distance: float,
PlaceId: NotRequired[str],- See PlaceTypeDef
SearchForTextResultTypeDef#
# SearchForTextResultTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import SearchForTextResultTypeDef
def get_value() -> SearchForTextResultTypeDef:
return {
"Place": ...,
}
# SearchForTextResultTypeDef definition
class SearchForTextResultTypeDef(TypedDict):
Place: PlaceTypeDef, # (1)
Distance: NotRequired[float],
Relevance: NotRequired[float],
PlaceId: NotRequired[str],- See PlaceTypeDef
CalculateRouteMatrixResponseTypeDef#
# CalculateRouteMatrixResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import CalculateRouteMatrixResponseTypeDef
def get_value() -> CalculateRouteMatrixResponseTypeDef:
return {
"RouteMatrix": ...,
}
# CalculateRouteMatrixResponseTypeDef definition
class CalculateRouteMatrixResponseTypeDef(TypedDict):
RouteMatrix: List[List[RouteMatrixEntryTypeDef]], # (1)
SnappedDeparturePositions: List[List[float]],
SnappedDestinationPositions: List[List[float]],
Summary: CalculateRouteMatrixSummaryTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)- See
List[List[RouteMatrixEntryTypeDef]] - See CalculateRouteMatrixSummaryTypeDef
- See ResponseMetadataTypeDef
ListGeofencesResponseTypeDef#
# ListGeofencesResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import ListGeofencesResponseTypeDef
def get_value() -> ListGeofencesResponseTypeDef:
return {
"Entries": ...,
}
# ListGeofencesResponseTypeDef definition
class ListGeofencesResponseTypeDef(TypedDict):
Entries: List[ListGeofenceResponseEntryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],- See
List[ListGeofenceResponseEntryTypeDef] - See ResponseMetadataTypeDef
DeviceStateTypeDef#
# DeviceStateTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import DeviceStateTypeDef
def get_value() -> DeviceStateTypeDef:
return {
"DeviceId": ...,
}
# DeviceStateTypeDef definition
class DeviceStateTypeDef(TypedDict):
DeviceId: str,
SampleTime: TimestampTypeDef,
Position: Sequence[float],
Accuracy: NotRequired[PositionalAccuracyTypeDef], # (1)
Ipv4Address: NotRequired[str],
WiFiAccessPoints: NotRequired[Sequence[WiFiAccessPointTypeDef]], # (2)
CellSignals: NotRequired[CellSignalsTypeDef], # (3)- See PositionalAccuracyTypeDef
- See
Sequence[WiFiAccessPointTypeDef] - See CellSignalsTypeDef
SearchPlaceIndexForPositionResponseTypeDef#
# SearchPlaceIndexForPositionResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import SearchPlaceIndexForPositionResponseTypeDef
def get_value() -> SearchPlaceIndexForPositionResponseTypeDef:
return {
"Summary": ...,
}
# SearchPlaceIndexForPositionResponseTypeDef definition
class SearchPlaceIndexForPositionResponseTypeDef(TypedDict):
Summary: SearchPlaceIndexForPositionSummaryTypeDef, # (1)
Results: List[SearchForPositionResultTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)- See SearchPlaceIndexForPositionSummaryTypeDef
- See
List[SearchForPositionResultTypeDef] - See ResponseMetadataTypeDef
SearchPlaceIndexForTextResponseTypeDef#
# SearchPlaceIndexForTextResponseTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import SearchPlaceIndexForTextResponseTypeDef
def get_value() -> SearchPlaceIndexForTextResponseTypeDef:
return {
"Summary": ...,
}
# SearchPlaceIndexForTextResponseTypeDef definition
class SearchPlaceIndexForTextResponseTypeDef(TypedDict):
Summary: SearchPlaceIndexForTextSummaryTypeDef, # (1)
Results: List[SearchForTextResultTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)- See SearchPlaceIndexForTextSummaryTypeDef
- See
List[SearchForTextResultTypeDef] - See ResponseMetadataTypeDef
BatchPutGeofenceRequestEntryTypeDef#
# BatchPutGeofenceRequestEntryTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import BatchPutGeofenceRequestEntryTypeDef
def get_value() -> BatchPutGeofenceRequestEntryTypeDef:
return {
"GeofenceId": ...,
}
# BatchPutGeofenceRequestEntryTypeDef definition
class BatchPutGeofenceRequestEntryTypeDef(TypedDict):
GeofenceId: str,
Geometry: GeofenceGeometryUnionTypeDef, # (1)
GeofenceProperties: NotRequired[Mapping[str, str]],PutGeofenceRequestTypeDef#
# PutGeofenceRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import PutGeofenceRequestTypeDef
def get_value() -> PutGeofenceRequestTypeDef:
return {
"CollectionName": ...,
}
# PutGeofenceRequestTypeDef definition
class PutGeofenceRequestTypeDef(TypedDict):
CollectionName: str,
GeofenceId: str,
Geometry: GeofenceGeometryUnionTypeDef, # (1)
GeofenceProperties: NotRequired[Mapping[str, str]],VerifyDevicePositionRequestTypeDef#
# VerifyDevicePositionRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import VerifyDevicePositionRequestTypeDef
def get_value() -> VerifyDevicePositionRequestTypeDef:
return {
"TrackerName": ...,
}
# VerifyDevicePositionRequestTypeDef definition
class VerifyDevicePositionRequestTypeDef(TypedDict):
TrackerName: str,
DeviceState: DeviceStateTypeDef, # (1)
DistanceUnit: NotRequired[DistanceUnitType], # (2)- See DeviceStateTypeDef
- See DistanceUnitType
BatchPutGeofenceRequestTypeDef#
# BatchPutGeofenceRequestTypeDef TypedDict usage example
from mypy_boto3_location.type_defs import BatchPutGeofenceRequestTypeDef
def get_value() -> BatchPutGeofenceRequestTypeDef:
return {
"CollectionName": ...,
}
# BatchPutGeofenceRequestTypeDef definition
class BatchPutGeofenceRequestTypeDef(TypedDict):
CollectionName: str,
Entries: Sequence[BatchPutGeofenceRequestEntryTypeDef], # (1)- See
Sequence[BatchPutGeofenceRequestEntryTypeDef]