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,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

BatchDeleteGeofenceRequestRequestTypeDef#

# BatchDeleteGeofenceRequestRequestTypeDef definition

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

BatchGetDevicePositionRequestRequestTypeDef#

# BatchGetDevicePositionRequestRequestTypeDef definition

class BatchGetDevicePositionRequestRequestTypeDef(TypedDict):
    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,
    CustomLayers: NotRequired[Sequence[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],
    KmsKeyEnableGeospatialQueries: NotRequired[bool],
    KmsKeyId: NotRequired[str],
    PositionFiltering: NotRequired[PositionFilteringType],