Skip to content

Type definitions#

Index > LocationService > Type definitions

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

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

ApiKeyFilterTypeDef#

# ApiKeyFilterTypeDef definition

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

ApiKeyRestrictionsPaginatorTypeDef#

# ApiKeyRestrictionsPaginatorTypeDef definition

class ApiKeyRestrictionsPaginatorTypeDef(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):
    ConsumerArn: str,
    TrackerName: str,

BatchItemErrorTypeDef#

# BatchItemErrorTypeDef definition

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

BatchDeleteDevicePositionHistoryRequestRequestTypeDef#

# BatchDeleteDevicePositionHistoryRequestRequestTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

BatchDeleteGeofenceRequestRequestTypeDef#

# BatchDeleteGeofenceRequestRequestTypeDef definition

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

BatchGetDevicePositionRequestRequestTypeDef#

# BatchGetDevicePositionRequestRequestTypeDef definition

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

BatchPutGeofenceSuccessTypeDef#

# BatchPutGeofenceSuccessTypeDef definition

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

CalculateRouteCarModeOptionsTypeDef#

# CalculateRouteCarModeOptionsTypeDef definition

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

CalculateRouteMatrixSummaryTypeDef#

# CalculateRouteMatrixSummaryTypeDef definition

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

CalculateRouteSummaryTypeDef#

# CalculateRouteSummaryTypeDef definition

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

TruckDimensionsTypeDef#

# TruckDimensionsTypeDef definition

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

TruckWeightTypeDef#

# TruckWeightTypeDef definition

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

CirclePaginatorTypeDef#

# CirclePaginatorTypeDef definition

class CirclePaginatorTypeDef(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,
    Description: NotRequired[str],
    KmsKeyId: NotRequired[str],
    PricingPlan: NotRequired[PricingPlanType],  # (1)
    PricingPlanDataSource: NotRequired[str],
    Tags: NotRequired[Mapping[str, str]],
  1. See PricingPlanType

MapConfigurationTypeDef#

# MapConfigurationTypeDef definition

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

DataSourceConfigurationTypeDef#

# DataSourceConfigurationTypeDef definition

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

CreateRouteCalculatorRequestRequestTypeDef#

# CreateRouteCalculatorRequestRequestTypeDef definition

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

CreateTrackerRequestRequestTypeDef#

# CreateTrackerRequestRequestTypeDef definition

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

DeleteGeofenceCollectionRequestRequestTypeDef#

# DeleteGeofenceCollectionRequestRequestTypeDef definition

class DeleteGeofenceCollectionRequestRequestTypeDef(TypedDict):
    CollectionName: str,

DeleteKeyRequestRequestTypeDef#

# DeleteKeyRequestRequestTypeDef definition

class DeleteKeyRequestRequestTypeDef(TypedDict):
    KeyName: str,

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,

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,

DisassociateTrackerConsumerRequestRequestTypeDef#

# DisassociateTrackerConsumerRequestRequestTypeDef definition

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

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

GetDevicePositionRequestRequestTypeDef#

# GetDevicePositionRequestRequestTypeDef definition

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

GetGeofenceRequestRequestTypeDef#

# GetGeofenceRequestRequestTypeDef definition

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

GetMapGlyphsRequestRequestTypeDef#

# GetMapGlyphsRequestRequestTypeDef definition

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

GetMapSpritesRequestRequestTypeDef#

# GetMapSpritesRequestRequestTypeDef definition

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

GetMapStyleDescriptorRequestRequestTypeDef#

# GetMapStyleDescriptorRequestRequestTypeDef definition

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

GetMapTileRequestRequestTypeDef#

# GetMapTileRequestRequestTypeDef definition

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

GetPlaceRequestRequestTypeDef#

# GetPlaceRequestRequestTypeDef definition

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

LegGeometryTypeDef#

# LegGeometryTypeDef definition

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

StepTypeDef#

# StepTypeDef definition

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

ListDevicePositionsRequestRequestTypeDef#

# ListDevicePositionsRequestRequestTypeDef definition

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

ListGeofenceCollectionsRequestRequestTypeDef#

# ListGeofenceCollectionsRequestRequestTypeDef definition

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

ListGeofenceCollectionsResponseEntryTypeDef#

# ListGeofenceCollectionsResponseEntryTypeDef definition

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

ListGeofencesRequestRequestTypeDef#

# ListGeofencesRequestRequestTypeDef definition

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

ListMapsRequestRequestTypeDef#

# ListMapsRequestRequestTypeDef definition

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

ListMapsResponseEntryTypeDef#

# ListMapsResponseEntryTypeDef definition

class ListMapsResponseEntryTypeDef(TypedDict):
    CreateTime: datetime,
    DataSource: str,
    Description: str,
    MapName: str,
    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):
    CreateTime: datetime,
    DataSource: str,
    Description: str,
    IndexName: str,
    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,
    CreateTime: datetime,
    DataSource: str,
    Description: str,
    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):
    CreateTime: datetime,
    Description: str,
    TrackerName: str,
    UpdateTime: datetime,
    PricingPlan: NotRequired[PricingPlanType],  # (1)
    PricingPlanDataSource: NotRequired[str],
  1. See PricingPlanType

MapConfigurationUpdateTypeDef#

# MapConfigurationUpdateTypeDef definition

class MapConfigurationUpdateTypeDef(TypedDict):
    PoliticalView: NotRequired[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,
    Categories: NotRequired[List[str]],
    PlaceId: NotRequired[str],
    SupplementalCategories: NotRequired[List[str]],

SearchPlaceIndexForPositionRequestRequestTypeDef#

# SearchPlaceIndexForPositionRequestRequestTypeDef definition

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

SearchPlaceIndexForPositionSummaryTypeDef#

# SearchPlaceIndexForPositionSummaryTypeDef definition

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

SearchPlaceIndexForSuggestionsRequestRequestTypeDef#

# SearchPlaceIndexForSuggestionsRequestRequestTypeDef definition

class SearchPlaceIndexForSuggestionsRequestRequestTypeDef(TypedDict):
    IndexName: str,
    Text: str,
    BiasPosition: NotRequired[Sequence[float]],
    FilterBBox: NotRequired[Sequence[float]],
    FilterCategories: NotRequired[Sequence[str]],
    FilterCountries: NotRequired[Sequence[str]],
    Key: NotRequired[str],
    Language: NotRequired[str],
    MaxResults: NotRequired[int],

SearchPlaceIndexForSuggestionsSummaryTypeDef#

# SearchPlaceIndexForSuggestionsSummaryTypeDef definition

class SearchPlaceIndexForSuggestionsSummaryTypeDef(TypedDict):
    DataSource: str,
    Text: str,
    BiasPosition: NotRequired[List[float]],
    FilterBBox: NotRequired[List[float]],
    FilterCategories: NotRequired[List[str]],
    FilterCountries: NotRequired[List[str]],
    Language: NotRequired[str],
    MaxResults: NotRequired[int],

SearchPlaceIndexForTextRequestRequestTypeDef#

# SearchPlaceIndexForTextRequestRequestTypeDef definition

class SearchPlaceIndexForTextRequestRequestTypeDef(TypedDict):
    IndexName: str,
    Text: str,
    BiasPosition: NotRequired[Sequence[float]],
    FilterBBox: NotRequired[Sequence[float]],
    FilterCategories: NotRequired[Sequence[str]],
    FilterCountries: NotRequired[Sequence[str]],
    Key: NotRequired[str],
    Language: NotRequired[str],
    MaxResults: NotRequired[int],

SearchPlaceIndexForTextSummaryTypeDef#

# SearchPlaceIndexForTextSummaryTypeDef definition

class SearchPlaceIndexForTextSummaryTypeDef(TypedDict):
    DataSource: str,
    Text: str,
    BiasPosition: NotRequired[List[float]],
    FilterBBox: NotRequired[List[float]],
    FilterCategories: NotRequired[List[str]],
    FilterCountries: NotRequired[List[str]],
    Language: NotRequired[str],
    MaxResults: NotRequired[int],
    ResultBBox: NotRequired[List[float]],

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,
    Description: NotRequired[str],
    PricingPlan: NotRequired[PricingPlanType],  # (1)
    PricingPlanDataSource: NotRequired[str],
  1. See PricingPlanType

UpdateRouteCalculatorRequestRequestTypeDef#

# UpdateRouteCalculatorRequestRequestTypeDef definition

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

UpdateTrackerRequestRequestTypeDef#

# UpdateTrackerRequestRequestTypeDef definition

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

ListKeysRequestRequestTypeDef#

# ListKeysRequestRequestTypeDef definition

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

ListKeysResponseEntryPaginatorTypeDef#

# ListKeysResponseEntryPaginatorTypeDef definition

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

ListKeysResponseEntryTypeDef#

# ListKeysResponseEntryTypeDef definition

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

BatchDeleteDevicePositionHistoryErrorTypeDef#

# BatchDeleteDevicePositionHistoryErrorTypeDef definition

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

BatchDeleteGeofenceErrorTypeDef#

# BatchDeleteGeofenceErrorTypeDef definition

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

BatchEvaluateGeofencesErrorTypeDef#

# BatchEvaluateGeofencesErrorTypeDef definition

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

BatchGetDevicePositionErrorTypeDef#

# BatchGetDevicePositionErrorTypeDef definition

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

BatchPutGeofenceErrorTypeDef#

# BatchPutGeofenceErrorTypeDef definition

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

BatchUpdateDevicePositionErrorTypeDef#

# BatchUpdateDevicePositionErrorTypeDef definition

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

CreateGeofenceCollectionResponseTypeDef#

# CreateGeofenceCollectionResponseTypeDef definition

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

CreateKeyResponseTypeDef#

# CreateKeyResponseTypeDef definition

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

CreateMapResponseTypeDef#

# CreateMapResponseTypeDef definition

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

CreatePlaceIndexResponseTypeDef#

# CreatePlaceIndexResponseTypeDef definition

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

CreateRouteCalculatorResponseTypeDef#

# CreateRouteCalculatorResponseTypeDef definition

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

CreateTrackerResponseTypeDef#

# CreateTrackerResponseTypeDef definition

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

DescribeGeofenceCollectionResponseTypeDef#

# DescribeGeofenceCollectionResponseTypeDef definition

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

DescribeKeyResponseTypeDef#

# DescribeKeyResponseTypeDef definition

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

DescribeRouteCalculatorResponseTypeDef#

# DescribeRouteCalculatorResponseTypeDef definition

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

DescribeTrackerResponseTypeDef#

# DescribeTrackerResponseTypeDef definition

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

GetMapGlyphsResponseTypeDef#

# GetMapGlyphsResponseTypeDef definition

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

GetMapSpritesResponseTypeDef#

# GetMapSpritesResponseTypeDef definition

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

GetMapStyleDescriptorResponseTypeDef#

# GetMapStyleDescriptorResponseTypeDef definition

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

GetMapTileResponseTypeDef#

# GetMapTileResponseTypeDef definition

class GetMapTileResponseTypeDef(TypedDict):
    Blob: StreamingBody,
    CacheControl: str,
    ContentType: 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],
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PutGeofenceResponseTypeDef#

# PutGeofenceResponseTypeDef definition

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

UpdateGeofenceCollectionResponseTypeDef#

# UpdateGeofenceCollectionResponseTypeDef definition

class UpdateGeofenceCollectionResponseTypeDef(TypedDict):
    CollectionArn: str,
    CollectionName: 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):
    MapArn: str,
    MapName: str,
    UpdateTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdatePlaceIndexResponseTypeDef#

# UpdatePlaceIndexResponseTypeDef definition

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

UpdateRouteCalculatorResponseTypeDef#

# UpdateRouteCalculatorResponseTypeDef definition

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

UpdateTrackerResponseTypeDef#

# UpdateTrackerResponseTypeDef definition

class UpdateTrackerResponseTypeDef(TypedDict):
    TrackerArn: str,
    TrackerName: 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[Union[datetime, str]],
    NoExpiry: NotRequired[bool],
    Tags: NotRequired[Mapping[str, str]],
  1. See ApiKeyRestrictionsTypeDef

GetDevicePositionHistoryRequestRequestTypeDef#

# GetDevicePositionHistoryRequestRequestTypeDef definition

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

UpdateKeyRequestRequestTypeDef#

# UpdateKeyRequestRequestTypeDef definition

class UpdateKeyRequestRequestTypeDef(TypedDict):
    KeyName: str,
    Description: NotRequired[str],
    ExpireTime: NotRequired[Union[datetime, str]],
    ForceUpdate: NotRequired[bool],
    NoExpiry: 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

GeofenceGeometryPaginatorTypeDef#

# GeofenceGeometryPaginatorTypeDef definition

class GeofenceGeometryPaginatorTypeDef(TypedDict):
    Circle: NotRequired[CirclePaginatorTypeDef],  # (1)
    Polygon: NotRequired[List[List[List[float]]]],
  1. See CirclePaginatorTypeDef

GeofenceGeometryTypeDef#

# GeofenceGeometryTypeDef definition

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

CreateMapRequestRequestTypeDef#

# CreateMapRequestRequestTypeDef definition

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

DescribeMapResponseTypeDef#

# DescribeMapResponseTypeDef definition

class DescribeMapResponseTypeDef(TypedDict):
    Configuration: MapConfigurationTypeDef,  # (1)
    CreateTime: datetime,
    DataSource: str,
    Description: str,
    MapArn: str,
    MapName: str,
    PricingPlan: PricingPlanType,  # (2)
    Tags: Dict[str, str],
    UpdateTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See MapConfigurationTypeDef
  2. See PricingPlanType
  3. See ResponseMetadataTypeDef

CreatePlaceIndexRequestRequestTypeDef#

# CreatePlaceIndexRequestRequestTypeDef definition

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

DescribePlaceIndexResponseTypeDef#

# DescribePlaceIndexResponseTypeDef definition

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

UpdatePlaceIndexRequestRequestTypeDef#

# UpdatePlaceIndexRequestRequestTypeDef definition

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

DevicePositionTypeDef#

# DevicePositionTypeDef definition

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

DevicePositionUpdateTypeDef#

# DevicePositionUpdateTypeDef definition

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

GetDevicePositionResponseTypeDef#

# GetDevicePositionResponseTypeDef definition

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

ListDevicePositionsResponseEntryTypeDef#

# ListDevicePositionsResponseEntryTypeDef definition

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

GetDevicePositionHistoryRequestGetDevicePositionHistoryPaginateTypeDef#

# GetDevicePositionHistoryRequestGetDevicePositionHistoryPaginateTypeDef definition

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

ListDevicePositionsRequestListDevicePositionsPaginateTypeDef#

# ListDevicePositionsRequestListDevicePositionsPaginateTypeDef definition

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

ListGeofenceCollectionsRequestListGeofenceCollectionsPaginateTypeDef#

# ListGeofenceCollectionsRequestListGeofenceCollectionsPaginateTypeDef definition

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

ListGeofencesRequestListGeofencesPaginateTypeDef#

# ListGeofencesRequestListGeofencesPaginateTypeDef definition

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

ListKeysRequestListKeysPaginateTypeDef#

# ListKeysRequestListKeysPaginateTypeDef definition

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

ListMapsRequestListMapsPaginateTypeDef#

# ListMapsRequestListMapsPaginateTypeDef definition

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

ListPlaceIndexesRequestListPlaceIndexesPaginateTypeDef#

# ListPlaceIndexesRequestListPlaceIndexesPaginateTypeDef definition

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

ListRouteCalculatorsRequestListRouteCalculatorsPaginateTypeDef#

# ListRouteCalculatorsRequestListRouteCalculatorsPaginateTypeDef definition

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

ListTrackerConsumersRequestListTrackerConsumersPaginateTypeDef#

# ListTrackerConsumersRequestListTrackerConsumersPaginateTypeDef definition

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