Typed dictionaries

Index > LocationService > Typed dictionaries

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

ApiKeyFilterTypeDef

Usage Example

from mypy_boto3_location.type_defs import ApiKeyFilterTypeDef

def get_value() -> ApiKeyFilterTypeDef:
    return {
        "KeyStatus": ...,
    }

Definition

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

1. See StatusType

ApiKeyRestrictionsTypeDef

Usage Example

from mypy_boto3_location.type_defs import ApiKeyRestrictionsTypeDef

def get_value() -> ApiKeyRestrictionsTypeDef:
    return {
        "AllowActions": ...,
        "AllowResources": ...,
    }

Definition

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

AssociateTrackerConsumerRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import AssociateTrackerConsumerRequestRequestTypeDef

def get_value() -> AssociateTrackerConsumerRequestRequestTypeDef:
    return {
        "ConsumerArn": ...,
        "TrackerName": ...,
    }

Definition

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

BatchItemErrorTypeDef

Usage Example

from mypy_boto3_location.type_defs import BatchItemErrorTypeDef

def get_value() -> BatchItemErrorTypeDef:
    return {
        "Code": ...,
    }

Definition

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

1. See BatchItemErrorCodeType

BatchDeleteDevicePositionHistoryRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import BatchDeleteDevicePositionHistoryRequestRequestTypeDef

def get_value() -> BatchDeleteDevicePositionHistoryRequestRequestTypeDef:
    return {
        "DeviceIds": ...,
        "TrackerName": ...,
    }

Definition

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

ResponseMetadataTypeDef

Usage Example

from mypy_boto3_location.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }

Definition

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

BatchDeleteGeofenceRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import BatchDeleteGeofenceRequestRequestTypeDef

def get_value() -> BatchDeleteGeofenceRequestRequestTypeDef:
    return {
        "CollectionName": ...,
        "GeofenceIds": ...,
    }

Definition

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

BatchGetDevicePositionRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import BatchGetDevicePositionRequestRequestTypeDef

def get_value() -> BatchGetDevicePositionRequestRequestTypeDef:
    return {
        "DeviceIds": ...,
        "TrackerName": ...,
    }

Definition

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

BatchPutGeofenceSuccessTypeDef

Usage Example

from mypy_boto3_location.type_defs import BatchPutGeofenceSuccessTypeDef

def get_value() -> BatchPutGeofenceSuccessTypeDef:
    return {
        "CreateTime": ...,
        "GeofenceId": ...,
        "UpdateTime": ...,
    }

Definition

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

CalculateRouteCarModeOptionsTypeDef

Usage Example

from mypy_boto3_location.type_defs import CalculateRouteCarModeOptionsTypeDef

def get_value() -> CalculateRouteCarModeOptionsTypeDef:
    return {
        "AvoidFerries": ...,
    }

Definition

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

CalculateRouteMatrixSummaryTypeDef

Usage Example

from mypy_boto3_location.type_defs import CalculateRouteMatrixSummaryTypeDef

def get_value() -> CalculateRouteMatrixSummaryTypeDef:
    return {
        "DataSource": ...,
        "DistanceUnit": ...,
        "ErrorCount": ...,
        "RouteCount": ...,
    }

Definition

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

1. See DistanceUnitType

CalculateRouteSummaryTypeDef

Usage Example

from mypy_boto3_location.type_defs import CalculateRouteSummaryTypeDef

def get_value() -> CalculateRouteSummaryTypeDef:
    return {
        "DataSource": ...,
        "Distance": ...,
        "DistanceUnit": ...,
        "DurationSeconds": ...,
        "RouteBBox": ...,
    }

Definition

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

1. See DistanceUnitType

TruckDimensionsTypeDef

Usage Example

from mypy_boto3_location.type_defs import TruckDimensionsTypeDef

def get_value() -> TruckDimensionsTypeDef:
    return {
        "Height": ...,
    }

Definition

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

1. See DimensionUnitType

TruckWeightTypeDef

Usage Example

from mypy_boto3_location.type_defs import TruckWeightTypeDef

def get_value() -> TruckWeightTypeDef:
    return {
        "Total": ...,
    }

Definition

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

1. See VehicleWeightUnitType

CircleTypeDef

Usage Example

from mypy_boto3_location.type_defs import CircleTypeDef

def get_value() -> CircleTypeDef:
    return {
        "Center": ...,
        "Radius": ...,
    }

Definition

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

CreateGeofenceCollectionRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import CreateGeofenceCollectionRequestRequestTypeDef

def get_value() -> CreateGeofenceCollectionRequestRequestTypeDef:
    return {
        "CollectionName": ...,
    }

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

Usage Example

from mypy_boto3_location.type_defs import MapConfigurationTypeDef

def get_value() -> MapConfigurationTypeDef:
    return {
        "Style": ...,
    }

Definition

class MapConfigurationTypeDef(TypedDict):
    Style: str,

DataSourceConfigurationTypeDef

Usage Example

from mypy_boto3_location.type_defs import DataSourceConfigurationTypeDef

def get_value() -> DataSourceConfigurationTypeDef:
    return {
        "IntendedUse": ...,
    }

Definition

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

1. See IntendedUseType

CreateRouteCalculatorRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import CreateRouteCalculatorRequestRequestTypeDef

def get_value() -> CreateRouteCalculatorRequestRequestTypeDef:
    return {
        "CalculatorName": ...,
        "DataSource": ...,
    }

Definition

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

1. See PricingPlanType

CreateTrackerRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import CreateTrackerRequestRequestTypeDef

def get_value() -> CreateTrackerRequestRequestTypeDef:
    return {
        "TrackerName": ...,
    }

Definition

class CreateTrackerRequestRequestTypeDef(TypedDict):
    TrackerName: str,
    Description: NotRequired[str],
    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

Usage Example

from mypy_boto3_location.type_defs import DeleteGeofenceCollectionRequestRequestTypeDef

def get_value() -> DeleteGeofenceCollectionRequestRequestTypeDef:
    return {
        "CollectionName": ...,
    }

Definition

class DeleteGeofenceCollectionRequestRequestTypeDef(TypedDict):
    CollectionName: str,

DeleteKeyRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import DeleteKeyRequestRequestTypeDef

def get_value() -> DeleteKeyRequestRequestTypeDef:
    return {
        "KeyName": ...,
    }

Definition

class DeleteKeyRequestRequestTypeDef(TypedDict):
    KeyName: str,

DeleteMapRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import DeleteMapRequestRequestTypeDef

def get_value() -> DeleteMapRequestRequestTypeDef:
    return {
        "MapName": ...,
    }

Definition

class DeleteMapRequestRequestTypeDef(TypedDict):
    MapName: str,

DeletePlaceIndexRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import DeletePlaceIndexRequestRequestTypeDef

def get_value() -> DeletePlaceIndexRequestRequestTypeDef:
    return {
        "IndexName": ...,
    }

Definition

class DeletePlaceIndexRequestRequestTypeDef(TypedDict):
    IndexName: str,

DeleteRouteCalculatorRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import DeleteRouteCalculatorRequestRequestTypeDef

def get_value() -> DeleteRouteCalculatorRequestRequestTypeDef:
    return {
        "CalculatorName": ...,
    }

Definition

class DeleteRouteCalculatorRequestRequestTypeDef(TypedDict):
    CalculatorName: str,

DeleteTrackerRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import DeleteTrackerRequestRequestTypeDef

def get_value() -> DeleteTrackerRequestRequestTypeDef:
    return {
        "TrackerName": ...,
    }

Definition

class DeleteTrackerRequestRequestTypeDef(TypedDict):
    TrackerName: str,

DescribeGeofenceCollectionRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import DescribeGeofenceCollectionRequestRequestTypeDef

def get_value() -> DescribeGeofenceCollectionRequestRequestTypeDef:
    return {
        "CollectionName": ...,
    }

Definition

class DescribeGeofenceCollectionRequestRequestTypeDef(TypedDict):
    CollectionName: str,

DescribeKeyRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import DescribeKeyRequestRequestTypeDef

def get_value() -> DescribeKeyRequestRequestTypeDef:
    return {
        "KeyName": ...,
    }

Definition

class DescribeKeyRequestRequestTypeDef(TypedDict):
    KeyName: str,

DescribeMapRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import DescribeMapRequestRequestTypeDef

def get_value() -> DescribeMapRequestRequestTypeDef:
    return {
        "MapName": ...,
    }

Definition

class DescribeMapRequestRequestTypeDef(TypedDict):
    MapName: str,

DescribePlaceIndexRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import DescribePlaceIndexRequestRequestTypeDef

def get_value() -> DescribePlaceIndexRequestRequestTypeDef:
    return {
        "IndexName": ...,
    }

Definition

class DescribePlaceIndexRequestRequestTypeDef(TypedDict):
    IndexName: str,

DescribeRouteCalculatorRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import DescribeRouteCalculatorRequestRequestTypeDef

def get_value() -> DescribeRouteCalculatorRequestRequestTypeDef:
    return {
        "CalculatorName": ...,
    }

Definition

class DescribeRouteCalculatorRequestRequestTypeDef(TypedDict):
    CalculatorName: str,

DescribeTrackerRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import DescribeTrackerRequestRequestTypeDef

def get_value() -> DescribeTrackerRequestRequestTypeDef:
    return {
        "TrackerName": ...,
    }

Definition

class DescribeTrackerRequestRequestTypeDef(TypedDict):
    TrackerName: str,

PositionalAccuracyTypeDef

Usage Example

from mypy_boto3_location.type_defs import PositionalAccuracyTypeDef

def get_value() -> PositionalAccuracyTypeDef:
    return {
        "Horizontal": ...,
    }

Definition

class PositionalAccuracyTypeDef(TypedDict):
    Horizontal: float,

DisassociateTrackerConsumerRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import DisassociateTrackerConsumerRequestRequestTypeDef

def get_value() -> DisassociateTrackerConsumerRequestRequestTypeDef:
    return {
        "ConsumerArn": ...,
        "TrackerName": ...,
    }

Definition

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

PaginatorConfigTypeDef

Usage Example

from mypy_boto3_location.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }

Definition

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

GetDevicePositionHistoryRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import GetDevicePositionHistoryRequestRequestTypeDef

def get_value() -> GetDevicePositionHistoryRequestRequestTypeDef:
    return {
        "DeviceId": ...,
        "TrackerName": ...,
    }

Definition

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

GetDevicePositionRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import GetDevicePositionRequestRequestTypeDef

def get_value() -> GetDevicePositionRequestRequestTypeDef:
    return {
        "DeviceId": ...,
        "TrackerName": ...,
    }

Definition

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

GetGeofenceRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import GetGeofenceRequestRequestTypeDef

def get_value() -> GetGeofenceRequestRequestTypeDef:
    return {
        "CollectionName": ...,
        "GeofenceId": ...,
    }

Definition

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

GetMapGlyphsRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import GetMapGlyphsRequestRequestTypeDef

def get_value() -> GetMapGlyphsRequestRequestTypeDef:
    return {
        "FontStack": ...,
        "FontUnicodeRange": ...,
        "MapName": ...,
    }

Definition

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

GetMapSpritesRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import GetMapSpritesRequestRequestTypeDef

def get_value() -> GetMapSpritesRequestRequestTypeDef:
    return {
        "FileName": ...,
        "MapName": ...,
    }

Definition

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

GetMapStyleDescriptorRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import GetMapStyleDescriptorRequestRequestTypeDef

def get_value() -> GetMapStyleDescriptorRequestRequestTypeDef:
    return {
        "MapName": ...,
    }

Definition

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

GetMapTileRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import GetMapTileRequestRequestTypeDef

def get_value() -> GetMapTileRequestRequestTypeDef:
    return {
        "MapName": ...,
        "X": ...,
        "Y": ...,
        "Z": ...,
    }

Definition

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

GetPlaceRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import GetPlaceRequestRequestTypeDef

def get_value() -> GetPlaceRequestRequestTypeDef:
    return {
        "IndexName": ...,
        "PlaceId": ...,
    }

Definition

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

LegGeometryTypeDef

Usage Example

from mypy_boto3_location.type_defs import LegGeometryTypeDef

def get_value() -> LegGeometryTypeDef:
    return {
        "LineString": ...,
    }

Definition

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

StepTypeDef

Usage Example

from mypy_boto3_location.type_defs import StepTypeDef

def get_value() -> StepTypeDef:
    return {
        "Distance": ...,
        "DurationSeconds": ...,
        "EndPosition": ...,
        "StartPosition": ...,
    }

Definition

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

ListDevicePositionsRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListDevicePositionsRequestRequestTypeDef

def get_value() -> ListDevicePositionsRequestRequestTypeDef:
    return {
        "TrackerName": ...,
    }

Definition

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

ListGeofenceCollectionsRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListGeofenceCollectionsRequestRequestTypeDef

def get_value() -> ListGeofenceCollectionsRequestRequestTypeDef:
    return {
        "MaxResults": ...,
    }

Definition

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

ListGeofenceCollectionsResponseEntryTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListGeofenceCollectionsResponseEntryTypeDef

def get_value() -> ListGeofenceCollectionsResponseEntryTypeDef:
    return {
        "CollectionName": ...,
        "CreateTime": ...,
        "Description": ...,
        "UpdateTime": ...,
    }

Definition

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

1. See PricingPlanType

ListGeofencesRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListGeofencesRequestRequestTypeDef

def get_value() -> ListGeofencesRequestRequestTypeDef:
    return {
        "CollectionName": ...,
    }

Definition

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

ListMapsRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListMapsRequestRequestTypeDef

def get_value() -> ListMapsRequestRequestTypeDef:
    return {
        "MaxResults": ...,
    }

Definition

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

ListMapsResponseEntryTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListMapsResponseEntryTypeDef

def get_value() -> ListMapsResponseEntryTypeDef:
    return {
        "CreateTime": ...,
        "DataSource": ...,
        "Description": ...,
        "MapName": ...,
        "UpdateTime": ...,
    }

Definition

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

1. See PricingPlanType

ListPlaceIndexesRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListPlaceIndexesRequestRequestTypeDef

def get_value() -> ListPlaceIndexesRequestRequestTypeDef:
    return {
        "MaxResults": ...,
    }

Definition

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

ListPlaceIndexesResponseEntryTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListPlaceIndexesResponseEntryTypeDef

def get_value() -> ListPlaceIndexesResponseEntryTypeDef:
    return {
        "CreateTime": ...,
        "DataSource": ...,
        "Description": ...,
        "IndexName": ...,
        "UpdateTime": ...,
    }

Definition

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

1. See PricingPlanType

ListRouteCalculatorsRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListRouteCalculatorsRequestRequestTypeDef

def get_value() -> ListRouteCalculatorsRequestRequestTypeDef:
    return {
        "MaxResults": ...,
    }

Definition

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

ListRouteCalculatorsResponseEntryTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListRouteCalculatorsResponseEntryTypeDef

def get_value() -> ListRouteCalculatorsResponseEntryTypeDef:
    return {
        "CalculatorName": ...,
        "CreateTime": ...,
        "DataSource": ...,
        "Description": ...,
        "UpdateTime": ...,
    }

Definition

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

1. See PricingPlanType

ListTagsForResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
    }

Definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

ListTrackerConsumersRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListTrackerConsumersRequestRequestTypeDef

def get_value() -> ListTrackerConsumersRequestRequestTypeDef:
    return {
        "TrackerName": ...,
    }

Definition

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

ListTrackersRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListTrackersRequestRequestTypeDef

def get_value() -> ListTrackersRequestRequestTypeDef:
    return {
        "MaxResults": ...,
    }

Definition

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

ListTrackersResponseEntryTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListTrackersResponseEntryTypeDef

def get_value() -> ListTrackersResponseEntryTypeDef:
    return {
        "CreateTime": ...,
        "Description": ...,
        "TrackerName": ...,
        "UpdateTime": ...,
    }

Definition

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

1. See PricingPlanType

PlaceGeometryTypeDef

Usage Example

from mypy_boto3_location.type_defs import PlaceGeometryTypeDef

def get_value() -> PlaceGeometryTypeDef:
    return {
        "Point": ...,
    }

Definition

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

TimeZoneTypeDef

Usage Example

from mypy_boto3_location.type_defs import TimeZoneTypeDef

def get_value() -> TimeZoneTypeDef:
    return {
        "Name": ...,
    }

Definition

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

RouteMatrixEntryErrorTypeDef

Usage Example

from mypy_boto3_location.type_defs import RouteMatrixEntryErrorTypeDef

def get_value() -> RouteMatrixEntryErrorTypeDef:
    return {
        "Code": ...,
    }

Definition

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

1. See RouteMatrixErrorCodeType

SearchForSuggestionsResultTypeDef

Usage Example

from mypy_boto3_location.type_defs import SearchForSuggestionsResultTypeDef

def get_value() -> SearchForSuggestionsResultTypeDef:
    return {
        "Text": ...,
    }

Definition

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

SearchPlaceIndexForPositionRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import SearchPlaceIndexForPositionRequestRequestTypeDef

def get_value() -> SearchPlaceIndexForPositionRequestRequestTypeDef:
    return {
        "IndexName": ...,
        "Position": ...,
    }

Definition

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

SearchPlaceIndexForPositionSummaryTypeDef

Usage Example

from mypy_boto3_location.type_defs import SearchPlaceIndexForPositionSummaryTypeDef

def get_value() -> SearchPlaceIndexForPositionSummaryTypeDef:
    return {
        "DataSource": ...,
        "Position": ...,
    }

Definition

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

SearchPlaceIndexForSuggestionsRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import SearchPlaceIndexForSuggestionsRequestRequestTypeDef

def get_value() -> SearchPlaceIndexForSuggestionsRequestRequestTypeDef:
    return {
        "IndexName": ...,
        "Text": ...,
    }

Definition

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

SearchPlaceIndexForSuggestionsSummaryTypeDef

Usage Example

from mypy_boto3_location.type_defs import SearchPlaceIndexForSuggestionsSummaryTypeDef

def get_value() -> SearchPlaceIndexForSuggestionsSummaryTypeDef:
    return {
        "DataSource": ...,
        "Text": ...,
    }

Definition

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

SearchPlaceIndexForTextRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import SearchPlaceIndexForTextRequestRequestTypeDef

def get_value() -> SearchPlaceIndexForTextRequestRequestTypeDef:
    return {
        "IndexName": ...,
        "Text": ...,
    }

Definition

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

SearchPlaceIndexForTextSummaryTypeDef

Usage Example

from mypy_boto3_location.type_defs import SearchPlaceIndexForTextSummaryTypeDef

def get_value() -> SearchPlaceIndexForTextSummaryTypeDef:
    return {
        "DataSource": ...,
        "Text": ...,
    }

Definition

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

TagResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
        "Tags": ...,
    }

Definition

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

UntagResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
        "TagKeys": ...,
    }

Definition

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

UpdateGeofenceCollectionRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import UpdateGeofenceCollectionRequestRequestTypeDef

def get_value() -> UpdateGeofenceCollectionRequestRequestTypeDef:
    return {
        "CollectionName": ...,
    }

Definition

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

1. See PricingPlanType

UpdateMapRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import UpdateMapRequestRequestTypeDef

def get_value() -> UpdateMapRequestRequestTypeDef:
    return {
        "MapName": ...,
    }

Definition

class UpdateMapRequestRequestTypeDef(TypedDict):
    MapName: str,
    Description: NotRequired[str],
    PricingPlan: NotRequired[PricingPlanType],  # (1)

1. See PricingPlanType

UpdateRouteCalculatorRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import UpdateRouteCalculatorRequestRequestTypeDef

def get_value() -> UpdateRouteCalculatorRequestRequestTypeDef:
    return {
        "CalculatorName": ...,
    }

Definition

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

1. See PricingPlanType

UpdateTrackerRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import UpdateTrackerRequestRequestTypeDef

def get_value() -> UpdateTrackerRequestRequestTypeDef:
    return {
        "TrackerName": ...,
    }

Definition

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

1. See PositionFilteringType
2. See PricingPlanType

ListKeysRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListKeysRequestRequestTypeDef

def get_value() -> ListKeysRequestRequestTypeDef:
    return {
        "Filter": ...,
    }

Definition

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

1. See ApiKeyFilterTypeDef

CreateKeyRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import CreateKeyRequestRequestTypeDef

def get_value() -> CreateKeyRequestRequestTypeDef:
    return {
        "KeyName": ...,
        "Restrictions": ...,
    }

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

ListKeysResponseEntryTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListKeysResponseEntryTypeDef

def get_value() -> ListKeysResponseEntryTypeDef:
    return {
        "CreateTime": ...,
        "ExpireTime": ...,
        "KeyName": ...,
        "Restrictions": ...,
        "UpdateTime": ...,
    }

Definition

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

1. See ApiKeyRestrictionsTypeDef

UpdateKeyRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import UpdateKeyRequestRequestTypeDef

def get_value() -> UpdateKeyRequestRequestTypeDef:
    return {
        "KeyName": ...,
    }

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

BatchDeleteDevicePositionHistoryErrorTypeDef

Usage Example

from mypy_boto3_location.type_defs import BatchDeleteDevicePositionHistoryErrorTypeDef

def get_value() -> BatchDeleteDevicePositionHistoryErrorTypeDef:
    return {
        "DeviceId": ...,
        "Error": ...,
    }

Definition

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

1. See BatchItemErrorTypeDef

BatchDeleteGeofenceErrorTypeDef

Usage Example

from mypy_boto3_location.type_defs import BatchDeleteGeofenceErrorTypeDef

def get_value() -> BatchDeleteGeofenceErrorTypeDef:
    return {
        "Error": ...,
        "GeofenceId": ...,
    }

Definition

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

1. See BatchItemErrorTypeDef

BatchEvaluateGeofencesErrorTypeDef

Usage Example

from mypy_boto3_location.type_defs import BatchEvaluateGeofencesErrorTypeDef

def get_value() -> BatchEvaluateGeofencesErrorTypeDef:
    return {
        "DeviceId": ...,
        "Error": ...,
        "SampleTime": ...,
    }

Definition

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

1. See BatchItemErrorTypeDef

BatchGetDevicePositionErrorTypeDef

Usage Example

from mypy_boto3_location.type_defs import BatchGetDevicePositionErrorTypeDef

def get_value() -> BatchGetDevicePositionErrorTypeDef:
    return {
        "DeviceId": ...,
        "Error": ...,
    }

Definition

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

1. See BatchItemErrorTypeDef

BatchPutGeofenceErrorTypeDef

Usage Example

from mypy_boto3_location.type_defs import BatchPutGeofenceErrorTypeDef

def get_value() -> BatchPutGeofenceErrorTypeDef:
    return {
        "Error": ...,
        "GeofenceId": ...,
    }

Definition

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

1. See BatchItemErrorTypeDef

BatchUpdateDevicePositionErrorTypeDef

Usage Example

from mypy_boto3_location.type_defs import BatchUpdateDevicePositionErrorTypeDef

def get_value() -> BatchUpdateDevicePositionErrorTypeDef:
    return {
        "DeviceId": ...,
        "Error": ...,
        "SampleTime": ...,
    }

Definition

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

1. See BatchItemErrorTypeDef

CreateGeofenceCollectionResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import CreateGeofenceCollectionResponseTypeDef

def get_value() -> CreateGeofenceCollectionResponseTypeDef:
    return {
        "CollectionArn": ...,
        "CollectionName": ...,
        "CreateTime": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

CreateKeyResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import CreateKeyResponseTypeDef

def get_value() -> CreateKeyResponseTypeDef:
    return {
        "CreateTime": ...,
        "Key": ...,
        "KeyArn": ...,
        "KeyName": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

CreateMapResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import CreateMapResponseTypeDef

def get_value() -> CreateMapResponseTypeDef:
    return {
        "CreateTime": ...,
        "MapArn": ...,
        "MapName": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

CreatePlaceIndexResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import CreatePlaceIndexResponseTypeDef

def get_value() -> CreatePlaceIndexResponseTypeDef:
    return {
        "CreateTime": ...,
        "IndexArn": ...,
        "IndexName": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

CreateRouteCalculatorResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import CreateRouteCalculatorResponseTypeDef

def get_value() -> CreateRouteCalculatorResponseTypeDef:
    return {
        "CalculatorArn": ...,
        "CalculatorName": ...,
        "CreateTime": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

CreateTrackerResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import CreateTrackerResponseTypeDef

def get_value() -> CreateTrackerResponseTypeDef:
    return {
        "CreateTime": ...,
        "TrackerArn": ...,
        "TrackerName": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

DescribeGeofenceCollectionResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import DescribeGeofenceCollectionResponseTypeDef

def get_value() -> DescribeGeofenceCollectionResponseTypeDef:
    return {
        "CollectionArn": ...,
        "CollectionName": ...,
        "CreateTime": ...,
        "Description": ...,
        "KmsKeyId": ...,
        "PricingPlan": ...,
        "PricingPlanDataSource": ...,
        "Tags": ...,
        "UpdateTime": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from mypy_boto3_location.type_defs import DescribeKeyResponseTypeDef

def get_value() -> DescribeKeyResponseTypeDef:
    return {
        "CreateTime": ...,
        "Description": ...,
        "ExpireTime": ...,
        "Key": ...,
        "KeyArn": ...,
        "KeyName": ...,
        "Restrictions": ...,
        "Tags": ...,
        "UpdateTime": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from mypy_boto3_location.type_defs import DescribeRouteCalculatorResponseTypeDef

def get_value() -> DescribeRouteCalculatorResponseTypeDef:
    return {
        "CalculatorArn": ...,
        "CalculatorName": ...,
        "CreateTime": ...,
        "DataSource": ...,
        "Description": ...,
        "PricingPlan": ...,
        "Tags": ...,
        "UpdateTime": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from mypy_boto3_location.type_defs import DescribeTrackerResponseTypeDef

def get_value() -> DescribeTrackerResponseTypeDef:
    return {
        "CreateTime": ...,
        "Description": ...,
        "KmsKeyId": ...,
        "PositionFiltering": ...,
        "PricingPlan": ...,
        "PricingPlanDataSource": ...,
        "Tags": ...,
        "TrackerArn": ...,
        "TrackerName": ...,
        "UpdateTime": ...,
        "ResponseMetadata": ...,
    }

Definition

class DescribeTrackerResponseTypeDef(TypedDict):
    CreateTime: datetime,
    Description: str,
    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

Usage Example

from mypy_boto3_location.type_defs import GetMapGlyphsResponseTypeDef

def get_value() -> GetMapGlyphsResponseTypeDef:
    return {
        "Blob": ...,
        "CacheControl": ...,
        "ContentType": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

GetMapSpritesResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import GetMapSpritesResponseTypeDef

def get_value() -> GetMapSpritesResponseTypeDef:
    return {
        "Blob": ...,
        "CacheControl": ...,
        "ContentType": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

GetMapStyleDescriptorResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import GetMapStyleDescriptorResponseTypeDef

def get_value() -> GetMapStyleDescriptorResponseTypeDef:
    return {
        "Blob": ...,
        "CacheControl": ...,
        "ContentType": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

GetMapTileResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import GetMapTileResponseTypeDef

def get_value() -> GetMapTileResponseTypeDef:
    return {
        "Blob": ...,
        "CacheControl": ...,
        "ContentType": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListTagsForResourceResponseTypeDef

def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "Tags": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

ListTrackerConsumersResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListTrackerConsumersResponseTypeDef

def get_value() -> ListTrackerConsumersResponseTypeDef:
    return {
        "ConsumerArns": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListTrackerConsumersResponseTypeDef(TypedDict):
    ConsumerArns: List[str],
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

PutGeofenceResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import PutGeofenceResponseTypeDef

def get_value() -> PutGeofenceResponseTypeDef:
    return {
        "CreateTime": ...,
        "GeofenceId": ...,
        "UpdateTime": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

UpdateGeofenceCollectionResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import UpdateGeofenceCollectionResponseTypeDef

def get_value() -> UpdateGeofenceCollectionResponseTypeDef:
    return {
        "CollectionArn": ...,
        "CollectionName": ...,
        "UpdateTime": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

UpdateKeyResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import UpdateKeyResponseTypeDef

def get_value() -> UpdateKeyResponseTypeDef:
    return {
        "KeyArn": ...,
        "KeyName": ...,
        "UpdateTime": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

UpdateMapResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import UpdateMapResponseTypeDef

def get_value() -> UpdateMapResponseTypeDef:
    return {
        "MapArn": ...,
        "MapName": ...,
        "UpdateTime": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

UpdatePlaceIndexResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import UpdatePlaceIndexResponseTypeDef

def get_value() -> UpdatePlaceIndexResponseTypeDef:
    return {
        "IndexArn": ...,
        "IndexName": ...,
        "UpdateTime": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

UpdateRouteCalculatorResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import UpdateRouteCalculatorResponseTypeDef

def get_value() -> UpdateRouteCalculatorResponseTypeDef:
    return {
        "CalculatorArn": ...,
        "CalculatorName": ...,
        "UpdateTime": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

UpdateTrackerResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import UpdateTrackerResponseTypeDef

def get_value() -> UpdateTrackerResponseTypeDef:
    return {
        "TrackerArn": ...,
        "TrackerName": ...,
        "UpdateTime": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

CalculateRouteTruckModeOptionsTypeDef

Usage Example

from mypy_boto3_location.type_defs import CalculateRouteTruckModeOptionsTypeDef

def get_value() -> CalculateRouteTruckModeOptionsTypeDef:
    return {
        "AvoidFerries": ...,
    }

Definition

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

1. See TruckDimensionsTypeDef
2. See TruckWeightTypeDef

GeofenceGeometryTypeDef

Usage Example

from mypy_boto3_location.type_defs import GeofenceGeometryTypeDef

def get_value() -> GeofenceGeometryTypeDef:
    return {
        "Circle": ...,
    }

Definition

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

1. See CircleTypeDef

CreateMapRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import CreateMapRequestRequestTypeDef

def get_value() -> CreateMapRequestRequestTypeDef:
    return {
        "Configuration": ...,
        "MapName": ...,
    }

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

Usage Example

from mypy_boto3_location.type_defs import DescribeMapResponseTypeDef

def get_value() -> DescribeMapResponseTypeDef:
    return {
        "Configuration": ...,
        "CreateTime": ...,
        "DataSource": ...,
        "Description": ...,
        "MapArn": ...,
        "MapName": ...,
        "PricingPlan": ...,
        "Tags": ...,
        "UpdateTime": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from mypy_boto3_location.type_defs import CreatePlaceIndexRequestRequestTypeDef

def get_value() -> CreatePlaceIndexRequestRequestTypeDef:
    return {
        "DataSource": ...,
        "IndexName": ...,
    }

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

Usage Example

from mypy_boto3_location.type_defs import DescribePlaceIndexResponseTypeDef

def get_value() -> DescribePlaceIndexResponseTypeDef:
    return {
        "CreateTime": ...,
        "DataSource": ...,
        "DataSourceConfiguration": ...,
        "Description": ...,
        "IndexArn": ...,
        "IndexName": ...,
        "PricingPlan": ...,
        "Tags": ...,
        "UpdateTime": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from mypy_boto3_location.type_defs import UpdatePlaceIndexRequestRequestTypeDef

def get_value() -> UpdatePlaceIndexRequestRequestTypeDef:
    return {
        "IndexName": ...,
    }

Definition

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

1. See DataSourceConfigurationTypeDef
2. See PricingPlanType

DevicePositionTypeDef

Usage Example

from mypy_boto3_location.type_defs import DevicePositionTypeDef

def get_value() -> DevicePositionTypeDef:
    return {
        "Position": ...,
        "ReceivedTime": ...,
        "SampleTime": ...,
    }

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

Usage Example

from mypy_boto3_location.type_defs import DevicePositionUpdateTypeDef

def get_value() -> DevicePositionUpdateTypeDef:
    return {
        "DeviceId": ...,
        "Position": ...,
        "SampleTime": ...,
    }

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

Usage Example

from mypy_boto3_location.type_defs import GetDevicePositionResponseTypeDef

def get_value() -> GetDevicePositionResponseTypeDef:
    return {
        "Accuracy": ...,
        "DeviceId": ...,
        "Position": ...,
        "PositionProperties": ...,
        "ReceivedTime": ...,
        "SampleTime": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from mypy_boto3_location.type_defs import ListDevicePositionsResponseEntryTypeDef

def get_value() -> ListDevicePositionsResponseEntryTypeDef:
    return {
        "DeviceId": ...,
        "Position": ...,
        "SampleTime": ...,
    }

Definition

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

1. See PositionalAccuracyTypeDef

GetDevicePositionHistoryRequestGetDevicePositionHistoryPaginateTypeDef

Usage Example

from mypy_boto3_location.type_defs import GetDevicePositionHistoryRequestGetDevicePositionHistoryPaginateTypeDef

def get_value() -> GetDevicePositionHistoryRequestGetDevicePositionHistoryPaginateTypeDef:
    return {
        "DeviceId": ...,
        "TrackerName": ...,
    }

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

Usage Example

from mypy_boto3_location.type_defs import ListDevicePositionsRequestListDevicePositionsPaginateTypeDef

def get_value() -> ListDevicePositionsRequestListDevicePositionsPaginateTypeDef:
    return {
        "TrackerName": ...,
    }

Definition

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

1. See PaginatorConfigTypeDef

ListGeofenceCollectionsRequestListGeofenceCollectionsPaginateTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListGeofenceCollectionsRequestListGeofenceCollectionsPaginateTypeDef

def get_value() -> ListGeofenceCollectionsRequestListGeofenceCollectionsPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }

Definition

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

1. See PaginatorConfigTypeDef

ListGeofencesRequestListGeofencesPaginateTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListGeofencesRequestListGeofencesPaginateTypeDef

def get_value() -> ListGeofencesRequestListGeofencesPaginateTypeDef:
    return {
        "CollectionName": ...,
    }

Definition

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

1. See PaginatorConfigTypeDef

ListKeysRequestListKeysPaginateTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListKeysRequestListKeysPaginateTypeDef

def get_value() -> ListKeysRequestListKeysPaginateTypeDef:
    return {
        "Filter": ...,
    }

Definition

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

1. See ApiKeyFilterTypeDef
2. See PaginatorConfigTypeDef

ListMapsRequestListMapsPaginateTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListMapsRequestListMapsPaginateTypeDef

def get_value() -> ListMapsRequestListMapsPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }

Definition

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

1. See PaginatorConfigTypeDef

ListPlaceIndexesRequestListPlaceIndexesPaginateTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListPlaceIndexesRequestListPlaceIndexesPaginateTypeDef

def get_value() -> ListPlaceIndexesRequestListPlaceIndexesPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }

Definition

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

1. See PaginatorConfigTypeDef

ListRouteCalculatorsRequestListRouteCalculatorsPaginateTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListRouteCalculatorsRequestListRouteCalculatorsPaginateTypeDef

def get_value() -> ListRouteCalculatorsRequestListRouteCalculatorsPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }

Definition

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

1. See PaginatorConfigTypeDef

ListTrackerConsumersRequestListTrackerConsumersPaginateTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListTrackerConsumersRequestListTrackerConsumersPaginateTypeDef

def get_value() -> ListTrackerConsumersRequestListTrackerConsumersPaginateTypeDef:
    return {
        "TrackerName": ...,
    }

Definition

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

1. See PaginatorConfigTypeDef

ListTrackersRequestListTrackersPaginateTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListTrackersRequestListTrackersPaginateTypeDef

def get_value() -> ListTrackersRequestListTrackersPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }

Definition

class ListTrackersRequestListTrackersPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

LegTypeDef

Usage Example

from mypy_boto3_location.type_defs import LegTypeDef

def get_value() -> LegTypeDef:
    return {
        "Distance": ...,
        "DurationSeconds": ...,
        "EndPosition": ...,
        "StartPosition": ...,
        "Steps": ...,
    }

Definition

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

1. See LegGeometryTypeDef
2. See StepTypeDef

ListGeofenceCollectionsResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListGeofenceCollectionsResponseTypeDef

def get_value() -> ListGeofenceCollectionsResponseTypeDef:
    return {
        "Entries": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListGeofenceCollectionsResponseTypeDef(TypedDict):
    Entries: List[ListGeofenceCollectionsResponseEntryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ListGeofenceCollectionsResponseEntryTypeDef
2. See ResponseMetadataTypeDef

ListMapsResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListMapsResponseTypeDef

def get_value() -> ListMapsResponseTypeDef:
    return {
        "Entries": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListMapsResponseTypeDef(TypedDict):
    Entries: List[ListMapsResponseEntryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ListMapsResponseEntryTypeDef
2. See ResponseMetadataTypeDef

ListPlaceIndexesResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListPlaceIndexesResponseTypeDef

def get_value() -> ListPlaceIndexesResponseTypeDef:
    return {
        "Entries": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListPlaceIndexesResponseTypeDef(TypedDict):
    Entries: List[ListPlaceIndexesResponseEntryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ListPlaceIndexesResponseEntryTypeDef
2. See ResponseMetadataTypeDef

ListRouteCalculatorsResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListRouteCalculatorsResponseTypeDef

def get_value() -> ListRouteCalculatorsResponseTypeDef:
    return {
        "Entries": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListRouteCalculatorsResponseTypeDef(TypedDict):
    Entries: List[ListRouteCalculatorsResponseEntryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ListRouteCalculatorsResponseEntryTypeDef
2. See ResponseMetadataTypeDef

ListTrackersResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListTrackersResponseTypeDef

def get_value() -> ListTrackersResponseTypeDef:
    return {
        "Entries": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListTrackersResponseTypeDef(TypedDict):
    Entries: List[ListTrackersResponseEntryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ListTrackersResponseEntryTypeDef
2. See ResponseMetadataTypeDef

PlaceTypeDef

Usage Example

from mypy_boto3_location.type_defs import PlaceTypeDef

def get_value() -> PlaceTypeDef:
    return {
        "Geometry": ...,
    }

Definition

class PlaceTypeDef(TypedDict):
    Geometry: PlaceGeometryTypeDef,  # (1)
    AddressNumber: NotRequired[str],
    Country: NotRequired[str],
    Interpolated: NotRequired[bool],
    Label: NotRequired[str],
    Municipality: NotRequired[str],
    Neighborhood: NotRequired[str],
    PostalCode: NotRequired[str],
    Region: NotRequired[str],
    Street: NotRequired[str],
    SubRegion: NotRequired[str],
    TimeZone: NotRequired[TimeZoneTypeDef],  # (2)
    UnitNumber: NotRequired[str],
    UnitType: NotRequired[str],

1. See PlaceGeometryTypeDef
2. See TimeZoneTypeDef

RouteMatrixEntryTypeDef

Usage Example

from mypy_boto3_location.type_defs import RouteMatrixEntryTypeDef

def get_value() -> RouteMatrixEntryTypeDef:
    return {
        "Distance": ...,
    }

Definition

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

1. See RouteMatrixEntryErrorTypeDef

SearchPlaceIndexForSuggestionsResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import SearchPlaceIndexForSuggestionsResponseTypeDef

def get_value() -> SearchPlaceIndexForSuggestionsResponseTypeDef:
    return {
        "Results": ...,
        "Summary": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See SearchForSuggestionsResultTypeDef
2. See SearchPlaceIndexForSuggestionsSummaryTypeDef
3. See ResponseMetadataTypeDef

ListKeysResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListKeysResponseTypeDef

def get_value() -> ListKeysResponseTypeDef:
    return {
        "Entries": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListKeysResponseTypeDef(TypedDict):
    Entries: List[ListKeysResponseEntryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ListKeysResponseEntryTypeDef
2. See ResponseMetadataTypeDef

BatchDeleteDevicePositionHistoryResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import BatchDeleteDevicePositionHistoryResponseTypeDef

def get_value() -> BatchDeleteDevicePositionHistoryResponseTypeDef:
    return {
        "Errors": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See BatchDeleteDevicePositionHistoryErrorTypeDef
2. See ResponseMetadataTypeDef

BatchDeleteGeofenceResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import BatchDeleteGeofenceResponseTypeDef

def get_value() -> BatchDeleteGeofenceResponseTypeDef:
    return {
        "Errors": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See BatchDeleteGeofenceErrorTypeDef
2. See ResponseMetadataTypeDef

BatchEvaluateGeofencesResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import BatchEvaluateGeofencesResponseTypeDef

def get_value() -> BatchEvaluateGeofencesResponseTypeDef:
    return {
        "Errors": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See BatchEvaluateGeofencesErrorTypeDef
2. See ResponseMetadataTypeDef

BatchPutGeofenceResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import BatchPutGeofenceResponseTypeDef

def get_value() -> BatchPutGeofenceResponseTypeDef:
    return {
        "Errors": ...,
        "Successes": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See BatchPutGeofenceErrorTypeDef
2. See BatchPutGeofenceSuccessTypeDef
3. See ResponseMetadataTypeDef

BatchUpdateDevicePositionResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import BatchUpdateDevicePositionResponseTypeDef

def get_value() -> BatchUpdateDevicePositionResponseTypeDef:
    return {
        "Errors": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See BatchUpdateDevicePositionErrorTypeDef
2. See ResponseMetadataTypeDef

CalculateRouteMatrixRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import CalculateRouteMatrixRequestRequestTypeDef

def get_value() -> CalculateRouteMatrixRequestRequestTypeDef:
    return {
        "CalculatorName": ...,
        "DeparturePositions": ...,
        "DestinationPositions": ...,
    }

Definition

class CalculateRouteMatrixRequestRequestTypeDef(TypedDict):
    CalculatorName: str,
    DeparturePositions: Sequence[Sequence[float]],
    DestinationPositions: Sequence[Sequence[float]],
    CarModeOptions: NotRequired[CalculateRouteCarModeOptionsTypeDef],  # (1)
    DepartNow: NotRequired[bool],
    DepartureTime: NotRequired[Union[datetime, str]],
    DistanceUnit: NotRequired[DistanceUnitType],  # (2)
    TravelMode: NotRequired[TravelModeType],  # (3)
    TruckModeOptions: NotRequired[CalculateRouteTruckModeOptionsTypeDef],  # (4)

1. See CalculateRouteCarModeOptionsTypeDef
2. See DistanceUnitType
3. See TravelModeType
4. See CalculateRouteTruckModeOptionsTypeDef

CalculateRouteRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import CalculateRouteRequestRequestTypeDef

def get_value() -> CalculateRouteRequestRequestTypeDef:
    return {
        "CalculatorName": ...,
        "DeparturePosition": ...,
        "DestinationPosition": ...,
    }

Definition

class CalculateRouteRequestRequestTypeDef(TypedDict):
    CalculatorName: str,
    DeparturePosition: Sequence[float],
    DestinationPosition: Sequence[float],
    CarModeOptions: NotRequired[CalculateRouteCarModeOptionsTypeDef],  # (1)
    DepartNow: NotRequired[bool],
    DepartureTime: NotRequired[Union[datetime, str]],
    DistanceUnit: NotRequired[DistanceUnitType],  # (2)
    IncludeLegGeometry: NotRequired[bool],
    TravelMode: NotRequired[TravelModeType],  # (3)
    TruckModeOptions: NotRequired[CalculateRouteTruckModeOptionsTypeDef],  # (4)
    WaypointPositions: NotRequired[Sequence[Sequence[float]]],

1. See CalculateRouteCarModeOptionsTypeDef
2. See DistanceUnitType
3. See TravelModeType
4. See CalculateRouteTruckModeOptionsTypeDef

BatchPutGeofenceRequestEntryTypeDef

Usage Example

from mypy_boto3_location.type_defs import BatchPutGeofenceRequestEntryTypeDef

def get_value() -> BatchPutGeofenceRequestEntryTypeDef:
    return {
        "GeofenceId": ...,
        "Geometry": ...,
    }

Definition

class BatchPutGeofenceRequestEntryTypeDef(TypedDict):
    GeofenceId: str,
    Geometry: GeofenceGeometryTypeDef,  # (1)

1. See GeofenceGeometryTypeDef

GetGeofenceResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import GetGeofenceResponseTypeDef

def get_value() -> GetGeofenceResponseTypeDef:
    return {
        "CreateTime": ...,
        "GeofenceId": ...,
        "Geometry": ...,
        "Status": ...,
        "UpdateTime": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetGeofenceResponseTypeDef(TypedDict):
    CreateTime: datetime,
    GeofenceId: str,
    Geometry: GeofenceGeometryTypeDef,  # (1)
    Status: str,
    UpdateTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See GeofenceGeometryTypeDef
2. See ResponseMetadataTypeDef

ListGeofenceResponseEntryTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListGeofenceResponseEntryTypeDef

def get_value() -> ListGeofenceResponseEntryTypeDef:
    return {
        "CreateTime": ...,
        "GeofenceId": ...,
        "Geometry": ...,
        "Status": ...,
        "UpdateTime": ...,
    }

Definition

class ListGeofenceResponseEntryTypeDef(TypedDict):
    CreateTime: datetime,
    GeofenceId: str,
    Geometry: GeofenceGeometryTypeDef,  # (1)
    Status: str,
    UpdateTime: datetime,

1. See GeofenceGeometryTypeDef

PutGeofenceRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import PutGeofenceRequestRequestTypeDef

def get_value() -> PutGeofenceRequestRequestTypeDef:
    return {
        "CollectionName": ...,
        "GeofenceId": ...,
        "Geometry": ...,
    }

Definition

class PutGeofenceRequestRequestTypeDef(TypedDict):
    CollectionName: str,
    GeofenceId: str,
    Geometry: GeofenceGeometryTypeDef,  # (1)

1. See GeofenceGeometryTypeDef

BatchGetDevicePositionResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import BatchGetDevicePositionResponseTypeDef

def get_value() -> BatchGetDevicePositionResponseTypeDef:
    return {
        "DevicePositions": ...,
        "Errors": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See DevicePositionTypeDef
2. See BatchGetDevicePositionErrorTypeDef
3. See ResponseMetadataTypeDef

GetDevicePositionHistoryResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import GetDevicePositionHistoryResponseTypeDef

def get_value() -> GetDevicePositionHistoryResponseTypeDef:
    return {
        "DevicePositions": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetDevicePositionHistoryResponseTypeDef(TypedDict):
    DevicePositions: List[DevicePositionTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See DevicePositionTypeDef
2. See ResponseMetadataTypeDef

BatchEvaluateGeofencesRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import BatchEvaluateGeofencesRequestRequestTypeDef

def get_value() -> BatchEvaluateGeofencesRequestRequestTypeDef:
    return {
        "CollectionName": ...,
        "DevicePositionUpdates": ...,
    }

Definition

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

1. See DevicePositionUpdateTypeDef

BatchUpdateDevicePositionRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import BatchUpdateDevicePositionRequestRequestTypeDef

def get_value() -> BatchUpdateDevicePositionRequestRequestTypeDef:
    return {
        "TrackerName": ...,
        "Updates": ...,
    }

Definition

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

1. See DevicePositionUpdateTypeDef

ListDevicePositionsResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListDevicePositionsResponseTypeDef

def get_value() -> ListDevicePositionsResponseTypeDef:
    return {
        "Entries": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListDevicePositionsResponseTypeDef(TypedDict):
    Entries: List[ListDevicePositionsResponseEntryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ListDevicePositionsResponseEntryTypeDef
2. See ResponseMetadataTypeDef

CalculateRouteResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import CalculateRouteResponseTypeDef

def get_value() -> CalculateRouteResponseTypeDef:
    return {
        "Legs": ...,
        "Summary": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See LegTypeDef
2. See CalculateRouteSummaryTypeDef
3. See ResponseMetadataTypeDef

GetPlaceResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import GetPlaceResponseTypeDef

def get_value() -> GetPlaceResponseTypeDef:
    return {
        "Place": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See PlaceTypeDef
2. See ResponseMetadataTypeDef

SearchForPositionResultTypeDef

Usage Example

from mypy_boto3_location.type_defs import SearchForPositionResultTypeDef

def get_value() -> SearchForPositionResultTypeDef:
    return {
        "Distance": ...,
        "Place": ...,
    }

Definition

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

1. See PlaceTypeDef

SearchForTextResultTypeDef

Usage Example

from mypy_boto3_location.type_defs import SearchForTextResultTypeDef

def get_value() -> SearchForTextResultTypeDef:
    return {
        "Place": ...,
    }

Definition

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

1. See PlaceTypeDef

CalculateRouteMatrixResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import CalculateRouteMatrixResponseTypeDef

def get_value() -> CalculateRouteMatrixResponseTypeDef:
    return {
        "RouteMatrix": ...,
        "SnappedDeparturePositions": ...,
        "SnappedDestinationPositions": ...,
        "Summary": ...,
        "ResponseMetadata": ...,
    }

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

BatchPutGeofenceRequestRequestTypeDef

Usage Example

from mypy_boto3_location.type_defs import BatchPutGeofenceRequestRequestTypeDef

def get_value() -> BatchPutGeofenceRequestRequestTypeDef:
    return {
        "CollectionName": ...,
        "Entries": ...,
    }

Definition

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

1. See BatchPutGeofenceRequestEntryTypeDef

ListGeofencesResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import ListGeofencesResponseTypeDef

def get_value() -> ListGeofencesResponseTypeDef:
    return {
        "Entries": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListGeofencesResponseTypeDef(TypedDict):
    Entries: List[ListGeofenceResponseEntryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ListGeofenceResponseEntryTypeDef
2. See ResponseMetadataTypeDef

SearchPlaceIndexForPositionResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import SearchPlaceIndexForPositionResponseTypeDef

def get_value() -> SearchPlaceIndexForPositionResponseTypeDef:
    return {
        "Results": ...,
        "Summary": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See SearchForPositionResultTypeDef
2. See SearchPlaceIndexForPositionSummaryTypeDef
3. See ResponseMetadataTypeDef

SearchPlaceIndexForTextResponseTypeDef

Usage Example

from mypy_boto3_location.type_defs import SearchPlaceIndexForTextResponseTypeDef

def get_value() -> SearchPlaceIndexForTextResponseTypeDef:
    return {
        "Results": ...,
        "Summary": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See SearchForTextResultTypeDef
2. See SearchPlaceIndexForTextSummaryTypeDef
3. See ResponseMetadataTypeDef