Skip to content

Type definitions#

Index > LocationService > Type definitions

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

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

CircleUnionTypeDef#

# CircleUnionTypeDef definition

CircleUnionTypeDef = Union[
    CircleTypeDef,  # (1)
    CircleOutputTypeDef,  # (2)
]
  1. See CircleTypeDef
  2. See CircleOutputTypeDef

GeofenceGeometryUnionTypeDef#

# GeofenceGeometryUnionTypeDef definition

GeofenceGeometryUnionTypeDef = Union[
    GeofenceGeometryTypeDef,  # (1)
    GeofenceGeometryOutputTypeDef,  # (2)
]
  1. See GeofenceGeometryTypeDef
  2. See GeofenceGeometryOutputTypeDef

ApiKeyFilterTypeDef#

# ApiKeyFilterTypeDef definition

class ApiKeyFilterTypeDef(TypedDict):
    KeyStatus: NotRequired[StatusType],  # (1)
  1. See StatusType

ApiKeyRestrictionsOutputTypeDef#

# ApiKeyRestrictionsOutputTypeDef definition

class ApiKeyRestrictionsOutputTypeDef(TypedDict):
    AllowActions: list[str],
    AllowResources: list[str],
    AllowReferers: NotRequired[list[str]],

ApiKeyRestrictionsTypeDef#

# ApiKeyRestrictionsTypeDef definition

class ApiKeyRestrictionsTypeDef(TypedDict):
    AllowActions: Sequence[str],
    AllowResources: Sequence[str],
    AllowReferers: NotRequired[Sequence[str]],

AssociateTrackerConsumerRequestRequestTypeDef#

# AssociateTrackerConsumerRequestRequestTypeDef definition

class AssociateTrackerConsumerRequestRequestTypeDef(TypedDict):
    TrackerName: str,
    ConsumerArn: str,

BatchItemErrorTypeDef#

# BatchItemErrorTypeDef definition

class BatchItemErrorTypeDef(TypedDict):
    Code: NotRequired[BatchItemErrorCodeType],  # (1)
    Message: NotRequired[str],
  1. See BatchItemErrorCodeType

BatchDeleteDevicePositionHistoryRequestRequestTypeDef#

# BatchDeleteDevicePositionHistoryRequestRequestTypeDef definition

class BatchDeleteDevicePositionHistoryRequestRequestTypeDef(TypedDict):
    TrackerName: str,
    DeviceIds: Sequence[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

BatchDeleteGeofenceRequestRequestTypeDef#

# BatchDeleteGeofenceRequestRequestTypeDef definition

class BatchDeleteGeofenceRequestRequestTypeDef(TypedDict):
    CollectionName: str,
    GeofenceIds: Sequence[str],

BatchGetDevicePositionRequestRequestTypeDef#

# BatchGetDevicePositionRequestRequestTypeDef definition

class BatchGetDevicePositionRequestRequestTypeDef(TypedDict):
    TrackerName: str,
    DeviceIds: Sequence[str],

BatchPutGeofenceSuccessTypeDef#

# BatchPutGeofenceSuccessTypeDef definition

class BatchPutGeofenceSuccessTypeDef(TypedDict):
    GeofenceId: str,
    CreateTime: datetime,
    UpdateTime: datetime,

CalculateRouteCarModeOptionsTypeDef#

# CalculateRouteCarModeOptionsTypeDef definition

class CalculateRouteCarModeOptionsTypeDef(TypedDict):
    AvoidFerries: NotRequired[bool],
    AvoidTolls: NotRequired[bool],

CalculateRouteMatrixSummaryTypeDef#

# CalculateRouteMatrixSummaryTypeDef definition

class CalculateRouteMatrixSummaryTypeDef(TypedDict):
    DataSource: str,
    RouteCount: int,
    ErrorCount: int,
    DistanceUnit: DistanceUnitType,  # (1)
  1. See DistanceUnitType

CalculateRouteSummaryTypeDef#

# CalculateRouteSummaryTypeDef definition

class CalculateRouteSummaryTypeDef(TypedDict):
    RouteBBox: list[float],
    DataSource: str,
    Distance: float,
    DurationSeconds: float,
    DistanceUnit: DistanceUnitType,  # (1)
  1. See DistanceUnitType

TruckDimensionsTypeDef#

# TruckDimensionsTypeDef definition

class TruckDimensionsTypeDef(TypedDict):
    Length: NotRequired[float],
    Height: NotRequired[float],
    Width: NotRequired[float],
    Unit: NotRequired[DimensionUnitType],  # (1)
  1. See DimensionUnitType

TruckWeightTypeDef#

# TruckWeightTypeDef definition

class TruckWeightTypeDef(TypedDict):
    Total: NotRequired[float],
    Unit: NotRequired[VehicleWeightUnitType],  # (1)
  1. See VehicleWeightUnitType

CircleOutputTypeDef#

# CircleOutputTypeDef definition

class CircleOutputTypeDef(TypedDict):
    Center: list[float],
    Radius: float,

CircleTypeDef#

# CircleTypeDef definition

class CircleTypeDef(TypedDict):
    Center: Sequence[float],
    Radius: float,

CreateGeofenceCollectionRequestRequestTypeDef#

# CreateGeofenceCollectionRequestRequestTypeDef definition

class CreateGeofenceCollectionRequestRequestTypeDef(TypedDict):
    CollectionName: str,
    PricingPlan: NotRequired[PricingPlanType],  # (1)
    PricingPlanDataSource: NotRequired[str],
    Description: NotRequired[str],
    Tags: NotRequired[Mapping[str, str]],
    KmsKeyId: NotRequired[str],
  1. See PricingPlanType

MapConfigurationTypeDef#

# MapConfigurationTypeDef definition

class MapConfigurationTypeDef(TypedDict):
    Style: str,
    PoliticalView: NotRequired[str],
    CustomLayers: NotRequired[Sequence[str]],

DataSourceConfigurationTypeDef#

# DataSourceConfigurationTypeDef definition

class DataSourceConfigurationTypeDef(TypedDict):
    IntendedUse: NotRequired[IntendedUseType],  # (1)
  1. See IntendedUseType

CreateRouteCalculatorRequestRequestTypeDef#

# CreateRouteCalculatorRequestRequestTypeDef definition

class CreateRouteCalculatorRequestRequestTypeDef(TypedDict):
    CalculatorName: str,
    DataSource: str,
    PricingPlan: NotRequired[PricingPlanType],  # (1)
    Description: NotRequired[str],
    Tags: NotRequired[Mapping[str, str]],
  1. See PricingPlanType

CreateTrackerRequestRequestTypeDef#

# CreateTrackerRequestRequestTypeDef definition

class CreateTrackerRequestRequestTypeDef(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],
  1. See PricingPlanType
  2. See PositionFilteringType

DeleteGeofenceCollectionRequestRequestTypeDef#

# DeleteGeofenceCollectionRequestRequestTypeDef definition

class DeleteGeofenceCollectionRequestRequestTypeDef(TypedDict):
    CollectionName: str,

DeleteKeyRequestRequestTypeDef#

# DeleteKeyRequestRequestTypeDef definition

class DeleteKeyRequestRequestTypeDef(TypedDict):
    KeyName: str,
    ForceDelete: NotRequired[bool],

DeleteMapRequestRequestTypeDef#

# DeleteMapRequestRequestTypeDef definition

class DeleteMapRequestRequestTypeDef(TypedDict):
    MapName: str,

DeletePlaceIndexRequestRequestTypeDef#

# DeletePlaceIndexRequestRequestTypeDef definition

class DeletePlaceIndexRequestRequestTypeDef(TypedDict):
    IndexName: str,

DeleteRouteCalculatorRequestRequestTypeDef#

# DeleteRouteCalculatorRequestRequestTypeDef definition

class DeleteRouteCalculatorRequestRequestTypeDef(TypedDict):
    CalculatorName: str,

DeleteTrackerRequestRequestTypeDef#

# DeleteTrackerRequestRequestTypeDef definition

class DeleteTrackerRequestRequestTypeDef(TypedDict):
    TrackerName: str,

DescribeGeofenceCollectionRequestRequestTypeDef#

# DescribeGeofenceCollectionRequestRequestTypeDef definition

class DescribeGeofenceCollectionRequestRequestTypeDef(TypedDict):
    CollectionName: str,

DescribeKeyRequestRequestTypeDef#

# DescribeKeyRequestRequestTypeDef definition

class DescribeKeyRequestRequestTypeDef(TypedDict):
    KeyName: str,

DescribeMapRequestRequestTypeDef#

# DescribeMapRequestRequestTypeDef definition

class DescribeMapRequestRequestTypeDef(TypedDict):
    MapName: str,

MapConfigurationOutputTypeDef#

# MapConfigurationOutputTypeDef definition

class MapConfigurationOutputTypeDef(TypedDict):
    Style: str,
    PoliticalView: NotRequired[str],
    CustomLayers: NotRequired[list[str]],

DescribePlaceIndexRequestRequestTypeDef#

# DescribePlaceIndexRequestRequestTypeDef definition

class DescribePlaceIndexRequestRequestTypeDef(TypedDict):
    IndexName: str,

DescribeRouteCalculatorRequestRequestTypeDef#

# DescribeRouteCalculatorRequestRequestTypeDef definition

class DescribeRouteCalculatorRequestRequestTypeDef(TypedDict):
    CalculatorName: str,

DescribeTrackerRequestRequestTypeDef#

# DescribeTrackerRequestRequestTypeDef definition

class DescribeTrackerRequestRequestTypeDef(TypedDict):
    TrackerName: str,

PositionalAccuracyTypeDef#

# PositionalAccuracyTypeDef definition

class PositionalAccuracyTypeDef(TypedDict):
    Horizontal: float,

WiFiAccessPointTypeDef#

# WiFiAccessPointTypeDef definition

class WiFiAccessPointTypeDef(TypedDict):
    MacAddress: str,
    Rss: int,

DisassociateTrackerConsumerRequestRequestTypeDef#

# DisassociateTrackerConsumerRequestRequestTypeDef definition

class DisassociateTrackerConsumerRequestRequestTypeDef(TypedDict):
    TrackerName: str,
    ConsumerArn: str,

ForecastGeofenceEventsDeviceStateTypeDef#

# ForecastGeofenceEventsDeviceStateTypeDef definition

class ForecastGeofenceEventsDeviceStateTypeDef(TypedDict):
    Position: Sequence[float],
    Speed: NotRequired[float],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ForecastedEventTypeDef#

# ForecastedEventTypeDef definition

class ForecastedEventTypeDef(TypedDict):
    EventId: str,
    GeofenceId: str,
    IsDeviceInGeofence: bool,
    NearestDistance: float,
    EventType: ForecastedGeofenceEventTypeType,  # (1)
    ForecastedBreachTime: NotRequired[datetime],
    GeofenceProperties: NotRequired[dict[str, str]],
  1. See ForecastedGeofenceEventTypeType

GetDevicePositionRequestRequestTypeDef#

# GetDevicePositionRequestRequestTypeDef definition

class GetDevicePositionRequestRequestTypeDef(TypedDict):
    TrackerName: str,
    DeviceId: str,

GetGeofenceRequestRequestTypeDef#

# GetGeofenceRequestRequestTypeDef definition

class GetGeofenceRequestRequestTypeDef(TypedDict):
    CollectionName: str,
    GeofenceId: str,

GetMapGlyphsRequestRequestTypeDef#

# GetMapGlyphsRequestRequestTypeDef definition

class GetMapGlyphsRequestRequestTypeDef(TypedDict):
    MapName: str,
    FontStack: str,
    FontUnicodeRange: str,
    Key: NotRequired[str],

GetMapSpritesRequestRequestTypeDef#

# GetMapSpritesRequestRequestTypeDef definition

class GetMapSpritesRequestRequestTypeDef(TypedDict):
    MapName: str,
    FileName: str,
    Key: NotRequired[str],

GetMapStyleDescriptorRequestRequestTypeDef#

# GetMapStyleDescriptorRequestRequestTypeDef definition

class GetMapStyleDescriptorRequestRequestTypeDef(TypedDict):
    MapName: str,
    Key: NotRequired[str],

GetMapTileRequestRequestTypeDef#

# GetMapTileRequestRequestTypeDef definition

class GetMapTileRequestRequestTypeDef(TypedDict):
    MapName: str,
    Z: str,
    X: str,
    Y: str,
    Key: NotRequired[str],

GetPlaceRequestRequestTypeDef#

# GetPlaceRequestRequestTypeDef definition

class GetPlaceRequestRequestTypeDef(TypedDict):
    IndexName: str,
    PlaceId: str,
    Language: NotRequired[str],
    Key: NotRequired[str],

LegGeometryTypeDef#

# LegGeometryTypeDef definition

class LegGeometryTypeDef(TypedDict):
    LineString: NotRequired[list[list[float]]],

StepTypeDef#

# StepTypeDef definition

class StepTypeDef(TypedDict):
    StartPosition: list[float],
    EndPosition: list[float],
    Distance: float,
    DurationSeconds: float,
    GeometryOffset: NotRequired[int],

TrackingFilterGeometryTypeDef#

# TrackingFilterGeometryTypeDef definition

class TrackingFilterGeometryTypeDef(TypedDict):
    Polygon: NotRequired[Sequence[Sequence[Sequence[float]]]],

ListGeofenceCollectionsRequestRequestTypeDef#

# ListGeofenceCollectionsRequestRequestTypeDef definition

class ListGeofenceCollectionsRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListGeofenceCollectionsResponseEntryTypeDef#

# ListGeofenceCollectionsResponseEntryTypeDef definition

class ListGeofenceCollectionsResponseEntryTypeDef(TypedDict):
    CollectionName: str,
    Description: str,
    CreateTime: datetime,
    UpdateTime: datetime,
    PricingPlan: NotRequired[PricingPlanType],  # (1)
    PricingPlanDataSource: NotRequired[str],
  1. See PricingPlanType

ListGeofencesRequestRequestTypeDef#

# ListGeofencesRequestRequestTypeDef definition

class ListGeofencesRequestRequestTypeDef(TypedDict):
    CollectionName: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListMapsRequestRequestTypeDef#

# ListMapsRequestRequestTypeDef definition

class ListMapsRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListMapsResponseEntryTypeDef#

# ListMapsResponseEntryTypeDef definition

class ListMapsResponseEntryTypeDef(TypedDict):
    MapName: str,
    Description: str,
    DataSource: str,
    CreateTime: datetime,
    UpdateTime: datetime,
    PricingPlan: NotRequired[PricingPlanType],  # (1)
  1. See PricingPlanType

ListPlaceIndexesRequestRequestTypeDef#

# ListPlaceIndexesRequestRequestTypeDef definition

class ListPlaceIndexesRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListPlaceIndexesResponseEntryTypeDef#

# ListPlaceIndexesResponseEntryTypeDef definition

class ListPlaceIndexesResponseEntryTypeDef(TypedDict):
    IndexName: str,
    Description: str,
    DataSource: str,
    CreateTime: datetime,
    UpdateTime: datetime,
    PricingPlan: NotRequired[PricingPlanType],  # (1)
  1. See PricingPlanType

ListRouteCalculatorsRequestRequestTypeDef#

# ListRouteCalculatorsRequestRequestTypeDef definition

class ListRouteCalculatorsRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListRouteCalculatorsResponseEntryTypeDef#

# ListRouteCalculatorsResponseEntryTypeDef definition

class ListRouteCalculatorsResponseEntryTypeDef(TypedDict):
    CalculatorName: str,
    Description: str,
    DataSource: str,
    CreateTime: datetime,
    UpdateTime: datetime,
    PricingPlan: NotRequired[PricingPlanType],  # (1)
  1. See PricingPlanType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

ListTrackerConsumersRequestRequestTypeDef#

# ListTrackerConsumersRequestRequestTypeDef definition

class ListTrackerConsumersRequestRequestTypeDef(TypedDict):
    TrackerName: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListTrackersRequestRequestTypeDef#

# ListTrackersRequestRequestTypeDef definition

class ListTrackersRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListTrackersResponseEntryTypeDef#

# ListTrackersResponseEntryTypeDef definition

class ListTrackersResponseEntryTypeDef(TypedDict):
    TrackerName: str,
    Description: str,
    CreateTime: datetime,
    UpdateTime: datetime,
    PricingPlan: NotRequired[PricingPlanType],  # (1)
    PricingPlanDataSource: NotRequired[str],
  1. See PricingPlanType

LteLocalIdTypeDef#

# LteLocalIdTypeDef definition

class LteLocalIdTypeDef(TypedDict):
    Earfcn: int,
    Pci: int,

LteNetworkMeasurementsTypeDef#

# LteNetworkMeasurementsTypeDef definition

class LteNetworkMeasurementsTypeDef(TypedDict):
    Earfcn: int,
    CellId: int,
    Pci: int,
    Rsrp: NotRequired[int],
    Rsrq: NotRequired[float],

MapConfigurationUpdateTypeDef#

# MapConfigurationUpdateTypeDef definition

class MapConfigurationUpdateTypeDef(TypedDict):
    PoliticalView: NotRequired[str],
    CustomLayers: NotRequired[Sequence[str]],

PlaceGeometryTypeDef#

# PlaceGeometryTypeDef definition

class PlaceGeometryTypeDef(TypedDict):
    Point: NotRequired[list[float]],

TimeZoneTypeDef#

# TimeZoneTypeDef definition

class TimeZoneTypeDef(TypedDict):
    Name: str,
    Offset: NotRequired[int],

RouteMatrixEntryErrorTypeDef#

# RouteMatrixEntryErrorTypeDef definition

class RouteMatrixEntryErrorTypeDef(TypedDict):
    Code: RouteMatrixErrorCodeType,  # (1)
    Message: NotRequired[str],
  1. See RouteMatrixErrorCodeType

SearchForSuggestionsResultTypeDef#

# SearchForSuggestionsResultTypeDef definition

class SearchForSuggestionsResultTypeDef(TypedDict):
    Text: str,
    PlaceId: NotRequired[str],
    Categories: NotRequired[list[str]],
    SupplementalCategories: NotRequired[list[str]],

SearchPlaceIndexForPositionRequestRequestTypeDef#

# SearchPlaceIndexForPositionRequestRequestTypeDef definition

class SearchPlaceIndexForPositionRequestRequestTypeDef(TypedDict):
    IndexName: str,
    Position: Sequence[float],
    MaxResults: NotRequired[int],
    Language: NotRequired[str],
    Key: NotRequired[str],

SearchPlaceIndexForPositionSummaryTypeDef#

# SearchPlaceIndexForPositionSummaryTypeDef definition

class SearchPlaceIndexForPositionSummaryTypeDef(TypedDict):
    Position: list[float],
    DataSource: str,
    MaxResults: NotRequired[int],
    Language: NotRequired[str],

SearchPlaceIndexForSuggestionsRequestRequestTypeDef#

# SearchPlaceIndexForSuggestionsRequestRequestTypeDef definition

class SearchPlaceIndexForSuggestionsRequestRequestTypeDef(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 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]],

SearchPlaceIndexForTextRequestRequestTypeDef#

# SearchPlaceIndexForTextRequestRequestTypeDef definition

class SearchPlaceIndexForTextRequestRequestTypeDef(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 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]],

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

UpdateGeofenceCollectionRequestRequestTypeDef#

# UpdateGeofenceCollectionRequestRequestTypeDef definition

class UpdateGeofenceCollectionRequestRequestTypeDef(TypedDict):
    CollectionName: str,
    PricingPlan: NotRequired[PricingPlanType],  # (1)
    PricingPlanDataSource: NotRequired[str],
    Description: NotRequired[str],
  1. See PricingPlanType

UpdateRouteCalculatorRequestRequestTypeDef#

# UpdateRouteCalculatorRequestRequestTypeDef definition

class UpdateRouteCalculatorRequestRequestTypeDef(TypedDict):
    CalculatorName: str,
    PricingPlan: NotRequired[PricingPlanType],  # (1)
    Description: NotRequired[str],
  1. See PricingPlanType

UpdateTrackerRequestRequestTypeDef#

# UpdateTrackerRequestRequestTypeDef definition

class UpdateTrackerRequestRequestTypeDef(TypedDict):
    TrackerName: str,
    PricingPlan: NotRequired[PricingPlanType],  # (1)
    PricingPlanDataSource: NotRequired[str],
    Description: NotRequired[str],
    PositionFiltering: NotRequired[PositionFilteringType],  # (2)
    EventBridgeEnabled: NotRequired[bool],
    KmsKeyEnableGeospatialQueries: NotRequired[bool],
  1. See PricingPlanType
  2. See PositionFilteringType

ListKeysRequestRequestTypeDef#

# ListKeysRequestRequestTypeDef definition

class ListKeysRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    Filter: NotRequired[ApiKeyFilterTypeDef],  # (1)
  1. See ApiKeyFilterTypeDef

ListKeysResponseEntryTypeDef#

# ListKeysResponseEntryTypeDef definition

class ListKeysResponseEntryTypeDef(TypedDict):
    KeyName: str,
    ExpireTime: datetime,
    Restrictions: ApiKeyRestrictionsOutputTypeDef,  # (1)
    CreateTime: datetime,
    UpdateTime: datetime,
    Description: NotRequired[str],
  1. See ApiKeyRestrictionsOutputTypeDef

BatchDeleteDevicePositionHistoryErrorTypeDef#

# BatchDeleteDevicePositionHistoryErrorTypeDef definition

class BatchDeleteDevicePositionHistoryErrorTypeDef(TypedDict):
    DeviceId: str,
    Error: BatchItemErrorTypeDef,  # (1)
  1. See BatchItemErrorTypeDef

BatchDeleteGeofenceErrorTypeDef#

# BatchDeleteGeofenceErrorTypeDef definition

class BatchDeleteGeofenceErrorTypeDef(TypedDict):
    GeofenceId: str,
    Error: BatchItemErrorTypeDef,  # (1)
  1. See BatchItemErrorTypeDef

BatchEvaluateGeofencesErrorTypeDef#

# BatchEvaluateGeofencesErrorTypeDef definition

class BatchEvaluateGeofencesErrorTypeDef(TypedDict):
    DeviceId: str,
    SampleTime: datetime,
    Error: BatchItemErrorTypeDef,  # (1)
  1. See BatchItemErrorTypeDef

BatchGetDevicePositionErrorTypeDef#

# BatchGetDevicePositionErrorTypeDef definition

class BatchGetDevicePositionErrorTypeDef(TypedDict):
    DeviceId: str,
    Error: BatchItemErrorTypeDef,  # (1)
  1. See BatchItemErrorTypeDef

BatchPutGeofenceErrorTypeDef#

# BatchPutGeofenceErrorTypeDef definition

class BatchPutGeofenceErrorTypeDef(TypedDict):
    GeofenceId: str,
    Error: BatchItemErrorTypeDef,  # (1)
  1. See BatchItemErrorTypeDef

BatchUpdateDevicePositionErrorTypeDef#

# BatchUpdateDevicePositionErrorTypeDef definition

class BatchUpdateDevicePositionErrorTypeDef(TypedDict):
    DeviceId: str,
    SampleTime: datetime,
    Error: BatchItemErrorTypeDef,  # (1)
  1. See BatchItemErrorTypeDef

CreateGeofenceCollectionResponseTypeDef#

# CreateGeofenceCollectionResponseTypeDef definition

class CreateGeofenceCollectionResponseTypeDef(TypedDict):
    CollectionName: str,
    CollectionArn: str,
    CreateTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateKeyResponseTypeDef#

# CreateKeyResponseTypeDef definition

class CreateKeyResponseTypeDef(TypedDict):
    Key: str,
    KeyArn: str,
    KeyName: str,
    CreateTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateMapResponseTypeDef#

# CreateMapResponseTypeDef definition

class CreateMapResponseTypeDef(TypedDict):
    MapName: str,
    MapArn: str,
    CreateTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreatePlaceIndexResponseTypeDef#

# CreatePlaceIndexResponseTypeDef definition

class CreatePlaceIndexResponseTypeDef(TypedDict):
    IndexName: str,
    IndexArn: str,
    CreateTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateRouteCalculatorResponseTypeDef#

# CreateRouteCalculatorResponseTypeDef definition

class CreateRouteCalculatorResponseTypeDef(TypedDict):
    CalculatorName: str,
    CalculatorArn: str,
    CreateTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateTrackerResponseTypeDef#

# CreateTrackerResponseTypeDef definition

class CreateTrackerResponseTypeDef(TypedDict):
    TrackerName: str,
    TrackerArn: str,
    CreateTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeGeofenceCollectionResponseTypeDef#

# DescribeGeofenceCollectionResponseTypeDef definition

class DescribeGeofenceCollectionResponseTypeDef(TypedDict):
    CollectionName: str,
    CollectionArn: str,
    Description: str,
    PricingPlan: PricingPlanType,  # (1)
    PricingPlanDataSource: str,
    KmsKeyId: str,
    Tags: dict[str, str],
    CreateTime: datetime,
    UpdateTime: datetime,
    GeofenceCount: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PricingPlanType
  2. See ResponseMetadataTypeDef

DescribeKeyResponseTypeDef#

# DescribeKeyResponseTypeDef definition

class DescribeKeyResponseTypeDef(TypedDict):
    Key: str,
    KeyArn: str,
    KeyName: str,
    Restrictions: ApiKeyRestrictionsOutputTypeDef,  # (1)
    CreateTime: datetime,
    ExpireTime: datetime,
    UpdateTime: datetime,
    Description: str,
    Tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ApiKeyRestrictionsOutputTypeDef
  2. See ResponseMetadataTypeDef

DescribeRouteCalculatorResponseTypeDef#

# DescribeRouteCalculatorResponseTypeDef definition

class DescribeRouteCalculatorResponseTypeDef(TypedDict):
    CalculatorName: str,
    CalculatorArn: str,
    PricingPlan: PricingPlanType,  # (1)
    Description: str,
    CreateTime: datetime,
    UpdateTime: datetime,
    DataSource: str,
    Tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PricingPlanType
  2. See ResponseMetadataTypeDef

DescribeTrackerResponseTypeDef#

# DescribeTrackerResponseTypeDef definition

class DescribeTrackerResponseTypeDef(TypedDict):
    TrackerName: str,
    TrackerArn: str,
    Description: str,
    PricingPlan: PricingPlanType,  # (1)
    PricingPlanDataSource: str,
    Tags: dict[str, str],
    CreateTime: datetime,
    UpdateTime: datetime,
    KmsKeyId: str,
    PositionFiltering: PositionFilteringType,  # (2)
    EventBridgeEnabled: bool,
    KmsKeyEnableGeospatialQueries: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See PricingPlanType
  2. See PositionFilteringType
  3. See ResponseMetadataTypeDef

GetMapGlyphsResponseTypeDef#

# GetMapGlyphsResponseTypeDef definition

class GetMapGlyphsResponseTypeDef(TypedDict):
    Blob: StreamingBody,
    ContentType: str,
    CacheControl: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetMapSpritesResponseTypeDef#

# GetMapSpritesResponseTypeDef definition

class GetMapSpritesResponseTypeDef(TypedDict):
    Blob: StreamingBody,
    ContentType: str,
    CacheControl: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetMapStyleDescriptorResponseTypeDef#

# GetMapStyleDescriptorResponseTypeDef definition

class GetMapStyleDescriptorResponseTypeDef(TypedDict):
    Blob: StreamingBody,
    ContentType: str,
    CacheControl: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetMapTileResponseTypeDef#

# GetMapTileResponseTypeDef definition

class GetMapTileResponseTypeDef(TypedDict):
    Blob: StreamingBody,
    ContentType: str,
    CacheControl: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTrackerConsumersResponseTypeDef#

# ListTrackerConsumersResponseTypeDef definition

class ListTrackerConsumersResponseTypeDef(TypedDict):
    ConsumerArns: list[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
    NextToken: NotRequired[str],
  1. See ResponseMetadataTypeDef

PutGeofenceResponseTypeDef#

# PutGeofenceResponseTypeDef definition

class PutGeofenceResponseTypeDef(TypedDict):
    GeofenceId: str,
    CreateTime: datetime,
    UpdateTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateGeofenceCollectionResponseTypeDef#

# UpdateGeofenceCollectionResponseTypeDef definition

class UpdateGeofenceCollectionResponseTypeDef(TypedDict):
    CollectionName: str,
    CollectionArn: str,
    UpdateTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateKeyResponseTypeDef#

# UpdateKeyResponseTypeDef definition

class UpdateKeyResponseTypeDef(TypedDict):
    KeyArn: str,
    KeyName: str,
    UpdateTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateMapResponseTypeDef#

# UpdateMapResponseTypeDef definition

class UpdateMapResponseTypeDef(TypedDict):
    MapName: str,
    MapArn: str,
    UpdateTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdatePlaceIndexResponseTypeDef#

# UpdatePlaceIndexResponseTypeDef definition

class UpdatePlaceIndexResponseTypeDef(TypedDict):
    IndexName: str,
    IndexArn: str,
    UpdateTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateRouteCalculatorResponseTypeDef#

# UpdateRouteCalculatorResponseTypeDef definition

class UpdateRouteCalculatorResponseTypeDef(TypedDict):
    CalculatorName: str,
    CalculatorArn: str,
    UpdateTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateTrackerResponseTypeDef#

# UpdateTrackerResponseTypeDef definition

class UpdateTrackerResponseTypeDef(TypedDict):
    TrackerName: str,
    TrackerArn: str,
    UpdateTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateKeyRequestRequestTypeDef#

# CreateKeyRequestRequestTypeDef definition

class CreateKeyRequestRequestTypeDef(TypedDict):
    KeyName: str,
    Restrictions: ApiKeyRestrictionsTypeDef,  # (1)
    Description: NotRequired[str],
    ExpireTime: NotRequired[TimestampTypeDef],
    NoExpiry: NotRequired[bool],
    Tags: NotRequired[Mapping[str, str]],
  1. See ApiKeyRestrictionsTypeDef

GetDevicePositionHistoryRequestRequestTypeDef#

# GetDevicePositionHistoryRequestRequestTypeDef definition

class GetDevicePositionHistoryRequestRequestTypeDef(TypedDict):
    TrackerName: str,
    DeviceId: str,
    NextToken: NotRequired[str],
    StartTimeInclusive: NotRequired[TimestampTypeDef],
    EndTimeExclusive: NotRequired[TimestampTypeDef],
    MaxResults: NotRequired[int],

UpdateKeyRequestRequestTypeDef#

# UpdateKeyRequestRequestTypeDef definition

class UpdateKeyRequestRequestTypeDef(TypedDict):
    KeyName: str,
    Description: NotRequired[str],
    ExpireTime: NotRequired[TimestampTypeDef],
    NoExpiry: NotRequired[bool],
    ForceUpdate: NotRequired[bool],
    Restrictions: NotRequired[ApiKeyRestrictionsTypeDef],  # (1)
  1. See ApiKeyRestrictionsTypeDef

CalculateRouteTruckModeOptionsTypeDef#

# CalculateRouteTruckModeOptionsTypeDef definition

class CalculateRouteTruckModeOptionsTypeDef(TypedDict):
    AvoidFerries: NotRequired[bool],
    AvoidTolls: NotRequired[bool],
    Dimensions: NotRequired[TruckDimensionsTypeDef],  # (1)
    Weight: NotRequired[TruckWeightTypeDef],  # (2)
  1. See TruckDimensionsTypeDef
  2. See TruckWeightTypeDef

GeofenceGeometryOutputTypeDef#

# GeofenceGeometryOutputTypeDef definition

class GeofenceGeometryOutputTypeDef(TypedDict):
    Polygon: NotRequired[list[list[list[float]]]],
    Circle: NotRequired[CircleOutputTypeDef],  # (1)
    Geobuf: NotRequired[bytes],
  1. See CircleOutputTypeDef

CreateMapRequestRequestTypeDef#

# CreateMapRequestRequestTypeDef definition

class CreateMapRequestRequestTypeDef(TypedDict):
    MapName: str,
    Configuration: MapConfigurationTypeDef,  # (1)
    PricingPlan: NotRequired[PricingPlanType],  # (2)
    Description: NotRequired[str],
    Tags: NotRequired[Mapping[str, str]],
  1. See MapConfigurationTypeDef
  2. See PricingPlanType

CreatePlaceIndexRequestRequestTypeDef#

# CreatePlaceIndexRequestRequestTypeDef definition

class CreatePlaceIndexRequestRequestTypeDef(TypedDict):
    IndexName: str,
    DataSource: str,
    PricingPlan: NotRequired[PricingPlanType],  # (1)
    Description: NotRequired[str],
    DataSourceConfiguration: NotRequired[DataSourceConfigurationTypeDef],  # (2)
    Tags: NotRequired[Mapping[str, str]],
  1. See PricingPlanType
  2. See DataSourceConfigurationTypeDef

DescribePlaceIndexResponseTypeDef#

# DescribePlaceIndexResponseTypeDef definition

class DescribePlaceIndexResponseTypeDef(TypedDict):
    IndexName: str,
    IndexArn: str,
    PricingPlan: PricingPlanType,  # (1)
    Description: str,
    CreateTime: datetime,
    UpdateTime: datetime,
    DataSource: str,
    DataSourceConfiguration: DataSourceConfigurationTypeDef,  # (2)
    Tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See PricingPlanType
  2. See DataSourceConfigurationTypeDef
  3. See ResponseMetadataTypeDef

UpdatePlaceIndexRequestRequestTypeDef#

# UpdatePlaceIndexRequestRequestTypeDef definition

class UpdatePlaceIndexRequestRequestTypeDef(TypedDict):
    IndexName: str,
    PricingPlan: NotRequired[PricingPlanType],  # (1)
    Description: NotRequired[str],
    DataSourceConfiguration: NotRequired[DataSourceConfigurationTypeDef],  # (2)
  1. See PricingPlanType
  2. See DataSourceConfigurationTypeDef

DescribeMapResponseTypeDef#

# 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,
    UpdateTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See PricingPlanType
  2. See MapConfigurationOutputTypeDef
  3. See ResponseMetadataTypeDef

DevicePositionTypeDef#

# DevicePositionTypeDef definition

class DevicePositionTypeDef(TypedDict):
    SampleTime: datetime,
    ReceivedTime: datetime,
    Position: list[float],
    DeviceId: NotRequired[str],
    Accuracy: NotRequired[PositionalAccuracyTypeDef],  # (1)
    PositionProperties: NotRequired[dict[str, str]],
  1. See PositionalAccuracyTypeDef

DevicePositionUpdateTypeDef#

# DevicePositionUpdateTypeDef definition

class DevicePositionUpdateTypeDef(TypedDict):
    DeviceId: str,
    SampleTime: TimestampTypeDef,
    Position: Sequence[float],
    Accuracy: NotRequired[PositionalAccuracyTypeDef],  # (1)
    PositionProperties: NotRequired[Mapping[str, str]],
  1. See PositionalAccuracyTypeDef

GetDevicePositionResponseTypeDef#

# GetDevicePositionResponseTypeDef definition

class GetDevicePositionResponseTypeDef(TypedDict):
    DeviceId: str,
    SampleTime: datetime,
    ReceivedTime: datetime,
    Position: list[float],
    Accuracy: PositionalAccuracyTypeDef,  # (1)
    PositionProperties: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PositionalAccuracyTypeDef
  2. See ResponseMetadataTypeDef

InferredStateTypeDef#

# InferredStateTypeDef definition

class InferredStateTypeDef(TypedDict):
    ProxyDetected: bool,
    Position: NotRequired[list[float]],
    Accuracy: NotRequired[PositionalAccuracyTypeDef],  # (1)
    DeviationDistance: NotRequired[float],
  1. See PositionalAccuracyTypeDef

ListDevicePositionsResponseEntryTypeDef#

# ListDevicePositionsResponseEntryTypeDef definition

class ListDevicePositionsResponseEntryTypeDef(TypedDict):
    DeviceId: str,
    SampleTime: datetime,
    Position: list[float],
    Accuracy: NotRequired[PositionalAccuracyTypeDef],  # (1)
    PositionProperties: NotRequired[dict[str, str]],
  1. See PositionalAccuracyTypeDef

ForecastGeofenceEventsRequestRequestTypeDef#

# ForecastGeofenceEventsRequestRequestTypeDef definition

class ForecastGeofenceEventsRequestRequestTypeDef(TypedDict):
    CollectionName: str,
    DeviceState: ForecastGeofenceEventsDeviceStateTypeDef,  # (1)
    TimeHorizonMinutes: NotRequired[float],
    DistanceUnit: NotRequired[DistanceUnitType],  # (2)
    SpeedUnit: NotRequired[SpeedUnitType],  # (3)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See ForecastGeofenceEventsDeviceStateTypeDef
  2. See DistanceUnitType
  3. See SpeedUnitType

ForecastGeofenceEventsRequestPaginateTypeDef#

# 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)
  1. See ForecastGeofenceEventsDeviceStateTypeDef
  2. See DistanceUnitType
  3. See SpeedUnitType
  4. See PaginatorConfigTypeDef

GetDevicePositionHistoryRequestPaginateTypeDef#

# GetDevicePositionHistoryRequestPaginateTypeDef definition

class GetDevicePositionHistoryRequestPaginateTypeDef(TypedDict):
    TrackerName: str,
    DeviceId: str,
    StartTimeInclusive: NotRequired[TimestampTypeDef],
    EndTimeExclusive: NotRequired[TimestampTypeDef],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListGeofenceCollectionsRequestPaginateTypeDef#

# ListGeofenceCollectionsRequestPaginateTypeDef definition

class ListGeofenceCollectionsRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListGeofencesRequestPaginateTypeDef#

# ListGeofencesRequestPaginateTypeDef definition

class ListGeofencesRequestPaginateTypeDef(TypedDict):
    CollectionName: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListKeysRequestPaginateTypeDef#

# ListKeysRequestPaginateTypeDef definition

class ListKeysRequestPaginateTypeDef(TypedDict):
    Filter: NotRequired[ApiKeyFilterTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ApiKeyFilterTypeDef
  2. See PaginatorConfigTypeDef

ListMapsRequestPaginateTypeDef#

# ListMapsRequestPaginateTypeDef definition

class ListMapsRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListPlaceIndexesRequestPaginateTypeDef#

# ListPlaceIndexesRequestPaginateTypeDef definition

class ListPlaceIndexesRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListRouteCalculatorsRequestPaginateTypeDef#

# ListRouteCalculatorsRequestPaginateTypeDef definition

class ListRouteCalculatorsRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTrackerConsumersRequestPaginateTypeDef#

# ListTrackerConsumersRequestPaginateTypeDef definition

class ListTrackerConsumersRequestPaginateTypeDef(TypedDict):
    TrackerName: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTrackersRequestPaginateTypeDef#

# ListTrackersRequestPaginateTypeDef definition

class ListTrackersRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ForecastGeofenceEventsResponseTypeDef#

# ForecastGeofenceEventsResponseTypeDef definition

class ForecastGeofenceEventsResponseTypeDef(TypedDict):
    ForecastedEvents: list[ForecastedEventTypeDef],  # (1)
    DistanceUnit: DistanceUnitType,  # (2)
    SpeedUnit: SpeedUnitType,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
    NextToken: NotRequired[str],
  1. See ForecastedEventTypeDef
  2. See DistanceUnitType
  3. See SpeedUnitType
  4. See ResponseMetadataTypeDef

LegTypeDef#

# LegTypeDef definition

class LegTypeDef(TypedDict):
    StartPosition: list[float],
    EndPosition: list[float],
    Distance: float,
    DurationSeconds: float,
    Steps: list[StepTypeDef],  # (2)
    Geometry: NotRequired[LegGeometryTypeDef],  # (1)
  1. See LegGeometryTypeDef
  2. See StepTypeDef

ListDevicePositionsRequestPaginateTypeDef#

# ListDevicePositionsRequestPaginateTypeDef definition

class ListDevicePositionsRequestPaginateTypeDef(TypedDict):
    TrackerName: str,
    FilterGeometry: NotRequired[TrackingFilterGeometryTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See TrackingFilterGeometryTypeDef
  2. See PaginatorConfigTypeDef

ListDevicePositionsRequestRequestTypeDef#

# ListDevicePositionsRequestRequestTypeDef definition

class ListDevicePositionsRequestRequestTypeDef(TypedDict):
    TrackerName: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    FilterGeometry: NotRequired[TrackingFilterGeometryTypeDef],  # (1)
  1. See TrackingFilterGeometryTypeDef

ListGeofenceCollectionsResponseTypeDef#

# ListGeofenceCollectionsResponseTypeDef definition

class ListGeofenceCollectionsResponseTypeDef(TypedDict):
    Entries: list[ListGeofenceCollectionsResponseEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ListGeofenceCollectionsResponseEntryTypeDef
  2. See ResponseMetadataTypeDef

ListMapsResponseTypeDef#

# ListMapsResponseTypeDef definition

class ListMapsResponseTypeDef(TypedDict):
    Entries: list[ListMapsResponseEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ListMapsResponseEntryTypeDef
  2. See ResponseMetadataTypeDef

ListPlaceIndexesResponseTypeDef#

# ListPlaceIndexesResponseTypeDef definition

class ListPlaceIndexesResponseTypeDef(TypedDict):
    Entries: list[ListPlaceIndexesResponseEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ListPlaceIndexesResponseEntryTypeDef
  2. See ResponseMetadataTypeDef

ListRouteCalculatorsResponseTypeDef#

# ListRouteCalculatorsResponseTypeDef definition

class ListRouteCalculatorsResponseTypeDef(TypedDict):
    Entries: list[ListRouteCalculatorsResponseEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ListRouteCalculatorsResponseEntryTypeDef
  2. See ResponseMetadataTypeDef

ListTrackersResponseTypeDef#

# ListTrackersResponseTypeDef definition

class ListTrackersResponseTypeDef(TypedDict):
    Entries: list[ListTrackersResponseEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ListTrackersResponseEntryTypeDef
  2. See ResponseMetadataTypeDef

LteCellDetailsTypeDef#

# 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],
  1. See LteLocalIdTypeDef
  2. See LteNetworkMeasurementsTypeDef

UpdateMapRequestRequestTypeDef#

# UpdateMapRequestRequestTypeDef definition

class UpdateMapRequestRequestTypeDef(TypedDict):
    MapName: str,
    PricingPlan: NotRequired[PricingPlanType],  # (1)
    Description: NotRequired[str],
    ConfigurationUpdate: NotRequired[MapConfigurationUpdateTypeDef],  # (2)
  1. See PricingPlanType
  2. See MapConfigurationUpdateTypeDef

PlaceTypeDef#

# 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],
  1. See PlaceGeometryTypeDef
  2. See TimeZoneTypeDef

RouteMatrixEntryTypeDef#

# RouteMatrixEntryTypeDef definition

class RouteMatrixEntryTypeDef(TypedDict):
    Distance: NotRequired[float],
    DurationSeconds: NotRequired[float],
    Error: NotRequired[RouteMatrixEntryErrorTypeDef],  # (1)
  1. See RouteMatrixEntryErrorTypeDef

SearchPlaceIndexForSuggestionsResponseTypeDef#

# SearchPlaceIndexForSuggestionsResponseTypeDef definition

class SearchPlaceIndexForSuggestionsResponseTypeDef(TypedDict):
    Summary: SearchPlaceIndexForSuggestionsSummaryTypeDef,  # (1)
    Results: list[SearchForSuggestionsResultTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See SearchPlaceIndexForSuggestionsSummaryTypeDef
  2. See SearchForSuggestionsResultTypeDef
  3. See ResponseMetadataTypeDef

ListKeysResponseTypeDef#

# ListKeysResponseTypeDef definition

class ListKeysResponseTypeDef(TypedDict):
    Entries: list[ListKeysResponseEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ListKeysResponseEntryTypeDef
  2. See ResponseMetadataTypeDef

BatchDeleteDevicePositionHistoryResponseTypeDef#

# BatchDeleteDevicePositionHistoryResponseTypeDef definition

class BatchDeleteDevicePositionHistoryResponseTypeDef(TypedDict):
    Errors: list[BatchDeleteDevicePositionHistoryErrorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BatchDeleteDevicePositionHistoryErrorTypeDef
  2. See ResponseMetadataTypeDef

BatchDeleteGeofenceResponseTypeDef#

# BatchDeleteGeofenceResponseTypeDef definition

class BatchDeleteGeofenceResponseTypeDef(TypedDict):
    Errors: list[BatchDeleteGeofenceErrorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BatchDeleteGeofenceErrorTypeDef
  2. See ResponseMetadataTypeDef

BatchEvaluateGeofencesResponseTypeDef#

# BatchEvaluateGeofencesResponseTypeDef definition

class BatchEvaluateGeofencesResponseTypeDef(TypedDict):
    Errors: list[BatchEvaluateGeofencesErrorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BatchEvaluateGeofencesErrorTypeDef
  2. See ResponseMetadataTypeDef

BatchPutGeofenceResponseTypeDef#

# BatchPutGeofenceResponseTypeDef definition

class BatchPutGeofenceResponseTypeDef(TypedDict):
    Successes: list[BatchPutGeofenceSuccessTypeDef],  # (1)
    Errors: list[BatchPutGeofenceErrorTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See BatchPutGeofenceSuccessTypeDef
  2. See BatchPutGeofenceErrorTypeDef
  3. See ResponseMetadataTypeDef

BatchUpdateDevicePositionResponseTypeDef#

# BatchUpdateDevicePositionResponseTypeDef definition

class BatchUpdateDevicePositionResponseTypeDef(TypedDict):
    Errors: list[BatchUpdateDevicePositionErrorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BatchUpdateDevicePositionErrorTypeDef
  2. See ResponseMetadataTypeDef

CalculateRouteMatrixRequestRequestTypeDef#

# CalculateRouteMatrixRequestRequestTypeDef definition

class CalculateRouteMatrixRequestRequestTypeDef(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],
  1. See TravelModeType
  2. See DistanceUnitType
  3. See CalculateRouteCarModeOptionsTypeDef
  4. See CalculateRouteTruckModeOptionsTypeDef

CalculateRouteRequestRequestTypeDef#

# CalculateRouteRequestRequestTypeDef definition

class CalculateRouteRequestRequestTypeDef(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],
  1. See TravelModeType
  2. See DistanceUnitType
  3. See CalculateRouteCarModeOptionsTypeDef
  4. See CalculateRouteTruckModeOptionsTypeDef
  5. See OptimizationModeType

GetGeofenceResponseTypeDef#

# GetGeofenceResponseTypeDef definition

class GetGeofenceResponseTypeDef(TypedDict):
    GeofenceId: str,
    Geometry: GeofenceGeometryOutputTypeDef,  # (1)
    Status: str,
    CreateTime: datetime,
    UpdateTime: datetime,
    GeofenceProperties: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GeofenceGeometryOutputTypeDef
  2. See ResponseMetadataTypeDef

ListGeofenceResponseEntryTypeDef#

# ListGeofenceResponseEntryTypeDef definition

class ListGeofenceResponseEntryTypeDef(TypedDict):
    GeofenceId: str,
    Geometry: GeofenceGeometryOutputTypeDef,  # (1)
    Status: str,
    CreateTime: datetime,
    UpdateTime: datetime,
    GeofenceProperties: NotRequired[dict[str, str]],
  1. See GeofenceGeometryOutputTypeDef

GeofenceGeometryTypeDef#

# GeofenceGeometryTypeDef definition

class GeofenceGeometryTypeDef(TypedDict):
    Polygon: NotRequired[Sequence[Sequence[Sequence[float]]]],
    Circle: NotRequired[CircleUnionTypeDef],  # (1)
    Geobuf: NotRequired[BlobTypeDef],
  1. See CircleTypeDef CircleOutputTypeDef

BatchGetDevicePositionResponseTypeDef#

# BatchGetDevicePositionResponseTypeDef definition

class BatchGetDevicePositionResponseTypeDef(TypedDict):
    Errors: list[BatchGetDevicePositionErrorTypeDef],  # (1)
    DevicePositions: list[DevicePositionTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See BatchGetDevicePositionErrorTypeDef
  2. See DevicePositionTypeDef
  3. See ResponseMetadataTypeDef

GetDevicePositionHistoryResponseTypeDef#

# GetDevicePositionHistoryResponseTypeDef definition

class GetDevicePositionHistoryResponseTypeDef(TypedDict):
    DevicePositions: list[DevicePositionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See DevicePositionTypeDef
  2. See ResponseMetadataTypeDef

BatchEvaluateGeofencesRequestRequestTypeDef#

# BatchEvaluateGeofencesRequestRequestTypeDef definition

class BatchEvaluateGeofencesRequestRequestTypeDef(TypedDict):
    CollectionName: str,
    DevicePositionUpdates: Sequence[DevicePositionUpdateTypeDef],  # (1)
  1. See DevicePositionUpdateTypeDef

BatchUpdateDevicePositionRequestRequestTypeDef#

# BatchUpdateDevicePositionRequestRequestTypeDef definition

class BatchUpdateDevicePositionRequestRequestTypeDef(TypedDict):
    TrackerName: str,
    Updates: Sequence[DevicePositionUpdateTypeDef],  # (1)
  1. See DevicePositionUpdateTypeDef

VerifyDevicePositionResponseTypeDef#

# VerifyDevicePositionResponseTypeDef definition

class VerifyDevicePositionResponseTypeDef(TypedDict):
    InferredState: InferredStateTypeDef,  # (1)
    DeviceId: str,
    SampleTime: datetime,
    ReceivedTime: datetime,
    DistanceUnit: DistanceUnitType,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See InferredStateTypeDef
  2. See DistanceUnitType
  3. See ResponseMetadataTypeDef

ListDevicePositionsResponseTypeDef#

# ListDevicePositionsResponseTypeDef definition

class ListDevicePositionsResponseTypeDef(TypedDict):
    Entries: list[ListDevicePositionsResponseEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ListDevicePositionsResponseEntryTypeDef
  2. See ResponseMetadataTypeDef

CalculateRouteResponseTypeDef#

# CalculateRouteResponseTypeDef definition

class CalculateRouteResponseTypeDef(TypedDict):
    Legs: list[LegTypeDef],  # (1)
    Summary: CalculateRouteSummaryTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See LegTypeDef
  2. See CalculateRouteSummaryTypeDef
  3. See ResponseMetadataTypeDef

CellSignalsTypeDef#

# CellSignalsTypeDef definition

class CellSignalsTypeDef(TypedDict):
    LteCellDetails: Sequence[LteCellDetailsTypeDef],  # (1)
  1. See LteCellDetailsTypeDef

GetPlaceResponseTypeDef#

# GetPlaceResponseTypeDef definition

class GetPlaceResponseTypeDef(TypedDict):
    Place: PlaceTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PlaceTypeDef
  2. See ResponseMetadataTypeDef

SearchForPositionResultTypeDef#

# SearchForPositionResultTypeDef definition

class SearchForPositionResultTypeDef(TypedDict):
    Place: PlaceTypeDef,  # (1)
    Distance: float,
    PlaceId: NotRequired[str],
  1. See PlaceTypeDef

SearchForTextResultTypeDef#

# SearchForTextResultTypeDef definition

class SearchForTextResultTypeDef(TypedDict):
    Place: PlaceTypeDef,  # (1)
    Distance: NotRequired[float],
    Relevance: NotRequired[float],
    PlaceId: NotRequired[str],
  1. See PlaceTypeDef

CalculateRouteMatrixResponseTypeDef#

# CalculateRouteMatrixResponseTypeDef definition

class CalculateRouteMatrixResponseTypeDef(TypedDict):
    RouteMatrix: list[list[RouteMatrixEntryTypeDef]],  # (1)
    SnappedDeparturePositions: list[list[float]],
    SnappedDestinationPositions: list[list[float]],
    Summary: CalculateRouteMatrixSummaryTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See RouteMatrixEntryTypeDef
  2. See CalculateRouteMatrixSummaryTypeDef
  3. See ResponseMetadataTypeDef

ListGeofencesResponseTypeDef#

# ListGeofencesResponseTypeDef definition

class ListGeofencesResponseTypeDef(TypedDict):
    Entries: list[ListGeofenceResponseEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ListGeofenceResponseEntryTypeDef
  2. See ResponseMetadataTypeDef

PutGeofenceRequestRequestTypeDef#

# PutGeofenceRequestRequestTypeDef definition

class PutGeofenceRequestRequestTypeDef(TypedDict):
    CollectionName: str,
    GeofenceId: str,
    Geometry: GeofenceGeometryTypeDef,  # (1)
    GeofenceProperties: NotRequired[Mapping[str, str]],
  1. See GeofenceGeometryTypeDef

DeviceStateTypeDef#

# 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)
  1. See PositionalAccuracyTypeDef
  2. See WiFiAccessPointTypeDef
  3. See CellSignalsTypeDef

SearchPlaceIndexForPositionResponseTypeDef#

# SearchPlaceIndexForPositionResponseTypeDef definition

class SearchPlaceIndexForPositionResponseTypeDef(TypedDict):
    Summary: SearchPlaceIndexForPositionSummaryTypeDef,  # (1)
    Results: list[SearchForPositionResultTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See SearchPlaceIndexForPositionSummaryTypeDef
  2. See SearchForPositionResultTypeDef
  3. See ResponseMetadataTypeDef

SearchPlaceIndexForTextResponseTypeDef#

# SearchPlaceIndexForTextResponseTypeDef definition

class SearchPlaceIndexForTextResponseTypeDef(TypedDict):
    Summary: SearchPlaceIndexForTextSummaryTypeDef,  # (1)
    Results: list[SearchForTextResultTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See SearchPlaceIndexForTextSummaryTypeDef
  2. See SearchForTextResultTypeDef
  3. See ResponseMetadataTypeDef

BatchPutGeofenceRequestEntryTypeDef#

# BatchPutGeofenceRequestEntryTypeDef definition

class BatchPutGeofenceRequestEntryTypeDef(TypedDict):
    GeofenceId: str,
    Geometry: GeofenceGeometryUnionTypeDef,  # (1)
    GeofenceProperties: NotRequired[Mapping[str, str]],
  1. See GeofenceGeometryTypeDef GeofenceGeometryOutputTypeDef

VerifyDevicePositionRequestRequestTypeDef#

# VerifyDevicePositionRequestRequestTypeDef definition

class VerifyDevicePositionRequestRequestTypeDef(TypedDict):
    TrackerName: str,
    DeviceState: DeviceStateTypeDef,  # (1)
    DistanceUnit: NotRequired[DistanceUnitType],  # (2)
  1. See DeviceStateTypeDef
  2. See DistanceUnitType

BatchPutGeofenceRequestRequestTypeDef#

# BatchPutGeofenceRequestRequestTypeDef definition

class BatchPutGeofenceRequestRequestTypeDef(TypedDict):
    CollectionName: str,
    Entries: Sequence[BatchPutGeofenceRequestEntryTypeDef],  # (1)
  1. See BatchPutGeofenceRequestEntryTypeDef