| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Location.Types
Contents
- Service Configuration
- Errors
- BatchItemErrorCode
- DimensionUnit
- DistanceUnit
- IntendedUse
- PositionFiltering
- PricingPlan
- RouteMatrixErrorCode
- TravelMode
- VehicleWeightUnit
- BatchDeleteDevicePositionHistoryError
- BatchDeleteGeofenceError
- BatchEvaluateGeofencesError
- BatchGetDevicePositionError
- BatchItemError
- BatchPutGeofenceError
- BatchPutGeofenceRequestEntry
- BatchPutGeofenceSuccess
- BatchUpdateDevicePositionError
- CalculateRouteCarModeOptions
- CalculateRouteMatrixSummary
- CalculateRouteSummary
- CalculateRouteTruckModeOptions
- Circle
- DataSourceConfiguration
- DevicePosition
- DevicePositionUpdate
- GeofenceGeometry
- Leg
- LegGeometry
- ListDevicePositionsResponseEntry
- ListGeofenceCollectionsResponseEntry
- ListGeofenceResponseEntry
- ListMapsResponseEntry
- ListPlaceIndexesResponseEntry
- ListRouteCalculatorsResponseEntry
- ListTrackersResponseEntry
- MapConfiguration
- Place
- PlaceGeometry
- PositionalAccuracy
- RouteMatrixEntry
- RouteMatrixEntryError
- SearchForPositionResult
- SearchForSuggestionsResult
- SearchForTextResult
- SearchPlaceIndexForPositionSummary
- SearchPlaceIndexForSuggestionsSummary
- SearchPlaceIndexForTextSummary
- Step
- TimeZone
- TruckDimensions
- TruckWeight
Description
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- newtype BatchItemErrorCode where
- BatchItemErrorCode' { }
- pattern BatchItemErrorCode_AccessDeniedError :: BatchItemErrorCode
- pattern BatchItemErrorCode_ConflictError :: BatchItemErrorCode
- pattern BatchItemErrorCode_InternalServerError :: BatchItemErrorCode
- pattern BatchItemErrorCode_ResourceNotFoundError :: BatchItemErrorCode
- pattern BatchItemErrorCode_ThrottlingError :: BatchItemErrorCode
- pattern BatchItemErrorCode_ValidationError :: BatchItemErrorCode
- newtype DimensionUnit where
- DimensionUnit' { }
- pattern DimensionUnit_Feet :: DimensionUnit
- pattern DimensionUnit_Meters :: DimensionUnit
- newtype DistanceUnit where
- DistanceUnit' { }
- pattern DistanceUnit_Kilometers :: DistanceUnit
- pattern DistanceUnit_Miles :: DistanceUnit
- newtype IntendedUse where
- IntendedUse' { }
- pattern IntendedUse_SingleUse :: IntendedUse
- pattern IntendedUse_Storage :: IntendedUse
- newtype PositionFiltering where
- newtype PricingPlan where
- PricingPlan' { }
- pattern PricingPlan_MobileAssetManagement :: PricingPlan
- pattern PricingPlan_MobileAssetTracking :: PricingPlan
- pattern PricingPlan_RequestBasedUsage :: PricingPlan
- newtype RouteMatrixErrorCode where
- RouteMatrixErrorCode' { }
- pattern RouteMatrixErrorCode_DeparturePositionNotFound :: RouteMatrixErrorCode
- pattern RouteMatrixErrorCode_DestinationPositionNotFound :: RouteMatrixErrorCode
- pattern RouteMatrixErrorCode_OtherValidationError :: RouteMatrixErrorCode
- pattern RouteMatrixErrorCode_PositionsNotFound :: RouteMatrixErrorCode
- pattern RouteMatrixErrorCode_RouteNotFound :: RouteMatrixErrorCode
- pattern RouteMatrixErrorCode_RouteTooLong :: RouteMatrixErrorCode
- newtype TravelMode where
- TravelMode' { }
- pattern TravelMode_Car :: TravelMode
- pattern TravelMode_Truck :: TravelMode
- pattern TravelMode_Walking :: TravelMode
- newtype VehicleWeightUnit where
- VehicleWeightUnit' { }
- pattern VehicleWeightUnit_Kilograms :: VehicleWeightUnit
- pattern VehicleWeightUnit_Pounds :: VehicleWeightUnit
- data BatchDeleteDevicePositionHistoryError = BatchDeleteDevicePositionHistoryError' {
- deviceId :: Text
- error :: BatchItemError
- newBatchDeleteDevicePositionHistoryError :: Text -> BatchItemError -> BatchDeleteDevicePositionHistoryError
- batchDeleteDevicePositionHistoryError_deviceId :: Lens' BatchDeleteDevicePositionHistoryError Text
- batchDeleteDevicePositionHistoryError_error :: Lens' BatchDeleteDevicePositionHistoryError BatchItemError
- data BatchDeleteGeofenceError = BatchDeleteGeofenceError' {}
- newBatchDeleteGeofenceError :: BatchItemError -> Text -> BatchDeleteGeofenceError
- batchDeleteGeofenceError_error :: Lens' BatchDeleteGeofenceError BatchItemError
- batchDeleteGeofenceError_geofenceId :: Lens' BatchDeleteGeofenceError Text
- data BatchEvaluateGeofencesError = BatchEvaluateGeofencesError' {
- deviceId :: Text
- error :: BatchItemError
- sampleTime :: ISO8601
- newBatchEvaluateGeofencesError :: Text -> BatchItemError -> UTCTime -> BatchEvaluateGeofencesError
- batchEvaluateGeofencesError_deviceId :: Lens' BatchEvaluateGeofencesError Text
- batchEvaluateGeofencesError_error :: Lens' BatchEvaluateGeofencesError BatchItemError
- batchEvaluateGeofencesError_sampleTime :: Lens' BatchEvaluateGeofencesError UTCTime
- data BatchGetDevicePositionError = BatchGetDevicePositionError' {
- deviceId :: Text
- error :: BatchItemError
- newBatchGetDevicePositionError :: Text -> BatchItemError -> BatchGetDevicePositionError
- batchGetDevicePositionError_deviceId :: Lens' BatchGetDevicePositionError Text
- batchGetDevicePositionError_error :: Lens' BatchGetDevicePositionError BatchItemError
- data BatchItemError = BatchItemError' {}
- newBatchItemError :: BatchItemError
- batchItemError_code :: Lens' BatchItemError (Maybe BatchItemErrorCode)
- batchItemError_message :: Lens' BatchItemError (Maybe Text)
- data BatchPutGeofenceError = BatchPutGeofenceError' {}
- newBatchPutGeofenceError :: BatchItemError -> Text -> BatchPutGeofenceError
- batchPutGeofenceError_error :: Lens' BatchPutGeofenceError BatchItemError
- batchPutGeofenceError_geofenceId :: Lens' BatchPutGeofenceError Text
- data BatchPutGeofenceRequestEntry = BatchPutGeofenceRequestEntry' {}
- newBatchPutGeofenceRequestEntry :: Text -> GeofenceGeometry -> BatchPutGeofenceRequestEntry
- batchPutGeofenceRequestEntry_geofenceId :: Lens' BatchPutGeofenceRequestEntry Text
- batchPutGeofenceRequestEntry_geometry :: Lens' BatchPutGeofenceRequestEntry GeofenceGeometry
- data BatchPutGeofenceSuccess = BatchPutGeofenceSuccess' {
- createTime :: ISO8601
- geofenceId :: Text
- updateTime :: ISO8601
- newBatchPutGeofenceSuccess :: UTCTime -> Text -> UTCTime -> BatchPutGeofenceSuccess
- batchPutGeofenceSuccess_createTime :: Lens' BatchPutGeofenceSuccess UTCTime
- batchPutGeofenceSuccess_geofenceId :: Lens' BatchPutGeofenceSuccess Text
- batchPutGeofenceSuccess_updateTime :: Lens' BatchPutGeofenceSuccess UTCTime
- data BatchUpdateDevicePositionError = BatchUpdateDevicePositionError' {
- deviceId :: Text
- error :: BatchItemError
- sampleTime :: ISO8601
- newBatchUpdateDevicePositionError :: Text -> BatchItemError -> UTCTime -> BatchUpdateDevicePositionError
- batchUpdateDevicePositionError_deviceId :: Lens' BatchUpdateDevicePositionError Text
- batchUpdateDevicePositionError_error :: Lens' BatchUpdateDevicePositionError BatchItemError
- batchUpdateDevicePositionError_sampleTime :: Lens' BatchUpdateDevicePositionError UTCTime
- data CalculateRouteCarModeOptions = CalculateRouteCarModeOptions' {
- avoidFerries :: Maybe Bool
- avoidTolls :: Maybe Bool
- newCalculateRouteCarModeOptions :: CalculateRouteCarModeOptions
- calculateRouteCarModeOptions_avoidFerries :: Lens' CalculateRouteCarModeOptions (Maybe Bool)
- calculateRouteCarModeOptions_avoidTolls :: Lens' CalculateRouteCarModeOptions (Maybe Bool)
- data CalculateRouteMatrixSummary = CalculateRouteMatrixSummary' {}
- newCalculateRouteMatrixSummary :: Text -> DistanceUnit -> Natural -> Natural -> CalculateRouteMatrixSummary
- calculateRouteMatrixSummary_dataSource :: Lens' CalculateRouteMatrixSummary Text
- calculateRouteMatrixSummary_distanceUnit :: Lens' CalculateRouteMatrixSummary DistanceUnit
- calculateRouteMatrixSummary_errorCount :: Lens' CalculateRouteMatrixSummary Natural
- calculateRouteMatrixSummary_routeCount :: Lens' CalculateRouteMatrixSummary Natural
- data CalculateRouteSummary = CalculateRouteSummary' {}
- newCalculateRouteSummary :: Text -> Double -> DistanceUnit -> Double -> NonEmpty Double -> CalculateRouteSummary
- calculateRouteSummary_dataSource :: Lens' CalculateRouteSummary Text
- calculateRouteSummary_distance :: Lens' CalculateRouteSummary Double
- calculateRouteSummary_distanceUnit :: Lens' CalculateRouteSummary DistanceUnit
- calculateRouteSummary_durationSeconds :: Lens' CalculateRouteSummary Double
- calculateRouteSummary_routeBBox :: Lens' CalculateRouteSummary (NonEmpty Double)
- data CalculateRouteTruckModeOptions = CalculateRouteTruckModeOptions' {}
- newCalculateRouteTruckModeOptions :: CalculateRouteTruckModeOptions
- calculateRouteTruckModeOptions_avoidFerries :: Lens' CalculateRouteTruckModeOptions (Maybe Bool)
- calculateRouteTruckModeOptions_avoidTolls :: Lens' CalculateRouteTruckModeOptions (Maybe Bool)
- calculateRouteTruckModeOptions_dimensions :: Lens' CalculateRouteTruckModeOptions (Maybe TruckDimensions)
- calculateRouteTruckModeOptions_weight :: Lens' CalculateRouteTruckModeOptions (Maybe TruckWeight)
- data Circle = Circle' {}
- newCircle :: NonEmpty Double -> Double -> Circle
- circle_center :: Lens' Circle (NonEmpty Double)
- circle_radius :: Lens' Circle Double
- data DataSourceConfiguration = DataSourceConfiguration' {}
- newDataSourceConfiguration :: DataSourceConfiguration
- dataSourceConfiguration_intendedUse :: Lens' DataSourceConfiguration (Maybe IntendedUse)
- data DevicePosition = DevicePosition' {}
- newDevicePosition :: NonEmpty Double -> UTCTime -> UTCTime -> DevicePosition
- devicePosition_accuracy :: Lens' DevicePosition (Maybe PositionalAccuracy)
- devicePosition_deviceId :: Lens' DevicePosition (Maybe Text)
- devicePosition_positionProperties :: Lens' DevicePosition (Maybe (HashMap Text Text))
- devicePosition_position :: Lens' DevicePosition (NonEmpty Double)
- devicePosition_receivedTime :: Lens' DevicePosition UTCTime
- devicePosition_sampleTime :: Lens' DevicePosition UTCTime
- data DevicePositionUpdate = DevicePositionUpdate' {}
- newDevicePositionUpdate :: Text -> NonEmpty Double -> UTCTime -> DevicePositionUpdate
- devicePositionUpdate_accuracy :: Lens' DevicePositionUpdate (Maybe PositionalAccuracy)
- devicePositionUpdate_positionProperties :: Lens' DevicePositionUpdate (Maybe (HashMap Text Text))
- devicePositionUpdate_deviceId :: Lens' DevicePositionUpdate Text
- devicePositionUpdate_position :: Lens' DevicePositionUpdate (NonEmpty Double)
- devicePositionUpdate_sampleTime :: Lens' DevicePositionUpdate UTCTime
- data GeofenceGeometry = GeofenceGeometry' {}
- newGeofenceGeometry :: GeofenceGeometry
- geofenceGeometry_circle :: Lens' GeofenceGeometry (Maybe Circle)
- geofenceGeometry_polygon :: Lens' GeofenceGeometry (Maybe (NonEmpty (NonEmpty (NonEmpty Double))))
- data Leg = Leg' {
- geometry :: Maybe LegGeometry
- distance :: Double
- durationSeconds :: Double
- endPosition :: Sensitive (NonEmpty Double)
- startPosition :: Sensitive (NonEmpty Double)
- steps :: [Step]
- newLeg :: Double -> Double -> NonEmpty Double -> NonEmpty Double -> Leg
- leg_geometry :: Lens' Leg (Maybe LegGeometry)
- leg_distance :: Lens' Leg Double
- leg_durationSeconds :: Lens' Leg Double
- leg_endPosition :: Lens' Leg (NonEmpty Double)
- leg_startPosition :: Lens' Leg (NonEmpty Double)
- leg_steps :: Lens' Leg [Step]
- data LegGeometry = LegGeometry' {}
- newLegGeometry :: LegGeometry
- legGeometry_lineString :: Lens' LegGeometry (Maybe (NonEmpty (NonEmpty Double)))
- data ListDevicePositionsResponseEntry = ListDevicePositionsResponseEntry' {}
- newListDevicePositionsResponseEntry :: Text -> NonEmpty Double -> UTCTime -> ListDevicePositionsResponseEntry
- listDevicePositionsResponseEntry_accuracy :: Lens' ListDevicePositionsResponseEntry (Maybe PositionalAccuracy)
- listDevicePositionsResponseEntry_positionProperties :: Lens' ListDevicePositionsResponseEntry (Maybe (HashMap Text Text))
- listDevicePositionsResponseEntry_deviceId :: Lens' ListDevicePositionsResponseEntry Text
- listDevicePositionsResponseEntry_position :: Lens' ListDevicePositionsResponseEntry (NonEmpty Double)
- listDevicePositionsResponseEntry_sampleTime :: Lens' ListDevicePositionsResponseEntry UTCTime
- data ListGeofenceCollectionsResponseEntry = ListGeofenceCollectionsResponseEntry' {}
- newListGeofenceCollectionsResponseEntry :: Text -> UTCTime -> Text -> UTCTime -> ListGeofenceCollectionsResponseEntry
- listGeofenceCollectionsResponseEntry_pricingPlan :: Lens' ListGeofenceCollectionsResponseEntry (Maybe PricingPlan)
- listGeofenceCollectionsResponseEntry_pricingPlanDataSource :: Lens' ListGeofenceCollectionsResponseEntry (Maybe Text)
- listGeofenceCollectionsResponseEntry_collectionName :: Lens' ListGeofenceCollectionsResponseEntry Text
- listGeofenceCollectionsResponseEntry_createTime :: Lens' ListGeofenceCollectionsResponseEntry UTCTime
- listGeofenceCollectionsResponseEntry_description :: Lens' ListGeofenceCollectionsResponseEntry Text
- listGeofenceCollectionsResponseEntry_updateTime :: Lens' ListGeofenceCollectionsResponseEntry UTCTime
- data ListGeofenceResponseEntry = ListGeofenceResponseEntry' {}
- newListGeofenceResponseEntry :: UTCTime -> Text -> GeofenceGeometry -> Text -> UTCTime -> ListGeofenceResponseEntry
- listGeofenceResponseEntry_createTime :: Lens' ListGeofenceResponseEntry UTCTime
- listGeofenceResponseEntry_geofenceId :: Lens' ListGeofenceResponseEntry Text
- listGeofenceResponseEntry_geometry :: Lens' ListGeofenceResponseEntry GeofenceGeometry
- listGeofenceResponseEntry_status :: Lens' ListGeofenceResponseEntry Text
- listGeofenceResponseEntry_updateTime :: Lens' ListGeofenceResponseEntry UTCTime
- data ListMapsResponseEntry = ListMapsResponseEntry' {}
- newListMapsResponseEntry :: UTCTime -> Text -> Text -> Text -> UTCTime -> ListMapsResponseEntry
- listMapsResponseEntry_pricingPlan :: Lens' ListMapsResponseEntry (Maybe PricingPlan)
- listMapsResponseEntry_createTime :: Lens' ListMapsResponseEntry UTCTime
- listMapsResponseEntry_dataSource :: Lens' ListMapsResponseEntry Text
- listMapsResponseEntry_description :: Lens' ListMapsResponseEntry Text
- listMapsResponseEntry_mapName :: Lens' ListMapsResponseEntry Text
- listMapsResponseEntry_updateTime :: Lens' ListMapsResponseEntry UTCTime
- data ListPlaceIndexesResponseEntry = ListPlaceIndexesResponseEntry' {}
- newListPlaceIndexesResponseEntry :: UTCTime -> Text -> Text -> Text -> UTCTime -> ListPlaceIndexesResponseEntry
- listPlaceIndexesResponseEntry_pricingPlan :: Lens' ListPlaceIndexesResponseEntry (Maybe PricingPlan)
- listPlaceIndexesResponseEntry_createTime :: Lens' ListPlaceIndexesResponseEntry UTCTime
- listPlaceIndexesResponseEntry_dataSource :: Lens' ListPlaceIndexesResponseEntry Text
- listPlaceIndexesResponseEntry_description :: Lens' ListPlaceIndexesResponseEntry Text
- listPlaceIndexesResponseEntry_indexName :: Lens' ListPlaceIndexesResponseEntry Text
- listPlaceIndexesResponseEntry_updateTime :: Lens' ListPlaceIndexesResponseEntry UTCTime
- data ListRouteCalculatorsResponseEntry = ListRouteCalculatorsResponseEntry' {}
- newListRouteCalculatorsResponseEntry :: Text -> UTCTime -> Text -> Text -> UTCTime -> ListRouteCalculatorsResponseEntry
- listRouteCalculatorsResponseEntry_pricingPlan :: Lens' ListRouteCalculatorsResponseEntry (Maybe PricingPlan)
- listRouteCalculatorsResponseEntry_calculatorName :: Lens' ListRouteCalculatorsResponseEntry Text
- listRouteCalculatorsResponseEntry_createTime :: Lens' ListRouteCalculatorsResponseEntry UTCTime
- listRouteCalculatorsResponseEntry_dataSource :: Lens' ListRouteCalculatorsResponseEntry Text
- listRouteCalculatorsResponseEntry_description :: Lens' ListRouteCalculatorsResponseEntry Text
- listRouteCalculatorsResponseEntry_updateTime :: Lens' ListRouteCalculatorsResponseEntry UTCTime
- data ListTrackersResponseEntry = ListTrackersResponseEntry' {}
- newListTrackersResponseEntry :: UTCTime -> Text -> Text -> UTCTime -> ListTrackersResponseEntry
- listTrackersResponseEntry_pricingPlan :: Lens' ListTrackersResponseEntry (Maybe PricingPlan)
- listTrackersResponseEntry_pricingPlanDataSource :: Lens' ListTrackersResponseEntry (Maybe Text)
- listTrackersResponseEntry_createTime :: Lens' ListTrackersResponseEntry UTCTime
- listTrackersResponseEntry_description :: Lens' ListTrackersResponseEntry Text
- listTrackersResponseEntry_trackerName :: Lens' ListTrackersResponseEntry Text
- listTrackersResponseEntry_updateTime :: Lens' ListTrackersResponseEntry UTCTime
- data MapConfiguration = MapConfiguration' {}
- newMapConfiguration :: Text -> MapConfiguration
- mapConfiguration_style :: Lens' MapConfiguration Text
- data Place = Place' {
- addressNumber :: Maybe Text
- country :: Maybe Text
- interpolated :: Maybe Bool
- label :: Maybe Text
- municipality :: Maybe Text
- neighborhood :: Maybe Text
- postalCode :: Maybe Text
- region :: Maybe Text
- street :: Maybe Text
- subRegion :: Maybe Text
- timeZone :: Maybe TimeZone
- unitNumber :: Maybe Text
- unitType :: Maybe Text
- geometry :: PlaceGeometry
- newPlace :: PlaceGeometry -> Place
- place_addressNumber :: Lens' Place (Maybe Text)
- place_country :: Lens' Place (Maybe Text)
- place_interpolated :: Lens' Place (Maybe Bool)
- place_label :: Lens' Place (Maybe Text)
- place_municipality :: Lens' Place (Maybe Text)
- place_neighborhood :: Lens' Place (Maybe Text)
- place_postalCode :: Lens' Place (Maybe Text)
- place_region :: Lens' Place (Maybe Text)
- place_street :: Lens' Place (Maybe Text)
- place_subRegion :: Lens' Place (Maybe Text)
- place_timeZone :: Lens' Place (Maybe TimeZone)
- place_unitNumber :: Lens' Place (Maybe Text)
- place_unitType :: Lens' Place (Maybe Text)
- place_geometry :: Lens' Place PlaceGeometry
- data PlaceGeometry = PlaceGeometry' {}
- newPlaceGeometry :: PlaceGeometry
- placeGeometry_point :: Lens' PlaceGeometry (Maybe (NonEmpty Double))
- data PositionalAccuracy = PositionalAccuracy' {
- horizontal :: Double
- newPositionalAccuracy :: Double -> PositionalAccuracy
- positionalAccuracy_horizontal :: Lens' PositionalAccuracy Double
- data RouteMatrixEntry = RouteMatrixEntry' {}
- newRouteMatrixEntry :: RouteMatrixEntry
- routeMatrixEntry_distance :: Lens' RouteMatrixEntry (Maybe Double)
- routeMatrixEntry_durationSeconds :: Lens' RouteMatrixEntry (Maybe Double)
- routeMatrixEntry_error :: Lens' RouteMatrixEntry (Maybe RouteMatrixEntryError)
- data RouteMatrixEntryError = RouteMatrixEntryError' {}
- newRouteMatrixEntryError :: RouteMatrixErrorCode -> RouteMatrixEntryError
- routeMatrixEntryError_message :: Lens' RouteMatrixEntryError (Maybe Text)
- routeMatrixEntryError_code :: Lens' RouteMatrixEntryError RouteMatrixErrorCode
- data SearchForPositionResult = SearchForPositionResult' {}
- newSearchForPositionResult :: Double -> Place -> SearchForPositionResult
- searchForPositionResult_placeId :: Lens' SearchForPositionResult (Maybe Text)
- searchForPositionResult_distance :: Lens' SearchForPositionResult Double
- searchForPositionResult_place :: Lens' SearchForPositionResult Place
- data SearchForSuggestionsResult = SearchForSuggestionsResult' {}
- newSearchForSuggestionsResult :: Text -> SearchForSuggestionsResult
- searchForSuggestionsResult_placeId :: Lens' SearchForSuggestionsResult (Maybe Text)
- searchForSuggestionsResult_text :: Lens' SearchForSuggestionsResult Text
- data SearchForTextResult = SearchForTextResult' {}
- newSearchForTextResult :: Place -> SearchForTextResult
- searchForTextResult_distance :: Lens' SearchForTextResult (Maybe Double)
- searchForTextResult_placeId :: Lens' SearchForTextResult (Maybe Text)
- searchForTextResult_relevance :: Lens' SearchForTextResult (Maybe Double)
- searchForTextResult_place :: Lens' SearchForTextResult Place
- data SearchPlaceIndexForPositionSummary = SearchPlaceIndexForPositionSummary' {}
- newSearchPlaceIndexForPositionSummary :: Text -> NonEmpty Double -> SearchPlaceIndexForPositionSummary
- searchPlaceIndexForPositionSummary_language :: Lens' SearchPlaceIndexForPositionSummary (Maybe Text)
- searchPlaceIndexForPositionSummary_maxResults :: Lens' SearchPlaceIndexForPositionSummary (Maybe Natural)
- searchPlaceIndexForPositionSummary_dataSource :: Lens' SearchPlaceIndexForPositionSummary Text
- searchPlaceIndexForPositionSummary_position :: Lens' SearchPlaceIndexForPositionSummary (NonEmpty Double)
- data SearchPlaceIndexForSuggestionsSummary = SearchPlaceIndexForSuggestionsSummary' {
- biasPosition :: Maybe (Sensitive (NonEmpty Double))
- filterBBox :: Maybe (Sensitive (NonEmpty Double))
- filterCountries :: Maybe (NonEmpty Text)
- language :: Maybe Text
- maxResults :: Maybe Int
- dataSource :: Text
- text :: Sensitive Text
- newSearchPlaceIndexForSuggestionsSummary :: Text -> Text -> SearchPlaceIndexForSuggestionsSummary
- searchPlaceIndexForSuggestionsSummary_biasPosition :: Lens' SearchPlaceIndexForSuggestionsSummary (Maybe (NonEmpty Double))
- searchPlaceIndexForSuggestionsSummary_filterBBox :: Lens' SearchPlaceIndexForSuggestionsSummary (Maybe (NonEmpty Double))
- searchPlaceIndexForSuggestionsSummary_filterCountries :: Lens' SearchPlaceIndexForSuggestionsSummary (Maybe (NonEmpty Text))
- searchPlaceIndexForSuggestionsSummary_language :: Lens' SearchPlaceIndexForSuggestionsSummary (Maybe Text)
- searchPlaceIndexForSuggestionsSummary_maxResults :: Lens' SearchPlaceIndexForSuggestionsSummary (Maybe Int)
- searchPlaceIndexForSuggestionsSummary_dataSource :: Lens' SearchPlaceIndexForSuggestionsSummary Text
- searchPlaceIndexForSuggestionsSummary_text :: Lens' SearchPlaceIndexForSuggestionsSummary Text
- data SearchPlaceIndexForTextSummary = SearchPlaceIndexForTextSummary' {
- biasPosition :: Maybe (Sensitive (NonEmpty Double))
- filterBBox :: Maybe (Sensitive (NonEmpty Double))
- filterCountries :: Maybe (NonEmpty Text)
- language :: Maybe Text
- maxResults :: Maybe Natural
- resultBBox :: Maybe (Sensitive (NonEmpty Double))
- dataSource :: Text
- text :: Sensitive Text
- newSearchPlaceIndexForTextSummary :: Text -> Text -> SearchPlaceIndexForTextSummary
- searchPlaceIndexForTextSummary_biasPosition :: Lens' SearchPlaceIndexForTextSummary (Maybe (NonEmpty Double))
- searchPlaceIndexForTextSummary_filterBBox :: Lens' SearchPlaceIndexForTextSummary (Maybe (NonEmpty Double))
- searchPlaceIndexForTextSummary_filterCountries :: Lens' SearchPlaceIndexForTextSummary (Maybe (NonEmpty Text))
- searchPlaceIndexForTextSummary_language :: Lens' SearchPlaceIndexForTextSummary (Maybe Text)
- searchPlaceIndexForTextSummary_maxResults :: Lens' SearchPlaceIndexForTextSummary (Maybe Natural)
- searchPlaceIndexForTextSummary_resultBBox :: Lens' SearchPlaceIndexForTextSummary (Maybe (NonEmpty Double))
- searchPlaceIndexForTextSummary_dataSource :: Lens' SearchPlaceIndexForTextSummary Text
- searchPlaceIndexForTextSummary_text :: Lens' SearchPlaceIndexForTextSummary Text
- data Step = Step' {}
- newStep :: Double -> Double -> NonEmpty Double -> NonEmpty Double -> Step
- step_geometryOffset :: Lens' Step (Maybe Natural)
- step_distance :: Lens' Step Double
- step_durationSeconds :: Lens' Step Double
- step_endPosition :: Lens' Step (NonEmpty Double)
- step_startPosition :: Lens' Step (NonEmpty Double)
- data TimeZone = TimeZone' {}
- newTimeZone :: Text -> TimeZone
- timeZone_offset :: Lens' TimeZone (Maybe Int)
- timeZone_name :: Lens' TimeZone Text
- data TruckDimensions = TruckDimensions' {}
- newTruckDimensions :: TruckDimensions
- truckDimensions_height :: Lens' TruckDimensions (Maybe Double)
- truckDimensions_length :: Lens' TruckDimensions (Maybe Double)
- truckDimensions_unit :: Lens' TruckDimensions (Maybe DimensionUnit)
- truckDimensions_width :: Lens' TruckDimensions (Maybe Double)
- data TruckWeight = TruckWeight' {}
- newTruckWeight :: TruckWeight
- truckWeight_total :: Lens' TruckWeight (Maybe Double)
- truckWeight_unit :: Lens' TruckWeight (Maybe VehicleWeightUnit)
Service Configuration
defaultService :: Service Source #
API version 2020-11-19 of the Amazon Location Service SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
_ConflictException :: AsError a => Fold a ServiceError Source #
The request was unsuccessful because of a conflict.
_InternalServerException :: AsError a => Fold a ServiceError Source #
The request has failed to process because of an unknown server error, exception, or failure.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The resource that you've entered was not found in your AWS account.
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
The operation was denied because the request would exceed the maximum quota set for Amazon Location Service.
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request was denied because of request throttling.
_ValidationException :: AsError a => Fold a ServiceError Source #
The input failed to meet the constraints specified by the AWS service.
BatchItemErrorCode
newtype BatchItemErrorCode Source #
Constructors
| BatchItemErrorCode' | |
Fields | |
Bundled Patterns
Instances
DimensionUnit
newtype DimensionUnit Source #
Constructors
| DimensionUnit' | |
Fields | |
Bundled Patterns
| pattern DimensionUnit_Feet :: DimensionUnit | |
| pattern DimensionUnit_Meters :: DimensionUnit |
Instances
DistanceUnit
newtype DistanceUnit Source #
Constructors
| DistanceUnit' | |
Fields | |
Bundled Patterns
| pattern DistanceUnit_Kilometers :: DistanceUnit | |
| pattern DistanceUnit_Miles :: DistanceUnit |
Instances
IntendedUse
newtype IntendedUse Source #
Constructors
| IntendedUse' | |
Fields | |
Bundled Patterns
| pattern IntendedUse_SingleUse :: IntendedUse | |
| pattern IntendedUse_Storage :: IntendedUse |
Instances
PositionFiltering
newtype PositionFiltering Source #
Constructors
| PositionFiltering' | |
Fields | |
Bundled Patterns
| pattern PositionFiltering_AccuracyBased :: PositionFiltering | |
| pattern PositionFiltering_DistanceBased :: PositionFiltering | |
| pattern PositionFiltering_TimeBased :: PositionFiltering |
Instances
PricingPlan
newtype PricingPlan Source #
Constructors
| PricingPlan' | |
Fields | |
Bundled Patterns
| pattern PricingPlan_MobileAssetManagement :: PricingPlan | |
| pattern PricingPlan_MobileAssetTracking :: PricingPlan | |
| pattern PricingPlan_RequestBasedUsage :: PricingPlan |
Instances
RouteMatrixErrorCode
newtype RouteMatrixErrorCode Source #
Constructors
| RouteMatrixErrorCode' | |
Fields | |
Bundled Patterns
Instances
TravelMode
newtype TravelMode Source #
Constructors
| TravelMode' | |
Fields | |
Bundled Patterns
| pattern TravelMode_Car :: TravelMode | |
| pattern TravelMode_Truck :: TravelMode | |
| pattern TravelMode_Walking :: TravelMode |
Instances
VehicleWeightUnit
newtype VehicleWeightUnit Source #
Constructors
| VehicleWeightUnit' | |
Fields | |
Bundled Patterns
| pattern VehicleWeightUnit_Kilograms :: VehicleWeightUnit | |
| pattern VehicleWeightUnit_Pounds :: VehicleWeightUnit |
Instances
BatchDeleteDevicePositionHistoryError
data BatchDeleteDevicePositionHistoryError Source #
Contains the tracker resource details.
See: newBatchDeleteDevicePositionHistoryError smart constructor.
Constructors
| BatchDeleteDevicePositionHistoryError' | |
Fields
| |
Instances
newBatchDeleteDevicePositionHistoryError Source #
Arguments
| :: Text | |
| -> BatchItemError | |
| -> BatchDeleteDevicePositionHistoryError |
Create a value of BatchDeleteDevicePositionHistoryError with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deviceId:BatchDeleteDevicePositionHistoryError', batchDeleteDevicePositionHistoryError_deviceId - The ID of the device for this position.
$sel:error:BatchDeleteDevicePositionHistoryError', batchDeleteDevicePositionHistoryError_error - Undocumented member.
batchDeleteDevicePositionHistoryError_deviceId :: Lens' BatchDeleteDevicePositionHistoryError Text Source #
The ID of the device for this position.
batchDeleteDevicePositionHistoryError_error :: Lens' BatchDeleteDevicePositionHistoryError BatchItemError Source #
Undocumented member.
BatchDeleteGeofenceError
data BatchDeleteGeofenceError Source #
Contains error details for each geofence that failed to delete from the geofence collection.
See: newBatchDeleteGeofenceError smart constructor.
Constructors
| BatchDeleteGeofenceError' | |
Fields
| |
Instances
newBatchDeleteGeofenceError Source #
Arguments
| :: BatchItemError | |
| -> Text | |
| -> BatchDeleteGeofenceError |
Create a value of BatchDeleteGeofenceError with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:error:BatchDeleteGeofenceError', batchDeleteGeofenceError_error - Contains details associated to the batch error.
$sel:geofenceId:BatchDeleteGeofenceError', batchDeleteGeofenceError_geofenceId - The geofence associated with the error message.
batchDeleteGeofenceError_error :: Lens' BatchDeleteGeofenceError BatchItemError Source #
Contains details associated to the batch error.
batchDeleteGeofenceError_geofenceId :: Lens' BatchDeleteGeofenceError Text Source #
The geofence associated with the error message.
BatchEvaluateGeofencesError
data BatchEvaluateGeofencesError Source #
Contains error details for each device that failed to evaluate its position against the geofences in a given geofence collection.
See: newBatchEvaluateGeofencesError smart constructor.
Constructors
| BatchEvaluateGeofencesError' | |
Fields
| |
Instances
newBatchEvaluateGeofencesError Source #
Arguments
| :: Text | |
| -> BatchItemError | |
| -> UTCTime | |
| -> BatchEvaluateGeofencesError |
Create a value of BatchEvaluateGeofencesError with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deviceId:BatchEvaluateGeofencesError', batchEvaluateGeofencesError_deviceId - The device associated with the position evaluation error.
$sel:error:BatchEvaluateGeofencesError', batchEvaluateGeofencesError_error - Contains details associated to the batch error.
$sel:sampleTime:BatchEvaluateGeofencesError', batchEvaluateGeofencesError_sampleTime - Specifies a timestamp for when the error occurred in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
batchEvaluateGeofencesError_deviceId :: Lens' BatchEvaluateGeofencesError Text Source #
The device associated with the position evaluation error.
batchEvaluateGeofencesError_error :: Lens' BatchEvaluateGeofencesError BatchItemError Source #
Contains details associated to the batch error.
batchEvaluateGeofencesError_sampleTime :: Lens' BatchEvaluateGeofencesError UTCTime Source #
Specifies a timestamp for when the error occurred in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
BatchGetDevicePositionError
data BatchGetDevicePositionError Source #
Contains error details for each device that didn't return a position.
See: newBatchGetDevicePositionError smart constructor.
Constructors
| BatchGetDevicePositionError' | |
Fields
| |
Instances
newBatchGetDevicePositionError Source #
Arguments
| :: Text | |
| -> BatchItemError | |
| -> BatchGetDevicePositionError |
Create a value of BatchGetDevicePositionError with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deviceId:BatchGetDevicePositionError', batchGetDevicePositionError_deviceId - The ID of the device that didn't return a position.
$sel:error:BatchGetDevicePositionError', batchGetDevicePositionError_error - Contains details related to the error code.
batchGetDevicePositionError_deviceId :: Lens' BatchGetDevicePositionError Text Source #
The ID of the device that didn't return a position.
batchGetDevicePositionError_error :: Lens' BatchGetDevicePositionError BatchItemError Source #
Contains details related to the error code.
BatchItemError
data BatchItemError Source #
Contains the batch request error details associated with the request.
See: newBatchItemError smart constructor.
Constructors
| BatchItemError' | |
Instances
newBatchItemError :: BatchItemError Source #
Create a value of BatchItemError with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:code:BatchItemError', batchItemError_code - The error code associated with the batch request error.
$sel:message:BatchItemError', batchItemError_message - A message with the reason for the batch request error.
batchItemError_code :: Lens' BatchItemError (Maybe BatchItemErrorCode) Source #
The error code associated with the batch request error.
batchItemError_message :: Lens' BatchItemError (Maybe Text) Source #
A message with the reason for the batch request error.
BatchPutGeofenceError
data BatchPutGeofenceError Source #
Contains error details for each geofence that failed to be stored in a given geofence collection.
See: newBatchPutGeofenceError smart constructor.
Constructors
| BatchPutGeofenceError' | |
Fields
| |
Instances
newBatchPutGeofenceError Source #
Arguments
| :: BatchItemError | |
| -> Text | |
| -> BatchPutGeofenceError |
Create a value of BatchPutGeofenceError with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:error:BatchPutGeofenceError', batchPutGeofenceError_error - Contains details associated to the batch error.
$sel:geofenceId:BatchPutGeofenceError', batchPutGeofenceError_geofenceId - The geofence associated with the error message.
batchPutGeofenceError_error :: Lens' BatchPutGeofenceError BatchItemError Source #
Contains details associated to the batch error.
batchPutGeofenceError_geofenceId :: Lens' BatchPutGeofenceError Text Source #
The geofence associated with the error message.
BatchPutGeofenceRequestEntry
data BatchPutGeofenceRequestEntry Source #
Contains geofence geometry details.
See: newBatchPutGeofenceRequestEntry smart constructor.
Constructors
| BatchPutGeofenceRequestEntry' | |
Fields
| |
Instances
newBatchPutGeofenceRequestEntry Source #
Arguments
| :: Text | |
| -> GeofenceGeometry | |
| -> BatchPutGeofenceRequestEntry |
Create a value of BatchPutGeofenceRequestEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:geofenceId:BatchPutGeofenceRequestEntry', batchPutGeofenceRequestEntry_geofenceId - The identifier for the geofence to be stored in a given geofence
collection.
$sel:geometry:BatchPutGeofenceRequestEntry', batchPutGeofenceRequestEntry_geometry - Contains the details of the position of the geofence. Can be either a
polygon or a circle. Including both will return a validation error.
Each geofence polygon can have a maximum of 1,000 vertices.
batchPutGeofenceRequestEntry_geofenceId :: Lens' BatchPutGeofenceRequestEntry Text Source #
The identifier for the geofence to be stored in a given geofence collection.
batchPutGeofenceRequestEntry_geometry :: Lens' BatchPutGeofenceRequestEntry GeofenceGeometry Source #
Contains the details of the position of the geofence. Can be either a polygon or a circle. Including both will return a validation error.
Each geofence polygon can have a maximum of 1,000 vertices.
BatchPutGeofenceSuccess
data BatchPutGeofenceSuccess Source #
Contains a summary of each geofence that was successfully stored in a given geofence collection.
See: newBatchPutGeofenceSuccess smart constructor.
Constructors
| BatchPutGeofenceSuccess' | |
Fields
| |
Instances
newBatchPutGeofenceSuccess Source #
Arguments
| :: UTCTime | |
| -> Text | |
| -> UTCTime | |
| -> BatchPutGeofenceSuccess |
Create a value of BatchPutGeofenceSuccess with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createTime:BatchPutGeofenceSuccess', batchPutGeofenceSuccess_createTime - The timestamp for when the geofence was stored in a geofence collection
in ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
$sel:geofenceId:BatchPutGeofenceSuccess', batchPutGeofenceSuccess_geofenceId - The geofence successfully stored in a geofence collection.
$sel:updateTime:BatchPutGeofenceSuccess', batchPutGeofenceSuccess_updateTime - The timestamp for when the geofence was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
batchPutGeofenceSuccess_createTime :: Lens' BatchPutGeofenceSuccess UTCTime Source #
The timestamp for when the geofence was stored in a geofence collection
in ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
batchPutGeofenceSuccess_geofenceId :: Lens' BatchPutGeofenceSuccess Text Source #
The geofence successfully stored in a geofence collection.
batchPutGeofenceSuccess_updateTime :: Lens' BatchPutGeofenceSuccess UTCTime Source #
The timestamp for when the geofence was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
BatchUpdateDevicePositionError
data BatchUpdateDevicePositionError Source #
Contains error details for each device that failed to update its position.
See: newBatchUpdateDevicePositionError smart constructor.
Constructors
| BatchUpdateDevicePositionError' | |
Fields
| |
Instances
newBatchUpdateDevicePositionError Source #
Arguments
| :: Text | |
| -> BatchItemError | |
| -> UTCTime | |
| -> BatchUpdateDevicePositionError |
Create a value of BatchUpdateDevicePositionError with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deviceId:BatchUpdateDevicePositionError', batchUpdateDevicePositionError_deviceId - The device associated with the failed location update.
$sel:error:BatchUpdateDevicePositionError', batchUpdateDevicePositionError_error - Contains details related to the error code such as the error code and
error message.
$sel:sampleTime:BatchUpdateDevicePositionError', batchUpdateDevicePositionError_sampleTime - The timestamp at which the device position was determined. Uses
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
batchUpdateDevicePositionError_deviceId :: Lens' BatchUpdateDevicePositionError Text Source #
The device associated with the failed location update.
batchUpdateDevicePositionError_error :: Lens' BatchUpdateDevicePositionError BatchItemError Source #
Contains details related to the error code such as the error code and error message.
batchUpdateDevicePositionError_sampleTime :: Lens' BatchUpdateDevicePositionError UTCTime Source #
The timestamp at which the device position was determined. Uses
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
CalculateRouteCarModeOptions
data CalculateRouteCarModeOptions Source #
Contains details about additional route preferences for requests that
specify TravelMode as Car.
See: newCalculateRouteCarModeOptions smart constructor.
Constructors
| CalculateRouteCarModeOptions' | |
Fields
| |
Instances
newCalculateRouteCarModeOptions :: CalculateRouteCarModeOptions Source #
Create a value of CalculateRouteCarModeOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:avoidFerries:CalculateRouteCarModeOptions', calculateRouteCarModeOptions_avoidFerries - Avoids ferries when calculating routes.
Default Value: false
Valid Values: false | true
$sel:avoidTolls:CalculateRouteCarModeOptions', calculateRouteCarModeOptions_avoidTolls - Avoids tolls when calculating routes.
Default Value: false
Valid Values: false | true
calculateRouteCarModeOptions_avoidFerries :: Lens' CalculateRouteCarModeOptions (Maybe Bool) Source #
Avoids ferries when calculating routes.
Default Value: false
Valid Values: false | true
calculateRouteCarModeOptions_avoidTolls :: Lens' CalculateRouteCarModeOptions (Maybe Bool) Source #
Avoids tolls when calculating routes.
Default Value: false
Valid Values: false | true
CalculateRouteMatrixSummary
data CalculateRouteMatrixSummary Source #
A summary of the calculated route matrix.
See: newCalculateRouteMatrixSummary smart constructor.
Constructors
| CalculateRouteMatrixSummary' | |
Fields
| |
Instances
newCalculateRouteMatrixSummary Source #
Arguments
| :: Text | |
| -> DistanceUnit | |
| -> Natural | |
| -> Natural | |
| -> CalculateRouteMatrixSummary |
Create a value of CalculateRouteMatrixSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataSource:CalculateRouteMatrixSummary', calculateRouteMatrixSummary_dataSource - The data provider of traffic and road network data used to calculate the
routes. Indicates one of the available providers:
Esri
Here
For more information about data providers, see Amazon Location Service data providers.
$sel:distanceUnit:CalculateRouteMatrixSummary', calculateRouteMatrixSummary_distanceUnit - The unit of measurement for route distances.
$sel:errorCount:CalculateRouteMatrixSummary', calculateRouteMatrixSummary_errorCount - The count of error results in the route matrix. If this number is 0, all
routes were calculated successfully.
$sel:routeCount:CalculateRouteMatrixSummary', calculateRouteMatrixSummary_routeCount - The count of cells in the route matrix. Equal to the number of
DeparturePositions multiplied by the number of DestinationPositions.
calculateRouteMatrixSummary_dataSource :: Lens' CalculateRouteMatrixSummary Text Source #
The data provider of traffic and road network data used to calculate the routes. Indicates one of the available providers:
Esri
Here
For more information about data providers, see Amazon Location Service data providers.
calculateRouteMatrixSummary_distanceUnit :: Lens' CalculateRouteMatrixSummary DistanceUnit Source #
The unit of measurement for route distances.
calculateRouteMatrixSummary_errorCount :: Lens' CalculateRouteMatrixSummary Natural Source #
The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.
calculateRouteMatrixSummary_routeCount :: Lens' CalculateRouteMatrixSummary Natural Source #
The count of cells in the route matrix. Equal to the number of
DeparturePositions multiplied by the number of DestinationPositions.
CalculateRouteSummary
data CalculateRouteSummary Source #
A summary of the calculated route.
See: newCalculateRouteSummary smart constructor.
Constructors
| CalculateRouteSummary' | |
Fields
| |
Instances
newCalculateRouteSummary Source #
Arguments
| :: Text | |
| -> Double | |
| -> DistanceUnit | |
| -> Double | |
| -> NonEmpty Double | |
| -> CalculateRouteSummary |
Create a value of CalculateRouteSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataSource:CalculateRouteSummary', calculateRouteSummary_dataSource - The data provider of traffic and road network data used to calculate the
route. Indicates one of the available providers:
Esri
Here
For more information about data providers, see Amazon Location Service data providers.
$sel:distance:CalculateRouteSummary', calculateRouteSummary_distance - The total distance covered by the route. The sum of the distance
travelled between every stop on the route.
If Esri is the data source for the route calculator, the route distance
can’t be greater than 400 km. If the route exceeds 400 km, the response
is a 400 RoutesValidationException error.
$sel:distanceUnit:CalculateRouteSummary', calculateRouteSummary_distanceUnit - The unit of measurement for route distances.
$sel:durationSeconds:CalculateRouteSummary', calculateRouteSummary_durationSeconds - The total travel time for the route measured in seconds. The sum of the
travel time between every stop on the route.
$sel:routeBBox:CalculateRouteSummary', calculateRouteSummary_routeBBox - Specifies a geographical box surrounding a route. Used to zoom into a
route when displaying it in a map. For example,
[min x, min y, max x, max y].
The first 2 bbox parameters describe the lower southwest corner:
- The first
bboxposition is the X coordinate or longitude of the lower southwest corner. - The second
bboxposition is the Y coordinate or latitude of the lower southwest corner.
The next 2 bbox parameters describe the upper northeast corner:
- The third
bboxposition is the X coordinate, or longitude of the upper northeast corner. - The fourth
bboxposition is the Y coordinate, or latitude of the upper northeast corner.
calculateRouteSummary_dataSource :: Lens' CalculateRouteSummary Text Source #
The data provider of traffic and road network data used to calculate the route. Indicates one of the available providers:
Esri
Here
For more information about data providers, see Amazon Location Service data providers.
calculateRouteSummary_distance :: Lens' CalculateRouteSummary Double Source #
The total distance covered by the route. The sum of the distance travelled between every stop on the route.
If Esri is the data source for the route calculator, the route distance
can’t be greater than 400 km. If the route exceeds 400 km, the response
is a 400 RoutesValidationException error.
calculateRouteSummary_distanceUnit :: Lens' CalculateRouteSummary DistanceUnit Source #
The unit of measurement for route distances.
calculateRouteSummary_durationSeconds :: Lens' CalculateRouteSummary Double Source #
The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.
calculateRouteSummary_routeBBox :: Lens' CalculateRouteSummary (NonEmpty Double) Source #
Specifies a geographical box surrounding a route. Used to zoom into a
route when displaying it in a map. For example,
[min x, min y, max x, max y].
The first 2 bbox parameters describe the lower southwest corner:
- The first
bboxposition is the X coordinate or longitude of the lower southwest corner. - The second
bboxposition is the Y coordinate or latitude of the lower southwest corner.
The next 2 bbox parameters describe the upper northeast corner:
- The third
bboxposition is the X coordinate, or longitude of the upper northeast corner. - The fourth
bboxposition is the Y coordinate, or latitude of the upper northeast corner.
CalculateRouteTruckModeOptions
data CalculateRouteTruckModeOptions Source #
Contains details about additional route preferences for requests that
specify TravelMode as Truck.
See: newCalculateRouteTruckModeOptions smart constructor.
Constructors
| CalculateRouteTruckModeOptions' | |
Fields
| |
Instances
newCalculateRouteTruckModeOptions :: CalculateRouteTruckModeOptions Source #
Create a value of CalculateRouteTruckModeOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:avoidFerries:CalculateRouteTruckModeOptions', calculateRouteTruckModeOptions_avoidFerries - Avoids ferries when calculating routes.
Default Value: false
Valid Values: false | true
$sel:avoidTolls:CalculateRouteTruckModeOptions', calculateRouteTruckModeOptions_avoidTolls - Avoids tolls when calculating routes.
Default Value: false
Valid Values: false | true
$sel:dimensions:CalculateRouteTruckModeOptions', calculateRouteTruckModeOptions_dimensions - Specifies the truck's dimension specifications including length,
height, width, and unit of measurement. Used to avoid roads that can't
support the truck's dimensions.
$sel:weight:CalculateRouteTruckModeOptions', calculateRouteTruckModeOptions_weight - Specifies the truck's weight specifications including total weight and
unit of measurement. Used to avoid roads that can't support the
truck's weight.
calculateRouteTruckModeOptions_avoidFerries :: Lens' CalculateRouteTruckModeOptions (Maybe Bool) Source #
Avoids ferries when calculating routes.
Default Value: false
Valid Values: false | true
calculateRouteTruckModeOptions_avoidTolls :: Lens' CalculateRouteTruckModeOptions (Maybe Bool) Source #
Avoids tolls when calculating routes.
Default Value: false
Valid Values: false | true
calculateRouteTruckModeOptions_dimensions :: Lens' CalculateRouteTruckModeOptions (Maybe TruckDimensions) Source #
Specifies the truck's dimension specifications including length, height, width, and unit of measurement. Used to avoid roads that can't support the truck's dimensions.
calculateRouteTruckModeOptions_weight :: Lens' CalculateRouteTruckModeOptions (Maybe TruckWeight) Source #
Specifies the truck's weight specifications including total weight and unit of measurement. Used to avoid roads that can't support the truck's weight.
Circle
A circle on the earth, as defined by a center point and a radius.
See: newCircle smart constructor.
Constructors
| Circle' | |
Instances
| FromJSON Circle Source # | |
| ToJSON Circle Source # | |
Defined in Amazonka.Location.Types.Circle | |
| Generic Circle Source # | |
| Show Circle Source # | |
| NFData Circle Source # | |
Defined in Amazonka.Location.Types.Circle | |
| Eq Circle Source # | |
| Hashable Circle Source # | |
Defined in Amazonka.Location.Types.Circle | |
| type Rep Circle Source # | |
Defined in Amazonka.Location.Types.Circle type Rep Circle = D1 ('MetaData "Circle" "Amazonka.Location.Types.Circle" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "Circle'" 'PrefixI 'True) (S1 ('MetaSel ('Just "center") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive (NonEmpty Double))) :*: S1 ('MetaSel ('Just "radius") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double))) | |
Create a value of Circle with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:center:Circle', circle_center - A single point geometry, specifying the center of the circle, using
WGS 84
coordinates, in the form [longitude, latitude].
$sel:radius:Circle', circle_radius - The radius of the circle in meters. Must be greater than zero and no
larger than 100,000 (100 kilometers).
circle_center :: Lens' Circle (NonEmpty Double) Source #
A single point geometry, specifying the center of the circle, using
WGS 84
coordinates, in the form [longitude, latitude].
circle_radius :: Lens' Circle Double Source #
The radius of the circle in meters. Must be greater than zero and no larger than 100,000 (100 kilometers).
DataSourceConfiguration
data DataSourceConfiguration Source #
Specifies the data storage option chosen for requesting Places.
When using Amazon Location Places:
- If using HERE Technologies as a data provider, you can't store
results for locations in Japan by setting
IntendedUsetoStorage. parameter. - Under the
MobileAssetTrackingorMobilAssetManagementpricing plan, you can't store results from your place index resources by settingIntendedUsetoStorage. This returns a validation exception error.
For more information, see the AWS Service Terms for Amazon Location Service.
See: newDataSourceConfiguration smart constructor.
Constructors
| DataSourceConfiguration' | |
Fields
| |
Instances
newDataSourceConfiguration :: DataSourceConfiguration Source #
Create a value of DataSourceConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:intendedUse:DataSourceConfiguration', dataSourceConfiguration_intendedUse - Specifies how the results of an operation will be stored by the caller.
Valid values include:
SingleUsespecifies that the results won't be stored.Storagespecifies that the result can be cached or stored in a database.
Default value: SingleUse
dataSourceConfiguration_intendedUse :: Lens' DataSourceConfiguration (Maybe IntendedUse) Source #
Specifies how the results of an operation will be stored by the caller.
Valid values include:
SingleUsespecifies that the results won't be stored.Storagespecifies that the result can be cached or stored in a database.
Default value: SingleUse
DevicePosition
data DevicePosition Source #
Contains the device position details.
See: newDevicePosition smart constructor.
Constructors
| DevicePosition' | |
Fields
| |
Instances
Arguments
| :: NonEmpty Double | |
| -> UTCTime | |
| -> UTCTime | |
| -> DevicePosition |
Create a value of DevicePosition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accuracy:DevicePosition', devicePosition_accuracy - The accuracy of the device position.
$sel:deviceId:DevicePosition', devicePosition_deviceId - The device whose position you retrieved.
$sel:positionProperties:DevicePosition', devicePosition_positionProperties - The properties associated with the position.
$sel:position:DevicePosition', devicePosition_position - The last known device position.
$sel:receivedTime:DevicePosition', devicePosition_receivedTime - The timestamp for when the tracker resource received the device position
in ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
$sel:sampleTime:DevicePosition', devicePosition_sampleTime - The timestamp at which the device's position was determined. Uses
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
devicePosition_accuracy :: Lens' DevicePosition (Maybe PositionalAccuracy) Source #
The accuracy of the device position.
devicePosition_deviceId :: Lens' DevicePosition (Maybe Text) Source #
The device whose position you retrieved.
devicePosition_positionProperties :: Lens' DevicePosition (Maybe (HashMap Text Text)) Source #
The properties associated with the position.
devicePosition_position :: Lens' DevicePosition (NonEmpty Double) Source #
The last known device position.
devicePosition_receivedTime :: Lens' DevicePosition UTCTime Source #
The timestamp for when the tracker resource received the device position
in ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
devicePosition_sampleTime :: Lens' DevicePosition UTCTime Source #
The timestamp at which the device's position was determined. Uses
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
DevicePositionUpdate
data DevicePositionUpdate Source #
Contains the position update details for a device.
See: newDevicePositionUpdate smart constructor.
Constructors
| DevicePositionUpdate' | |
Fields
| |
Instances
newDevicePositionUpdate Source #
Arguments
| :: Text | |
| -> NonEmpty Double | |
| -> UTCTime | |
| -> DevicePositionUpdate |
Create a value of DevicePositionUpdate with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accuracy:DevicePositionUpdate', devicePositionUpdate_accuracy - The accuracy of the device position.
$sel:positionProperties:DevicePositionUpdate', devicePositionUpdate_positionProperties - Associates one of more properties with the position update. A property
is a key-value pair stored with the position update and added to any
geofence event the update may trigger.
Format: "key" : "value"
$sel:deviceId:DevicePositionUpdate', devicePositionUpdate_deviceId - The device associated to the position update.
$sel:position:DevicePositionUpdate', devicePositionUpdate_position - The latest device position defined in
WGS 84
format: [X or longitude, Y or latitude].
$sel:sampleTime:DevicePositionUpdate', devicePositionUpdate_sampleTime - The timestamp at which the device's position was determined. Uses
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
devicePositionUpdate_accuracy :: Lens' DevicePositionUpdate (Maybe PositionalAccuracy) Source #
The accuracy of the device position.
devicePositionUpdate_positionProperties :: Lens' DevicePositionUpdate (Maybe (HashMap Text Text)) Source #
Associates one of more properties with the position update. A property is a key-value pair stored with the position update and added to any geofence event the update may trigger.
Format: "key" : "value"
devicePositionUpdate_deviceId :: Lens' DevicePositionUpdate Text Source #
The device associated to the position update.
devicePositionUpdate_position :: Lens' DevicePositionUpdate (NonEmpty Double) Source #
The latest device position defined in
WGS 84
format: [X or longitude, Y or latitude].
devicePositionUpdate_sampleTime :: Lens' DevicePositionUpdate UTCTime Source #
The timestamp at which the device's position was determined. Uses
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
GeofenceGeometry
data GeofenceGeometry Source #
Contains the geofence geometry details.
A geofence geometry is made up of either a polygon or a circle. Can be either a polygon or a circle. Including both will return a validation error.
Amazon Location doesn't currently support polygons with holes, multipolygons, polygons that are wound clockwise, or that cross the antimeridian.
See: newGeofenceGeometry smart constructor.
Constructors
| GeofenceGeometry' | |
Fields
| |
Instances
newGeofenceGeometry :: GeofenceGeometry Source #
Create a value of GeofenceGeometry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:circle:GeofenceGeometry', geofenceGeometry_circle - A circle on the earth, as defined by a center point and a radius.
$sel:polygon:GeofenceGeometry', geofenceGeometry_polygon - A polygon is a list of linear rings which are each made up of a list of
vertices.
Each vertex is a 2-dimensional point of the form:
[longitude, latitude]. This is represented as an array of doubles of
length 2 (so [double, double]).
An array of 4 or more vertices, where the first and last vertex are the
same (to form a closed boundary), is called a linear ring. The linear
ring vertices must be listed in counter-clockwise order around the
ring’s interior. The linear ring is represented as an array of vertices,
or an array of arrays of doubles ([[double, double], ...]).
A geofence consists of a single linear ring. To allow for future
expansion, the Polygon parameter takes an array of linear rings, which
is represented as an array of arrays of arrays of doubles
([[[double, double], ...], ...]).
A linear ring for use in geofences can consist of between 4 and 1,000 vertices.
geofenceGeometry_circle :: Lens' GeofenceGeometry (Maybe Circle) Source #
A circle on the earth, as defined by a center point and a radius.
geofenceGeometry_polygon :: Lens' GeofenceGeometry (Maybe (NonEmpty (NonEmpty (NonEmpty Double)))) Source #
A polygon is a list of linear rings which are each made up of a list of vertices.
Each vertex is a 2-dimensional point of the form:
[longitude, latitude]. This is represented as an array of doubles of
length 2 (so [double, double]).
An array of 4 or more vertices, where the first and last vertex are the
same (to form a closed boundary), is called a linear ring. The linear
ring vertices must be listed in counter-clockwise order around the
ring’s interior. The linear ring is represented as an array of vertices,
or an array of arrays of doubles ([[double, double], ...]).
A geofence consists of a single linear ring. To allow for future
expansion, the Polygon parameter takes an array of linear rings, which
is represented as an array of arrays of arrays of doubles
([[[double, double], ...], ...]).
A linear ring for use in geofences can consist of between 4 and 1,000 vertices.
Leg
Contains the calculated route's details for each path between a pair of positions. The number of legs returned corresponds to one fewer than the total number of positions in the request.
For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:
- The
StartPositionis the departure position. - The
EndPositionis the destination position.
A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:
- Leg 1: The
StartPositionis the departure position . TheEndPositionis the waypoint positon. - Leg 2: The
StartPositionis the waypoint position. TheEndPositionis the destination position.
See: newLeg smart constructor.
Constructors
| Leg' | |
Fields
| |
Instances
Create a value of Leg with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:geometry:Leg', leg_geometry - Contains the calculated route's path as a linestring geometry.
Leg, leg_distance - The distance between the leg's StartPosition and EndPosition along
a calculated route.
- The default measurement is
Kilometersunless the request specifies aDistanceUnitofMiles.
Leg, leg_durationSeconds - The estimated travel time between the leg's StartPosition and
EndPosition. The travel mode and departure time that you specify in
the request determines the calculated time.
Leg, leg_endPosition - The terminating position of the leg. Follows the format
[longitude,latitude].
If the EndPosition isn't located on a road, it's
snapped to a nearby road.
Leg, leg_startPosition - The starting position of the leg. Follows the format
[longitude,latitude].
If the StartPosition isn't located on a road, it's
snapped to a nearby road.
$sel:steps:Leg', leg_steps - Contains a list of steps, which represent subsections of a leg. Each
step provides instructions for how to move to the next step in the leg
such as the step's start position, end position, travel distance,
travel duration, and geometry offset.
leg_geometry :: Lens' Leg (Maybe LegGeometry) Source #
Contains the calculated route's path as a linestring geometry.
leg_distance :: Lens' Leg Double Source #
The distance between the leg's StartPosition and EndPosition along
a calculated route.
- The default measurement is
Kilometersunless the request specifies aDistanceUnitofMiles.
leg_durationSeconds :: Lens' Leg Double Source #
The estimated travel time between the leg's StartPosition and
EndPosition. The travel mode and departure time that you specify in
the request determines the calculated time.
leg_endPosition :: Lens' Leg (NonEmpty Double) Source #
The terminating position of the leg. Follows the format
[longitude,latitude].
If the EndPosition isn't located on a road, it's
snapped to a nearby road.
leg_startPosition :: Lens' Leg (NonEmpty Double) Source #
The starting position of the leg. Follows the format
[longitude,latitude].
If the StartPosition isn't located on a road, it's
snapped to a nearby road.
leg_steps :: Lens' Leg [Step] Source #
Contains a list of steps, which represent subsections of a leg. Each step provides instructions for how to move to the next step in the leg such as the step's start position, end position, travel distance, travel duration, and geometry offset.
LegGeometry
data LegGeometry Source #
Contains the geometry details for each path between a pair of positions. Used in plotting a route leg on a map.
See: newLegGeometry smart constructor.
Constructors
| LegGeometry' | |
Fields
| |
Instances
newLegGeometry :: LegGeometry Source #
Create a value of LegGeometry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lineString:LegGeometry', legGeometry_lineString - An ordered list of positions used to plot a route on a map.
The first position is closest to the start position for the leg, and the last position is the closest to the end position for the leg.
- For example,
[[-123.117, 49.284],[-123.115, 49.285],[-123.115, 49.285]]
legGeometry_lineString :: Lens' LegGeometry (Maybe (NonEmpty (NonEmpty Double))) Source #
An ordered list of positions used to plot a route on a map.
The first position is closest to the start position for the leg, and the last position is the closest to the end position for the leg.
- For example,
[[-123.117, 49.284],[-123.115, 49.285],[-123.115, 49.285]]
ListDevicePositionsResponseEntry
data ListDevicePositionsResponseEntry Source #
Contains the tracker resource details.
See: newListDevicePositionsResponseEntry smart constructor.
Constructors
| ListDevicePositionsResponseEntry' | |
Fields
| |
Instances
newListDevicePositionsResponseEntry Source #
Arguments
| :: Text | |
| -> NonEmpty Double | |
| -> UTCTime | |
| -> ListDevicePositionsResponseEntry |
Create a value of ListDevicePositionsResponseEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accuracy:ListDevicePositionsResponseEntry', listDevicePositionsResponseEntry_accuracy - The accuracy of the device position.
$sel:positionProperties:ListDevicePositionsResponseEntry', listDevicePositionsResponseEntry_positionProperties - The properties associated with the position.
$sel:deviceId:ListDevicePositionsResponseEntry', listDevicePositionsResponseEntry_deviceId - The ID of the device for this position.
$sel:position:ListDevicePositionsResponseEntry', listDevicePositionsResponseEntry_position - The last known device position. Empty if no positions currently stored.
$sel:sampleTime:ListDevicePositionsResponseEntry', listDevicePositionsResponseEntry_sampleTime - The timestamp at which the device position was determined. Uses
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
listDevicePositionsResponseEntry_accuracy :: Lens' ListDevicePositionsResponseEntry (Maybe PositionalAccuracy) Source #
The accuracy of the device position.
listDevicePositionsResponseEntry_positionProperties :: Lens' ListDevicePositionsResponseEntry (Maybe (HashMap Text Text)) Source #
The properties associated with the position.
listDevicePositionsResponseEntry_deviceId :: Lens' ListDevicePositionsResponseEntry Text Source #
The ID of the device for this position.
listDevicePositionsResponseEntry_position :: Lens' ListDevicePositionsResponseEntry (NonEmpty Double) Source #
The last known device position. Empty if no positions currently stored.
listDevicePositionsResponseEntry_sampleTime :: Lens' ListDevicePositionsResponseEntry UTCTime Source #
The timestamp at which the device position was determined. Uses
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
ListGeofenceCollectionsResponseEntry
data ListGeofenceCollectionsResponseEntry Source #
Contains the geofence collection details.
See: newListGeofenceCollectionsResponseEntry smart constructor.
Constructors
| ListGeofenceCollectionsResponseEntry' | |
Fields
| |
Instances
newListGeofenceCollectionsResponseEntry Source #
Arguments
| :: Text | |
| -> UTCTime | |
| -> Text | |
| -> UTCTime | |
| -> ListGeofenceCollectionsResponseEntry |
Create a value of ListGeofenceCollectionsResponseEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pricingPlan:ListGeofenceCollectionsResponseEntry', listGeofenceCollectionsResponseEntry_pricingPlan - No longer used. Always returns RequestBasedUsage.
$sel:pricingPlanDataSource:ListGeofenceCollectionsResponseEntry', listGeofenceCollectionsResponseEntry_pricingPlanDataSource - No longer used. Always returns an empty string.
$sel:collectionName:ListGeofenceCollectionsResponseEntry', listGeofenceCollectionsResponseEntry_collectionName - The name of the geofence collection.
$sel:createTime:ListGeofenceCollectionsResponseEntry', listGeofenceCollectionsResponseEntry_createTime - The timestamp for when the geofence collection was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
$sel:description:ListGeofenceCollectionsResponseEntry', listGeofenceCollectionsResponseEntry_description - The description for the geofence collection
$sel:updateTime:ListGeofenceCollectionsResponseEntry', listGeofenceCollectionsResponseEntry_updateTime - Specifies a timestamp for when the resource was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
listGeofenceCollectionsResponseEntry_pricingPlan :: Lens' ListGeofenceCollectionsResponseEntry (Maybe PricingPlan) Source #
No longer used. Always returns RequestBasedUsage.
listGeofenceCollectionsResponseEntry_pricingPlanDataSource :: Lens' ListGeofenceCollectionsResponseEntry (Maybe Text) Source #
No longer used. Always returns an empty string.
listGeofenceCollectionsResponseEntry_collectionName :: Lens' ListGeofenceCollectionsResponseEntry Text Source #
The name of the geofence collection.
listGeofenceCollectionsResponseEntry_createTime :: Lens' ListGeofenceCollectionsResponseEntry UTCTime Source #
The timestamp for when the geofence collection was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
listGeofenceCollectionsResponseEntry_description :: Lens' ListGeofenceCollectionsResponseEntry Text Source #
The description for the geofence collection
listGeofenceCollectionsResponseEntry_updateTime :: Lens' ListGeofenceCollectionsResponseEntry UTCTime Source #
Specifies a timestamp for when the resource was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
ListGeofenceResponseEntry
data ListGeofenceResponseEntry Source #
Contains a list of geofences stored in a given geofence collection.
See: newListGeofenceResponseEntry smart constructor.
Constructors
| ListGeofenceResponseEntry' | |
Fields
| |
Instances
newListGeofenceResponseEntry Source #
Arguments
| :: UTCTime | |
| -> Text | |
| -> GeofenceGeometry | |
| -> Text | |
| -> UTCTime | |
| -> ListGeofenceResponseEntry |
Create a value of ListGeofenceResponseEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createTime:ListGeofenceResponseEntry', listGeofenceResponseEntry_createTime - The timestamp for when the geofence was stored in a geofence collection
in ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
$sel:geofenceId:ListGeofenceResponseEntry', listGeofenceResponseEntry_geofenceId - The geofence identifier.
$sel:geometry:ListGeofenceResponseEntry', listGeofenceResponseEntry_geometry - Contains the geofence geometry details describing a polygon or a circle.
$sel:status:ListGeofenceResponseEntry', listGeofenceResponseEntry_status - Identifies the state of the geofence. A geofence will hold one of the
following states:
ACTIVE— The geofence has been indexed by the system.PENDING— The geofence is being processed by the system.FAILED— The geofence failed to be indexed by the system.DELETED— The geofence has been deleted from the system index.DELETING— The geofence is being deleted from the system index.
$sel:updateTime:ListGeofenceResponseEntry', listGeofenceResponseEntry_updateTime - The timestamp for when the geofence was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
listGeofenceResponseEntry_createTime :: Lens' ListGeofenceResponseEntry UTCTime Source #
The timestamp for when the geofence was stored in a geofence collection
in ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
listGeofenceResponseEntry_geofenceId :: Lens' ListGeofenceResponseEntry Text Source #
The geofence identifier.
listGeofenceResponseEntry_geometry :: Lens' ListGeofenceResponseEntry GeofenceGeometry Source #
Contains the geofence geometry details describing a polygon or a circle.
listGeofenceResponseEntry_status :: Lens' ListGeofenceResponseEntry Text Source #
Identifies the state of the geofence. A geofence will hold one of the following states:
ACTIVE— The geofence has been indexed by the system.PENDING— The geofence is being processed by the system.FAILED— The geofence failed to be indexed by the system.DELETED— The geofence has been deleted from the system index.DELETING— The geofence is being deleted from the system index.
listGeofenceResponseEntry_updateTime :: Lens' ListGeofenceResponseEntry UTCTime Source #
The timestamp for when the geofence was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
ListMapsResponseEntry
data ListMapsResponseEntry Source #
Contains details of an existing map resource in your AWS account.
See: newListMapsResponseEntry smart constructor.
Constructors
| ListMapsResponseEntry' | |
Fields
| |
Instances
newListMapsResponseEntry Source #
Create a value of ListMapsResponseEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pricingPlan:ListMapsResponseEntry', listMapsResponseEntry_pricingPlan - No longer used. Always returns RequestBasedUsage.
$sel:createTime:ListMapsResponseEntry', listMapsResponseEntry_createTime - The timestamp for when the map resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
$sel:dataSource:ListMapsResponseEntry', listMapsResponseEntry_dataSource - Specifies the data provider for the associated map tiles.
$sel:description:ListMapsResponseEntry', listMapsResponseEntry_description - The description for the map resource.
$sel:mapName:ListMapsResponseEntry', listMapsResponseEntry_mapName - The name of the associated map resource.
$sel:updateTime:ListMapsResponseEntry', listMapsResponseEntry_updateTime - The timestamp for when the map resource was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
listMapsResponseEntry_pricingPlan :: Lens' ListMapsResponseEntry (Maybe PricingPlan) Source #
No longer used. Always returns RequestBasedUsage.
listMapsResponseEntry_createTime :: Lens' ListMapsResponseEntry UTCTime Source #
The timestamp for when the map resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
listMapsResponseEntry_dataSource :: Lens' ListMapsResponseEntry Text Source #
Specifies the data provider for the associated map tiles.
listMapsResponseEntry_description :: Lens' ListMapsResponseEntry Text Source #
The description for the map resource.
listMapsResponseEntry_mapName :: Lens' ListMapsResponseEntry Text Source #
The name of the associated map resource.
listMapsResponseEntry_updateTime :: Lens' ListMapsResponseEntry UTCTime Source #
The timestamp for when the map resource was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
ListPlaceIndexesResponseEntry
data ListPlaceIndexesResponseEntry Source #
A place index resource listed in your AWS account.
See: newListPlaceIndexesResponseEntry smart constructor.
Constructors
| ListPlaceIndexesResponseEntry' | |
Fields
| |
Instances
newListPlaceIndexesResponseEntry Source #
Create a value of ListPlaceIndexesResponseEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pricingPlan:ListPlaceIndexesResponseEntry', listPlaceIndexesResponseEntry_pricingPlan - No longer used. Always returns RequestBasedUsage.
$sel:createTime:ListPlaceIndexesResponseEntry', listPlaceIndexesResponseEntry_createTime - The timestamp for when the place index resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
$sel:dataSource:ListPlaceIndexesResponseEntry', listPlaceIndexesResponseEntry_dataSource - The data provider of geospatial data. Values can be one of the
following:
Esri
Here
For more information about data providers, see Amazon Location Service data providers.
$sel:description:ListPlaceIndexesResponseEntry', listPlaceIndexesResponseEntry_description - The optional description for the place index resource.
$sel:indexName:ListPlaceIndexesResponseEntry', listPlaceIndexesResponseEntry_indexName - The name of the place index resource.
$sel:updateTime:ListPlaceIndexesResponseEntry', listPlaceIndexesResponseEntry_updateTime - The timestamp for when the place index resource was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
listPlaceIndexesResponseEntry_pricingPlan :: Lens' ListPlaceIndexesResponseEntry (Maybe PricingPlan) Source #
No longer used. Always returns RequestBasedUsage.
listPlaceIndexesResponseEntry_createTime :: Lens' ListPlaceIndexesResponseEntry UTCTime Source #
The timestamp for when the place index resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
listPlaceIndexesResponseEntry_dataSource :: Lens' ListPlaceIndexesResponseEntry Text Source #
The data provider of geospatial data. Values can be one of the following:
Esri
Here
For more information about data providers, see Amazon Location Service data providers.
listPlaceIndexesResponseEntry_description :: Lens' ListPlaceIndexesResponseEntry Text Source #
The optional description for the place index resource.
listPlaceIndexesResponseEntry_indexName :: Lens' ListPlaceIndexesResponseEntry Text Source #
The name of the place index resource.
listPlaceIndexesResponseEntry_updateTime :: Lens' ListPlaceIndexesResponseEntry UTCTime Source #
The timestamp for when the place index resource was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
ListRouteCalculatorsResponseEntry
data ListRouteCalculatorsResponseEntry Source #
A route calculator resource listed in your AWS account.
See: newListRouteCalculatorsResponseEntry smart constructor.
Constructors
| ListRouteCalculatorsResponseEntry' | |
Fields
| |
Instances
newListRouteCalculatorsResponseEntry Source #
Create a value of ListRouteCalculatorsResponseEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pricingPlan:ListRouteCalculatorsResponseEntry', listRouteCalculatorsResponseEntry_pricingPlan - Always returns RequestBasedUsage.
$sel:calculatorName:ListRouteCalculatorsResponseEntry', listRouteCalculatorsResponseEntry_calculatorName - The name of the route calculator resource.
$sel:createTime:ListRouteCalculatorsResponseEntry', listRouteCalculatorsResponseEntry_createTime - The timestamp when the route calculator resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
- For example,
2020–07-2T12:15:20.000Z+01:00
$sel:dataSource:ListRouteCalculatorsResponseEntry', listRouteCalculatorsResponseEntry_dataSource - The data provider of traffic and road network data. Indicates one of the
available providers:
Esri
Here
For more information about data providers, see Amazon Location Service data providers.
$sel:description:ListRouteCalculatorsResponseEntry', listRouteCalculatorsResponseEntry_description - The optional description of the route calculator resource.
$sel:updateTime:ListRouteCalculatorsResponseEntry', listRouteCalculatorsResponseEntry_updateTime - The timestamp when the route calculator resource was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
- For example,
2020–07-2T12:15:20.000Z+01:00
listRouteCalculatorsResponseEntry_pricingPlan :: Lens' ListRouteCalculatorsResponseEntry (Maybe PricingPlan) Source #
Always returns RequestBasedUsage.
listRouteCalculatorsResponseEntry_calculatorName :: Lens' ListRouteCalculatorsResponseEntry Text Source #
The name of the route calculator resource.
listRouteCalculatorsResponseEntry_createTime :: Lens' ListRouteCalculatorsResponseEntry UTCTime Source #
The timestamp when the route calculator resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
- For example,
2020–07-2T12:15:20.000Z+01:00
listRouteCalculatorsResponseEntry_dataSource :: Lens' ListRouteCalculatorsResponseEntry Text Source #
The data provider of traffic and road network data. Indicates one of the available providers:
Esri
Here
For more information about data providers, see Amazon Location Service data providers.
listRouteCalculatorsResponseEntry_description :: Lens' ListRouteCalculatorsResponseEntry Text Source #
The optional description of the route calculator resource.
listRouteCalculatorsResponseEntry_updateTime :: Lens' ListRouteCalculatorsResponseEntry UTCTime Source #
The timestamp when the route calculator resource was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
- For example,
2020–07-2T12:15:20.000Z+01:00
ListTrackersResponseEntry
data ListTrackersResponseEntry Source #
Contains the tracker resource details.
See: newListTrackersResponseEntry smart constructor.
Constructors
| ListTrackersResponseEntry' | |
Fields
| |
Instances
newListTrackersResponseEntry Source #
Arguments
| :: UTCTime | |
| -> Text | |
| -> Text | |
| -> UTCTime | |
| -> ListTrackersResponseEntry |
Create a value of ListTrackersResponseEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pricingPlan:ListTrackersResponseEntry', listTrackersResponseEntry_pricingPlan - Always returns RequestBasedUsage.
$sel:pricingPlanDataSource:ListTrackersResponseEntry', listTrackersResponseEntry_pricingPlanDataSource - No longer used. Always returns an empty string.
$sel:createTime:ListTrackersResponseEntry', listTrackersResponseEntry_createTime - The timestamp for when the tracker resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
$sel:description:ListTrackersResponseEntry', listTrackersResponseEntry_description - The description for the tracker resource.
$sel:trackerName:ListTrackersResponseEntry', listTrackersResponseEntry_trackerName - The name of the tracker resource.
$sel:updateTime:ListTrackersResponseEntry', listTrackersResponseEntry_updateTime - The timestamp at which the device's position was determined. Uses
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
listTrackersResponseEntry_pricingPlan :: Lens' ListTrackersResponseEntry (Maybe PricingPlan) Source #
Always returns RequestBasedUsage.
listTrackersResponseEntry_pricingPlanDataSource :: Lens' ListTrackersResponseEntry (Maybe Text) Source #
No longer used. Always returns an empty string.
listTrackersResponseEntry_createTime :: Lens' ListTrackersResponseEntry UTCTime Source #
The timestamp for when the tracker resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
listTrackersResponseEntry_description :: Lens' ListTrackersResponseEntry Text Source #
The description for the tracker resource.
listTrackersResponseEntry_trackerName :: Lens' ListTrackersResponseEntry Text Source #
The name of the tracker resource.
listTrackersResponseEntry_updateTime :: Lens' ListTrackersResponseEntry UTCTime Source #
The timestamp at which the device's position was determined. Uses
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
MapConfiguration
data MapConfiguration Source #
Specifies the map tile style selected from an available provider.
See: newMapConfiguration smart constructor.
Constructors
| MapConfiguration' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> MapConfiguration |
Create a value of MapConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:style:MapConfiguration', mapConfiguration_style - Specifies the map style selected from an available data provider.
Valid Esri map styles:
VectorEsriDarkGrayCanvas– The Esri Dark Gray Canvas map style. A vector basemap with a dark gray, neutral background with minimal colors, labels, and features that's designed to draw attention to your thematic content.RasterEsriImagery– The Esri Imagery map style. A raster basemap that provides one meter or better satellite and aerial imagery in many parts of the world and lower resolution satellite imagery worldwide.VectorEsriLightGrayCanvas– The Esri Light Gray Canvas map style, which provides a detailed vector basemap with a light gray, neutral background style with minimal colors, labels, and features that's designed to draw attention to your thematic content.VectorEsriTopographic– The Esri Light map style, which provides a detailed vector basemap with a classic Esri map style.VectorEsriStreets– The Esri World Streets map style, which provides a detailed vector basemap for the world symbolized with a classic Esri street map style. The vector tile layer is similar in content and style to the World Street Map raster map.VectorEsriNavigation– The Esri World Navigation map style, which provides a detailed basemap for the world symbolized with a custom navigation map style that's designed for use during the day in mobile devices.
Valid HERE Technologies map styles:
VectorHereContrast– The HERE Contrast (Berlin) map style is a high contrast detailed base map of the world that blends 3D and 2D rendering.The
VectorHereContraststyle has been renamed fromVectorHereBerlin.VectorHereBerlinhas been deprecated, but will continue to work in applications that use it.VectorHereExplore– A default HERE map style containing a neutral, global map and its features including roads, buildings, landmarks, and water features. It also now includes a fully designed map of Japan.VectorHereExploreTruck– A global map containing truck restrictions and attributes (e.g. width / height / HAZMAT) symbolized with highlighted segments and icons on top of HERE Explore to support use cases within transport and logistics.RasterHereExploreSatellite– A global map containing high resolution satellite imagery.HybridHereExploreSatellite– A global map displaying the road network, street names, and city labels over satellite imagery. This style will automatically retrieve both raster and vector tiles, and your charges will be based on total tiles retrieved.Hybrid styles use both vector and raster tiles when rendering the map that you see. This means that more tiles are retrieved than when using either vector or raster tiles alone. Your charges will include all tiles retrieved.
Valid Open Data (Preview) map styles:
VectorOpenDataStandardLight– The Open Data Standard Light (preview) map style provides a detailed basemap for the world suitable for website and mobile application use. The map includes highways major roads, minor roads, railways, water features, cities, parks, landmarks, building footprints, and administrative boundaries.Open Data maps is in preview. We may add, change, or remove features before announcing general availability. For more information, see Open Data is in preview release.
mapConfiguration_style :: Lens' MapConfiguration Text Source #
Specifies the map style selected from an available data provider.
Valid Esri map styles:
VectorEsriDarkGrayCanvas– The Esri Dark Gray Canvas map style. A vector basemap with a dark gray, neutral background with minimal colors, labels, and features that's designed to draw attention to your thematic content.RasterEsriImagery– The Esri Imagery map style. A raster basemap that provides one meter or better satellite and aerial imagery in many parts of the world and lower resolution satellite imagery worldwide.VectorEsriLightGrayCanvas– The Esri Light Gray Canvas map style, which provides a detailed vector basemap with a light gray, neutral background style with minimal colors, labels, and features that's designed to draw attention to your thematic content.VectorEsriTopographic– The Esri Light map style, which provides a detailed vector basemap with a classic Esri map style.VectorEsriStreets– The Esri World Streets map style, which provides a detailed vector basemap for the world symbolized with a classic Esri street map style. The vector tile layer is similar in content and style to the World Street Map raster map.VectorEsriNavigation– The Esri World Navigation map style, which provides a detailed basemap for the world symbolized with a custom navigation map style that's designed for use during the day in mobile devices.
Valid HERE Technologies map styles:
VectorHereContrast– The HERE Contrast (Berlin) map style is a high contrast detailed base map of the world that blends 3D and 2D rendering.The
VectorHereContraststyle has been renamed fromVectorHereBerlin.VectorHereBerlinhas been deprecated, but will continue to work in applications that use it.VectorHereExplore– A default HERE map style containing a neutral, global map and its features including roads, buildings, landmarks, and water features. It also now includes a fully designed map of Japan.VectorHereExploreTruck– A global map containing truck restrictions and attributes (e.g. width / height / HAZMAT) symbolized with highlighted segments and icons on top of HERE Explore to support use cases within transport and logistics.RasterHereExploreSatellite– A global map containing high resolution satellite imagery.HybridHereExploreSatellite– A global map displaying the road network, street names, and city labels over satellite imagery. This style will automatically retrieve both raster and vector tiles, and your charges will be based on total tiles retrieved.Hybrid styles use both vector and raster tiles when rendering the map that you see. This means that more tiles are retrieved than when using either vector or raster tiles alone. Your charges will include all tiles retrieved.
Valid Open Data (Preview) map styles:
VectorOpenDataStandardLight– The Open Data Standard Light (preview) map style provides a detailed basemap for the world suitable for website and mobile application use. The map includes highways major roads, minor roads, railways, water features, cities, parks, landmarks, building footprints, and administrative boundaries.Open Data maps is in preview. We may add, change, or remove features before announcing general availability. For more information, see Open Data is in preview release.
Place
Contains details about addresses or points of interest that match the search criteria.
Not all details are included with all responses. Some details may only be returned by specific data partners.
See: newPlace smart constructor.
Constructors
| Place' | |
Fields
| |
Instances
Arguments
| :: PlaceGeometry | |
| -> Place |
Create a value of Place with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:addressNumber:Place', place_addressNumber - The numerical portion of an address, such as a building number.
$sel:country:Place', place_country - A country/region specified using
ISO 3166 3-digit
country/region code. For example, CAN.
$sel:interpolated:Place', place_interpolated - True if the result is interpolated from other known places.
False if the Place is a known place.
Not returned when the partner does not provide the information.
For example, returns False for an address location that is found in
the partner data, but returns True if an address does not exist in the
partner data and its location is calculated by interpolating between
other known addresses.
$sel:label:Place', place_label - The full name and address of the point of interest such as a city,
region, or country. For example, 123 Any Street, Any Town, USA.
$sel:municipality:Place', place_municipality - A name for a local area, such as a city or town name. For example,
Toronto.
$sel:neighborhood:Place', place_neighborhood - The name of a community district. For example, Downtown.
$sel:postalCode:Place', place_postalCode - A group of numbers and letters in a country-specific format, which
accompanies the address for the purpose of identifying a location.
$sel:region:Place', place_region - A name for an area or geographical division, such as a province or state
name. For example, British Columbia.
$sel:street:Place', place_street - The name for a street or a road to identify a location. For example,
Main Street.
$sel:subRegion:Place', place_subRegion - A country, or an area that's part of a larger region. For example,
Metro Vancouver.
$sel:timeZone:Place', place_timeZone - The time zone in which the Place is located. Returned only when using
HERE as the selected partner.
$sel:unitNumber:Place', place_unitNumber - For addresses with multiple units, the unit identifier. Can include
numbers and letters, for example 3B or Unit 123.
Returned only for a place index that uses Esri as a data provider. Is
not returned for SearchPlaceIndexForPosition.
$sel:unitType:Place', place_unitType - For addresses with a UnitNumber, the type of unit. For example,
Apartment.
$sel:geometry:Place', place_geometry - Undocumented member.
place_addressNumber :: Lens' Place (Maybe Text) Source #
The numerical portion of an address, such as a building number.
place_country :: Lens' Place (Maybe Text) Source #
A country/region specified using
ISO 3166 3-digit
country/region code. For example, CAN.
place_interpolated :: Lens' Place (Maybe Bool) Source #
True if the result is interpolated from other known places.
False if the Place is a known place.
Not returned when the partner does not provide the information.
For example, returns False for an address location that is found in
the partner data, but returns True if an address does not exist in the
partner data and its location is calculated by interpolating between
other known addresses.
place_label :: Lens' Place (Maybe Text) Source #
The full name and address of the point of interest such as a city,
region, or country. For example, 123 Any Street, Any Town, USA.
place_municipality :: Lens' Place (Maybe Text) Source #
A name for a local area, such as a city or town name. For example,
Toronto.
place_neighborhood :: Lens' Place (Maybe Text) Source #
The name of a community district. For example, Downtown.
place_postalCode :: Lens' Place (Maybe Text) Source #
A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.
place_region :: Lens' Place (Maybe Text) Source #
A name for an area or geographical division, such as a province or state
name. For example, British Columbia.
place_street :: Lens' Place (Maybe Text) Source #
The name for a street or a road to identify a location. For example,
Main Street.
place_subRegion :: Lens' Place (Maybe Text) Source #
A country, or an area that's part of a larger region. For example,
Metro Vancouver.
place_timeZone :: Lens' Place (Maybe TimeZone) Source #
The time zone in which the Place is located. Returned only when using
HERE as the selected partner.
place_unitNumber :: Lens' Place (Maybe Text) Source #
For addresses with multiple units, the unit identifier. Can include
numbers and letters, for example 3B or Unit 123.
Returned only for a place index that uses Esri as a data provider. Is
not returned for SearchPlaceIndexForPosition.
place_unitType :: Lens' Place (Maybe Text) Source #
For addresses with a UnitNumber, the type of unit. For example,
Apartment.
place_geometry :: Lens' Place PlaceGeometry Source #
Undocumented member.
PlaceGeometry
data PlaceGeometry Source #
Places uses a point geometry to specify a location or a Place.
See: newPlaceGeometry smart constructor.
Constructors
| PlaceGeometry' | |
Instances
newPlaceGeometry :: PlaceGeometry Source #
Create a value of PlaceGeometry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:point:PlaceGeometry', placeGeometry_point - A single point geometry specifies a location for a Place using
WGS 84
coordinates:
- x — Specifies the x coordinate or longitude.
- y — Specifies the y coordinate or latitude.
placeGeometry_point :: Lens' PlaceGeometry (Maybe (NonEmpty Double)) Source #
A single point geometry specifies a location for a Place using WGS 84 coordinates:
- x — Specifies the x coordinate or longitude.
- y — Specifies the y coordinate or latitude.
PositionalAccuracy
data PositionalAccuracy Source #
Defines the level of certainty of the position.
See: newPositionalAccuracy smart constructor.
Constructors
| PositionalAccuracy' | |
Fields
| |
Instances
newPositionalAccuracy Source #
Arguments
| :: Double | |
| -> PositionalAccuracy |
Create a value of PositionalAccuracy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:horizontal:PositionalAccuracy', positionalAccuracy_horizontal - Estimated maximum distance, in meters, between the measured position and
the true position of a device, along the Earth's surface.
positionalAccuracy_horizontal :: Lens' PositionalAccuracy Double Source #
Estimated maximum distance, in meters, between the measured position and the true position of a device, along the Earth's surface.
RouteMatrixEntry
data RouteMatrixEntry Source #
The result for the calculated route of one DeparturePosition
DestinationPosition pair.
See: newRouteMatrixEntry smart constructor.
Constructors
| RouteMatrixEntry' | |
Fields
| |
Instances
newRouteMatrixEntry :: RouteMatrixEntry Source #
Create a value of RouteMatrixEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:distance:RouteMatrixEntry', routeMatrixEntry_distance - The total distance of travel for the route.
$sel:durationSeconds:RouteMatrixEntry', routeMatrixEntry_durationSeconds - The expected duration of travel for the route.
$sel:error:RouteMatrixEntry', routeMatrixEntry_error - An error corresponding to the calculation of a route between the
DeparturePosition and DestinationPosition.
routeMatrixEntry_distance :: Lens' RouteMatrixEntry (Maybe Double) Source #
The total distance of travel for the route.
routeMatrixEntry_durationSeconds :: Lens' RouteMatrixEntry (Maybe Double) Source #
The expected duration of travel for the route.
routeMatrixEntry_error :: Lens' RouteMatrixEntry (Maybe RouteMatrixEntryError) Source #
An error corresponding to the calculation of a route between the
DeparturePosition and DestinationPosition.
RouteMatrixEntryError
data RouteMatrixEntryError Source #
An error corresponding to the calculation of a route between the
DeparturePosition and DestinationPosition.
The error code can be one of the following:
RouteNotFound- Unable to find a valid route with the given parameters.RouteTooLong- Route calculation went beyond the maximum size of a route and was terminated before completion.PositionsNotFound- One or more of the input positions were not found on the route network.DestinationPositionNotFound- The destination position was not found on the route network.DeparturePositionNotFound- The departure position was not found on the route network.OtherValidationError- The given inputs were not valid or a route was not found. More information is given in the errorMessage
See: newRouteMatrixEntryError smart constructor.
Constructors
| RouteMatrixEntryError' | |
Fields
| |
Instances
newRouteMatrixEntryError Source #
Create a value of RouteMatrixEntryError with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:message:RouteMatrixEntryError', routeMatrixEntryError_message - A message about the error that occurred for the route calculation.
$sel:code:RouteMatrixEntryError', routeMatrixEntryError_code - The type of error which occurred for the route calculation.
routeMatrixEntryError_message :: Lens' RouteMatrixEntryError (Maybe Text) Source #
A message about the error that occurred for the route calculation.
routeMatrixEntryError_code :: Lens' RouteMatrixEntryError RouteMatrixErrorCode Source #
The type of error which occurred for the route calculation.
SearchForPositionResult
data SearchForPositionResult Source #
Contains a search result from a position search query that is run on a place index resource.
See: newSearchForPositionResult smart constructor.
Constructors
| SearchForPositionResult' | |
Fields
| |
Instances
newSearchForPositionResult Source #
Arguments
| :: Double | |
| -> Place | |
| -> SearchForPositionResult |
Create a value of SearchForPositionResult with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:placeId:SearchForPositionResult', searchForPositionResult_placeId - The unique identifier of the place. You can use this with the GetPlace
operation to find the place again later.
For SearchPlaceIndexForPosition operations, the PlaceId is returned
only by place indexes that use HERE as a data provider.
$sel:distance:SearchForPositionResult', searchForPositionResult_distance - The distance in meters of a great-circle arc between the query position
and the result.
A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance between two locations.
$sel:place:SearchForPositionResult', searchForPositionResult_place - Details about the search result, such as its address and position.
searchForPositionResult_placeId :: Lens' SearchForPositionResult (Maybe Text) Source #
The unique identifier of the place. You can use this with the GetPlace
operation to find the place again later.
For SearchPlaceIndexForPosition operations, the PlaceId is returned
only by place indexes that use HERE as a data provider.
searchForPositionResult_distance :: Lens' SearchForPositionResult Double Source #
The distance in meters of a great-circle arc between the query position and the result.
A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance between two locations.
searchForPositionResult_place :: Lens' SearchForPositionResult Place Source #
Details about the search result, such as its address and position.
SearchForSuggestionsResult
data SearchForSuggestionsResult Source #
Contains a place suggestion resulting from a place suggestion query that is run on a place index resource.
See: newSearchForSuggestionsResult smart constructor.
Constructors
| SearchForSuggestionsResult' | |
Fields
| |
Instances
newSearchForSuggestionsResult Source #
Create a value of SearchForSuggestionsResult with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:placeId:SearchForSuggestionsResult', searchForSuggestionsResult_placeId - The unique identifier of the place. You can use this with the GetPlace
operation to find the place again later.
For SearchPlaceIndexForSuggestions operations, the PlaceId is
returned by place indexes that use HERE or Esri as data providers.
$sel:text:SearchForSuggestionsResult', searchForSuggestionsResult_text - The text of the place suggestion, typically formatted as an address
string.
searchForSuggestionsResult_placeId :: Lens' SearchForSuggestionsResult (Maybe Text) Source #
The unique identifier of the place. You can use this with the GetPlace
operation to find the place again later.
For SearchPlaceIndexForSuggestions operations, the PlaceId is
returned by place indexes that use HERE or Esri as data providers.
searchForSuggestionsResult_text :: Lens' SearchForSuggestionsResult Text Source #
The text of the place suggestion, typically formatted as an address string.
SearchForTextResult
data SearchForTextResult Source #
Contains a search result from a text search query that is run on a place index resource.
See: newSearchForTextResult smart constructor.
Constructors
| SearchForTextResult' | |
Fields
| |
Instances
newSearchForTextResult Source #
Arguments
| :: Place | |
| -> SearchForTextResult |
Create a value of SearchForTextResult with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:distance:SearchForTextResult', searchForTextResult_distance - The distance in meters of a great-circle arc between the bias position
specified and the result. Distance will be returned only if a bias
position was specified in the query.
A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance between two locations.
$sel:placeId:SearchForTextResult', searchForTextResult_placeId - The unique identifier of the place. You can use this with the GetPlace
operation to find the place again later.
For SearchPlaceIndexForText operations, the PlaceId is returned only
by place indexes that use HERE as a data provider.
$sel:relevance:SearchForTextResult', searchForTextResult_relevance - The relative confidence in the match for a result among the results
returned. For example, if more fields for an address match (including
house number, street, city, country/region, and postal code), the
relevance score is closer to 1.
Returned only when the partner selected is Esri.
$sel:place:SearchForTextResult', searchForTextResult_place - Details about the search result, such as its address and position.
searchForTextResult_distance :: Lens' SearchForTextResult (Maybe Double) Source #
The distance in meters of a great-circle arc between the bias position
specified and the result. Distance will be returned only if a bias
position was specified in the query.
A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance between two locations.
searchForTextResult_placeId :: Lens' SearchForTextResult (Maybe Text) Source #
The unique identifier of the place. You can use this with the GetPlace
operation to find the place again later.
For SearchPlaceIndexForText operations, the PlaceId is returned only
by place indexes that use HERE as a data provider.
searchForTextResult_relevance :: Lens' SearchForTextResult (Maybe Double) Source #
The relative confidence in the match for a result among the results returned. For example, if more fields for an address match (including house number, street, city, country/region, and postal code), the relevance score is closer to 1.
Returned only when the partner selected is Esri.
searchForTextResult_place :: Lens' SearchForTextResult Place Source #
Details about the search result, such as its address and position.
SearchPlaceIndexForPositionSummary
data SearchPlaceIndexForPositionSummary Source #
A summary of the request sent by using SearchPlaceIndexForPosition.
See: newSearchPlaceIndexForPositionSummary smart constructor.
Constructors
| SearchPlaceIndexForPositionSummary' | |
Fields
| |
Instances
newSearchPlaceIndexForPositionSummary Source #
Arguments
| :: Text | |
| -> NonEmpty Double | |
| -> SearchPlaceIndexForPositionSummary |
Create a value of SearchPlaceIndexForPositionSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:language:SearchPlaceIndexForPositionSummary', searchPlaceIndexForPositionSummary_language - The preferred language used to return results. Matches the language in
the request. The value is a valid
BCP 47 language tag, for example,
en for English.
$sel:maxResults:SearchPlaceIndexForPositionSummary', searchPlaceIndexForPositionSummary_maxResults - Contains the optional result count limit that is specified in the
request.
Default value: 50
$sel:dataSource:SearchPlaceIndexForPositionSummary', searchPlaceIndexForPositionSummary_dataSource - The geospatial data provider attached to the place index resource
specified in the request. Values can be one of the following:
- Esri
- Here
For more information about data providers, see Amazon Location Service data providers.
$sel:position:SearchPlaceIndexForPositionSummary', searchPlaceIndexForPositionSummary_position - The position specified in the request.
searchPlaceIndexForPositionSummary_language :: Lens' SearchPlaceIndexForPositionSummary (Maybe Text) Source #
The preferred language used to return results. Matches the language in
the request. The value is a valid
BCP 47 language tag, for example,
en for English.
searchPlaceIndexForPositionSummary_maxResults :: Lens' SearchPlaceIndexForPositionSummary (Maybe Natural) Source #
Contains the optional result count limit that is specified in the request.
Default value: 50
searchPlaceIndexForPositionSummary_dataSource :: Lens' SearchPlaceIndexForPositionSummary Text Source #
The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:
- Esri
- Here
For more information about data providers, see Amazon Location Service data providers.
searchPlaceIndexForPositionSummary_position :: Lens' SearchPlaceIndexForPositionSummary (NonEmpty Double) Source #
The position specified in the request.
SearchPlaceIndexForSuggestionsSummary
data SearchPlaceIndexForSuggestionsSummary Source #
A summary of the request sent by using SearchPlaceIndexForSuggestions.
See: newSearchPlaceIndexForSuggestionsSummary smart constructor.
Constructors
| SearchPlaceIndexForSuggestionsSummary' | |
Fields
| |
Instances
newSearchPlaceIndexForSuggestionsSummary Source #
Arguments
| :: Text | |
| -> Text | |
| -> SearchPlaceIndexForSuggestionsSummary |
Create a value of SearchPlaceIndexForSuggestionsSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:biasPosition:SearchPlaceIndexForSuggestionsSummary', searchPlaceIndexForSuggestionsSummary_biasPosition - Contains the coordinates for the optional bias position specified in the
request.
This parameter contains a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.
For example, [-123.1174, 49.2847] represents the position with
longitude -123.1174 and latitude 49.2847.
$sel:filterBBox:SearchPlaceIndexForSuggestionsSummary', searchPlaceIndexForSuggestionsSummary_filterBBox - Contains the coordinates for the optional bounding box specified in the
request.
$sel:filterCountries:SearchPlaceIndexForSuggestionsSummary', searchPlaceIndexForSuggestionsSummary_filterCountries - Contains the optional country filter specified in the request.
$sel:language:SearchPlaceIndexForSuggestionsSummary', searchPlaceIndexForSuggestionsSummary_language - The preferred language used to return results. Matches the language in
the request. The value is a valid
BCP 47 language tag, for example,
en for English.
$sel:maxResults:SearchPlaceIndexForSuggestionsSummary', searchPlaceIndexForSuggestionsSummary_maxResults - Contains the optional result count limit specified in the request.
$sel:dataSource:SearchPlaceIndexForSuggestionsSummary', searchPlaceIndexForSuggestionsSummary_dataSource - The geospatial data provider attached to the place index resource
specified in the request. Values can be one of the following:
- Esri
- Here
For more information about data providers, see Amazon Location Service data providers.
$sel:text:SearchPlaceIndexForSuggestionsSummary', searchPlaceIndexForSuggestionsSummary_text - The free-form partial text input specified in the request.
searchPlaceIndexForSuggestionsSummary_biasPosition :: Lens' SearchPlaceIndexForSuggestionsSummary (Maybe (NonEmpty Double)) Source #
Contains the coordinates for the optional bias position specified in the request.
This parameter contains a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.
For example, [-123.1174, 49.2847] represents the position with
longitude -123.1174 and latitude 49.2847.
searchPlaceIndexForSuggestionsSummary_filterBBox :: Lens' SearchPlaceIndexForSuggestionsSummary (Maybe (NonEmpty Double)) Source #
Contains the coordinates for the optional bounding box specified in the request.
searchPlaceIndexForSuggestionsSummary_filterCountries :: Lens' SearchPlaceIndexForSuggestionsSummary (Maybe (NonEmpty Text)) Source #
Contains the optional country filter specified in the request.
searchPlaceIndexForSuggestionsSummary_language :: Lens' SearchPlaceIndexForSuggestionsSummary (Maybe Text) Source #
The preferred language used to return results. Matches the language in
the request. The value is a valid
BCP 47 language tag, for example,
en for English.
searchPlaceIndexForSuggestionsSummary_maxResults :: Lens' SearchPlaceIndexForSuggestionsSummary (Maybe Int) Source #
Contains the optional result count limit specified in the request.
searchPlaceIndexForSuggestionsSummary_dataSource :: Lens' SearchPlaceIndexForSuggestionsSummary Text Source #
The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:
- Esri
- Here
For more information about data providers, see Amazon Location Service data providers.
searchPlaceIndexForSuggestionsSummary_text :: Lens' SearchPlaceIndexForSuggestionsSummary Text Source #
The free-form partial text input specified in the request.
SearchPlaceIndexForTextSummary
data SearchPlaceIndexForTextSummary Source #
A summary of the request sent by using SearchPlaceIndexForText.
See: newSearchPlaceIndexForTextSummary smart constructor.
Constructors
| SearchPlaceIndexForTextSummary' | |
Fields
| |
Instances
newSearchPlaceIndexForTextSummary Source #
Arguments
| :: Text | |
| -> Text | |
| -> SearchPlaceIndexForTextSummary |
Create a value of SearchPlaceIndexForTextSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:biasPosition:SearchPlaceIndexForTextSummary', searchPlaceIndexForTextSummary_biasPosition - Contains the coordinates for the optional bias position specified in the
request.
This parameter contains a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.
For example, [-123.1174, 49.2847] represents the position with
longitude -123.1174 and latitude 49.2847.
$sel:filterBBox:SearchPlaceIndexForTextSummary', searchPlaceIndexForTextSummary_filterBBox - Contains the coordinates for the optional bounding box specified in the
request.
$sel:filterCountries:SearchPlaceIndexForTextSummary', searchPlaceIndexForTextSummary_filterCountries - Contains the optional country filter specified in the request.
$sel:language:SearchPlaceIndexForTextSummary', searchPlaceIndexForTextSummary_language - The preferred language used to return results. Matches the language in
the request. The value is a valid
BCP 47 language tag, for example,
en for English.
$sel:maxResults:SearchPlaceIndexForTextSummary', searchPlaceIndexForTextSummary_maxResults - Contains the optional result count limit specified in the request.
$sel:resultBBox:SearchPlaceIndexForTextSummary', searchPlaceIndexForTextSummary_resultBBox - The bounding box that fully contains all search results.
If you specified the optional FilterBBox parameter in the request,
ResultBBox is contained within FilterBBox.
$sel:dataSource:SearchPlaceIndexForTextSummary', searchPlaceIndexForTextSummary_dataSource - The geospatial data provider attached to the place index resource
specified in the request. Values can be one of the following:
- Esri
- Here
For more information about data providers, see Amazon Location Service data providers.
$sel:text:SearchPlaceIndexForTextSummary', searchPlaceIndexForTextSummary_text - The search text specified in the request.
searchPlaceIndexForTextSummary_biasPosition :: Lens' SearchPlaceIndexForTextSummary (Maybe (NonEmpty Double)) Source #
Contains the coordinates for the optional bias position specified in the request.
This parameter contains a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.
For example, [-123.1174, 49.2847] represents the position with
longitude -123.1174 and latitude 49.2847.
searchPlaceIndexForTextSummary_filterBBox :: Lens' SearchPlaceIndexForTextSummary (Maybe (NonEmpty Double)) Source #
Contains the coordinates for the optional bounding box specified in the request.
searchPlaceIndexForTextSummary_filterCountries :: Lens' SearchPlaceIndexForTextSummary (Maybe (NonEmpty Text)) Source #
Contains the optional country filter specified in the request.
searchPlaceIndexForTextSummary_language :: Lens' SearchPlaceIndexForTextSummary (Maybe Text) Source #
The preferred language used to return results. Matches the language in
the request. The value is a valid
BCP 47 language tag, for example,
en for English.
searchPlaceIndexForTextSummary_maxResults :: Lens' SearchPlaceIndexForTextSummary (Maybe Natural) Source #
Contains the optional result count limit specified in the request.
searchPlaceIndexForTextSummary_resultBBox :: Lens' SearchPlaceIndexForTextSummary (Maybe (NonEmpty Double)) Source #
The bounding box that fully contains all search results.
If you specified the optional FilterBBox parameter in the request,
ResultBBox is contained within FilterBBox.
searchPlaceIndexForTextSummary_dataSource :: Lens' SearchPlaceIndexForTextSummary Text Source #
The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:
- Esri
- Here
For more information about data providers, see Amazon Location Service data providers.
searchPlaceIndexForTextSummary_text :: Lens' SearchPlaceIndexForTextSummary Text Source #
The search text specified in the request.
Step
Represents an element of a leg within a route. A step contains instructions for how to move to the next step in the leg.
See: newStep smart constructor.
Constructors
| Step' | |
Fields
| |
Instances
Create a value of Step with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:geometryOffset:Step', step_geometryOffset - Represents the start position, or index, in a sequence of steps within
the leg's line string geometry. For example, the index of the first
step in a leg geometry is 0.
Included in the response for queries that set IncludeLegGeometry to
True.
$sel:distance:Step', step_distance - The travel distance between the step's StartPosition and
EndPosition.
$sel:durationSeconds:Step', step_durationSeconds - The estimated travel time, in seconds, from the step's StartPosition
to the EndPosition. . The travel mode and departure time that you
specify in the request determines the calculated time.
$sel:endPosition:Step', step_endPosition - The end position of a step. If the position the last step in the leg,
this position is the same as the end position of the leg.
$sel:startPosition:Step', step_startPosition - The starting position of a step. If the position is the first step in
the leg, this position is the same as the start position of the leg.
step_geometryOffset :: Lens' Step (Maybe Natural) Source #
Represents the start position, or index, in a sequence of steps within
the leg's line string geometry. For example, the index of the first
step in a leg geometry is 0.
Included in the response for queries that set IncludeLegGeometry to
True.
step_distance :: Lens' Step Double Source #
The travel distance between the step's StartPosition and
EndPosition.
step_durationSeconds :: Lens' Step Double Source #
The estimated travel time, in seconds, from the step's StartPosition
to the EndPosition. . The travel mode and departure time that you
specify in the request determines the calculated time.
step_endPosition :: Lens' Step (NonEmpty Double) Source #
The end position of a step. If the position the last step in the leg, this position is the same as the end position of the leg.
step_startPosition :: Lens' Step (NonEmpty Double) Source #
The starting position of a step. If the position is the first step in the leg, this position is the same as the start position of the leg.
TimeZone
Information about a time zone. Includes the name of the time zone and the offset from UTC in seconds.
See: newTimeZone smart constructor.
Constructors
| TimeZone' | |
Instances
| FromJSON TimeZone Source # | |
| Generic TimeZone Source # | |
| Read TimeZone Source # | |
| Show TimeZone Source # | |
| NFData TimeZone Source # | |
Defined in Amazonka.Location.Types.TimeZone | |
| Eq TimeZone Source # | |
| Hashable TimeZone Source # | |
Defined in Amazonka.Location.Types.TimeZone | |
| type Rep TimeZone Source # | |
Defined in Amazonka.Location.Types.TimeZone type Rep TimeZone = D1 ('MetaData "TimeZone" "Amazonka.Location.Types.TimeZone" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "TimeZone'" 'PrefixI 'True) (S1 ('MetaSel ('Just "offset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of TimeZone with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:offset:TimeZone', timeZone_offset - The time zone's offset, in seconds, from UTC.
$sel:name:TimeZone', timeZone_name - The name of the time zone, following the
IANA time zone standard. For example,
America/Los_Angeles.
timeZone_name :: Lens' TimeZone Text Source #
The name of the time zone, following the
IANA time zone standard. For example,
America/Los_Angeles.
TruckDimensions
data TruckDimensions Source #
Contains details about the truck dimensions in the unit of measurement
that you specify. Used to filter out roads that can't support or allow
the specified dimensions for requests that specify TravelMode as
Truck.
See: newTruckDimensions smart constructor.
Constructors
| TruckDimensions' | |
Fields
| |
Instances
newTruckDimensions :: TruckDimensions Source #
Create a value of TruckDimensions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:height:TruckDimensions', truckDimensions_height - The height of the truck.
- For example,
4.5.
For routes calculated with a HERE resource, this value must be between 0 and 50 meters.
$sel:length:TruckDimensions', truckDimensions_length - The length of the truck.
- For example,
15.5.
For routes calculated with a HERE resource, this value must be between 0 and 300 meters.
$sel:unit:TruckDimensions', truckDimensions_unit - Specifies the unit of measurement for the truck dimensions.
Default Value: Meters
$sel:width:TruckDimensions', truckDimensions_width - The width of the truck.
- For example,
4.5.
For routes calculated with a HERE resource, this value must be between 0 and 50 meters.
truckDimensions_height :: Lens' TruckDimensions (Maybe Double) Source #
The height of the truck.
- For example,
4.5.
For routes calculated with a HERE resource, this value must be between 0 and 50 meters.
truckDimensions_length :: Lens' TruckDimensions (Maybe Double) Source #
The length of the truck.
- For example,
15.5.
For routes calculated with a HERE resource, this value must be between 0 and 300 meters.
truckDimensions_unit :: Lens' TruckDimensions (Maybe DimensionUnit) Source #
Specifies the unit of measurement for the truck dimensions.
Default Value: Meters
truckDimensions_width :: Lens' TruckDimensions (Maybe Double) Source #
The width of the truck.
- For example,
4.5.
For routes calculated with a HERE resource, this value must be between 0 and 50 meters.
TruckWeight
data TruckWeight Source #
Contains details about the truck's weight specifications. Used to avoid
roads that can't support or allow the total weight for requests that
specify TravelMode as Truck.
See: newTruckWeight smart constructor.
Constructors
| TruckWeight' | |
Instances
newTruckWeight :: TruckWeight Source #
Create a value of TruckWeight with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:total:TruckWeight', truckWeight_total - The total weight of the truck.
- For example,
3500.
$sel:unit:TruckWeight', truckWeight_unit - The unit of measurement to use for the truck weight.
Default Value: Kilograms
truckWeight_total :: Lens' TruckWeight (Maybe Double) Source #
The total weight of the truck.
- For example,
3500.
truckWeight_unit :: Lens' TruckWeight (Maybe VehicleWeightUnit) Source #
The unit of measurement to use for the truck weight.
Default Value: Kilograms