| 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
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- AssociateTrackerConsumer
- BatchDeleteDevicePositionHistory
- BatchDeleteGeofence
- BatchEvaluateGeofences
- BatchGetDevicePosition
- BatchPutGeofence
- BatchUpdateDevicePosition
- CalculateRoute
- CalculateRouteMatrix
- CreateGeofenceCollection
- CreateMap
- CreatePlaceIndex
- CreateRouteCalculator
- CreateTracker
- DeleteGeofenceCollection
- DeleteMap
- DeletePlaceIndex
- DeleteRouteCalculator
- DeleteTracker
- DescribeGeofenceCollection
- DescribeMap
- DescribePlaceIndex
- DescribeRouteCalculator
- DescribeTracker
- DisassociateTrackerConsumer
- GetDevicePosition
- GetDevicePositionHistory (Paginated)
- GetGeofence
- GetMapGlyphs
- GetMapSprites
- GetMapStyleDescriptor
- GetMapTile
- GetPlace
- ListDevicePositions (Paginated)
- ListGeofenceCollections (Paginated)
- ListGeofences (Paginated)
- ListMaps (Paginated)
- ListPlaceIndexes (Paginated)
- ListRouteCalculators (Paginated)
- ListTagsForResource
- ListTrackerConsumers (Paginated)
- ListTrackers (Paginated)
- PutGeofence
- SearchPlaceIndexForPosition
- SearchPlaceIndexForSuggestions
- SearchPlaceIndexForText
- TagResource
- UntagResource
- UpdateGeofenceCollection
- UpdateMap
- UpdatePlaceIndex
- UpdateRouteCalculator
- UpdateTracker
- Types
- 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
Derived from API version 2020-11-19 of the AWS service descriptions, licensed under Apache 2.0.
"Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing"
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
- data AssociateTrackerConsumer = AssociateTrackerConsumer' Text Text
- newAssociateTrackerConsumer :: Text -> Text -> AssociateTrackerConsumer
- data AssociateTrackerConsumerResponse = AssociateTrackerConsumerResponse' Int
- newAssociateTrackerConsumerResponse :: Int -> AssociateTrackerConsumerResponse
- data BatchDeleteDevicePositionHistory = BatchDeleteDevicePositionHistory' (NonEmpty Text) Text
- newBatchDeleteDevicePositionHistory :: NonEmpty Text -> Text -> BatchDeleteDevicePositionHistory
- data BatchDeleteDevicePositionHistoryResponse = BatchDeleteDevicePositionHistoryResponse' Int [BatchDeleteDevicePositionHistoryError]
- newBatchDeleteDevicePositionHistoryResponse :: Int -> BatchDeleteDevicePositionHistoryResponse
- data BatchDeleteGeofence = BatchDeleteGeofence' Text (NonEmpty Text)
- newBatchDeleteGeofence :: Text -> NonEmpty Text -> BatchDeleteGeofence
- data BatchDeleteGeofenceResponse = BatchDeleteGeofenceResponse' Int [BatchDeleteGeofenceError]
- newBatchDeleteGeofenceResponse :: Int -> BatchDeleteGeofenceResponse
- data BatchEvaluateGeofences = BatchEvaluateGeofences' Text (NonEmpty DevicePositionUpdate)
- newBatchEvaluateGeofences :: Text -> NonEmpty DevicePositionUpdate -> BatchEvaluateGeofences
- data BatchEvaluateGeofencesResponse = BatchEvaluateGeofencesResponse' Int [BatchEvaluateGeofencesError]
- newBatchEvaluateGeofencesResponse :: Int -> BatchEvaluateGeofencesResponse
- data BatchGetDevicePosition = BatchGetDevicePosition' (NonEmpty Text) Text
- newBatchGetDevicePosition :: NonEmpty Text -> Text -> BatchGetDevicePosition
- data BatchGetDevicePositionResponse = BatchGetDevicePositionResponse' Int [DevicePosition] [BatchGetDevicePositionError]
- newBatchGetDevicePositionResponse :: Int -> BatchGetDevicePositionResponse
- data BatchPutGeofence = BatchPutGeofence' Text (NonEmpty BatchPutGeofenceRequestEntry)
- newBatchPutGeofence :: Text -> NonEmpty BatchPutGeofenceRequestEntry -> BatchPutGeofence
- data BatchPutGeofenceResponse = BatchPutGeofenceResponse' Int [BatchPutGeofenceError] [BatchPutGeofenceSuccess]
- newBatchPutGeofenceResponse :: Int -> BatchPutGeofenceResponse
- data BatchUpdateDevicePosition = BatchUpdateDevicePosition' Text (NonEmpty DevicePositionUpdate)
- newBatchUpdateDevicePosition :: Text -> NonEmpty DevicePositionUpdate -> BatchUpdateDevicePosition
- data BatchUpdateDevicePositionResponse = BatchUpdateDevicePositionResponse' Int [BatchUpdateDevicePositionError]
- newBatchUpdateDevicePositionResponse :: Int -> BatchUpdateDevicePositionResponse
- data CalculateRoute = CalculateRoute' (Maybe CalculateRouteCarModeOptions) (Maybe Bool) (Maybe ISO8601) (Maybe DistanceUnit) (Maybe Bool) (Maybe TravelMode) (Maybe CalculateRouteTruckModeOptions) (Maybe [Sensitive (NonEmpty Double)]) Text (Sensitive (NonEmpty Double)) (Sensitive (NonEmpty Double))
- newCalculateRoute :: Text -> NonEmpty Double -> NonEmpty Double -> CalculateRoute
- data CalculateRouteResponse = CalculateRouteResponse' Int [Leg] CalculateRouteSummary
- newCalculateRouteResponse :: Int -> CalculateRouteSummary -> CalculateRouteResponse
- data CalculateRouteMatrix = CalculateRouteMatrix' (Maybe CalculateRouteCarModeOptions) (Maybe Bool) (Maybe ISO8601) (Maybe DistanceUnit) (Maybe TravelMode) (Maybe CalculateRouteTruckModeOptions) Text (NonEmpty (Sensitive (NonEmpty Double))) (NonEmpty (Sensitive (NonEmpty Double)))
- newCalculateRouteMatrix :: Text -> NonEmpty (NonEmpty Double) -> NonEmpty (NonEmpty Double) -> CalculateRouteMatrix
- data CalculateRouteMatrixResponse = CalculateRouteMatrixResponse' (Maybe (NonEmpty (Sensitive (NonEmpty Double)))) (Maybe (NonEmpty (Sensitive (NonEmpty Double)))) Int [[RouteMatrixEntry]] CalculateRouteMatrixSummary
- newCalculateRouteMatrixResponse :: Int -> CalculateRouteMatrixSummary -> CalculateRouteMatrixResponse
- data CreateGeofenceCollection = CreateGeofenceCollection' (Maybe Text) (Maybe Text) (Maybe PricingPlan) (Maybe Text) (Maybe (HashMap Text Text)) Text
- newCreateGeofenceCollection :: Text -> CreateGeofenceCollection
- data CreateGeofenceCollectionResponse = CreateGeofenceCollectionResponse' Int Text Text ISO8601
- newCreateGeofenceCollectionResponse :: Int -> Text -> Text -> UTCTime -> CreateGeofenceCollectionResponse
- data CreateMap = CreateMap' (Maybe Text) (Maybe PricingPlan) (Maybe (HashMap Text Text)) MapConfiguration Text
- newCreateMap :: MapConfiguration -> Text -> CreateMap
- data CreateMapResponse = CreateMapResponse' Int ISO8601 Text Text
- newCreateMapResponse :: Int -> UTCTime -> Text -> Text -> CreateMapResponse
- data CreatePlaceIndex = CreatePlaceIndex' (Maybe DataSourceConfiguration) (Maybe Text) (Maybe PricingPlan) (Maybe (HashMap Text Text)) Text Text
- newCreatePlaceIndex :: Text -> Text -> CreatePlaceIndex
- data CreatePlaceIndexResponse = CreatePlaceIndexResponse' Int ISO8601 Text Text
- newCreatePlaceIndexResponse :: Int -> UTCTime -> Text -> Text -> CreatePlaceIndexResponse
- data CreateRouteCalculator = CreateRouteCalculator' (Maybe Text) (Maybe PricingPlan) (Maybe (HashMap Text Text)) Text Text
- newCreateRouteCalculator :: Text -> Text -> CreateRouteCalculator
- data CreateRouteCalculatorResponse = CreateRouteCalculatorResponse' Int Text Text ISO8601
- newCreateRouteCalculatorResponse :: Int -> Text -> Text -> UTCTime -> CreateRouteCalculatorResponse
- data CreateTracker = CreateTracker' (Maybe Text) (Maybe Text) (Maybe PositionFiltering) (Maybe PricingPlan) (Maybe Text) (Maybe (HashMap Text Text)) Text
- newCreateTracker :: Text -> CreateTracker
- data CreateTrackerResponse = CreateTrackerResponse' Int ISO8601 Text Text
- newCreateTrackerResponse :: Int -> UTCTime -> Text -> Text -> CreateTrackerResponse
- data DeleteGeofenceCollection = DeleteGeofenceCollection' Text
- newDeleteGeofenceCollection :: Text -> DeleteGeofenceCollection
- data DeleteGeofenceCollectionResponse = DeleteGeofenceCollectionResponse' Int
- newDeleteGeofenceCollectionResponse :: Int -> DeleteGeofenceCollectionResponse
- data DeleteMap = DeleteMap' Text
- newDeleteMap :: Text -> DeleteMap
- data DeleteMapResponse = DeleteMapResponse' Int
- newDeleteMapResponse :: Int -> DeleteMapResponse
- data DeletePlaceIndex = DeletePlaceIndex' Text
- newDeletePlaceIndex :: Text -> DeletePlaceIndex
- data DeletePlaceIndexResponse = DeletePlaceIndexResponse' Int
- newDeletePlaceIndexResponse :: Int -> DeletePlaceIndexResponse
- data DeleteRouteCalculator = DeleteRouteCalculator' Text
- newDeleteRouteCalculator :: Text -> DeleteRouteCalculator
- data DeleteRouteCalculatorResponse = DeleteRouteCalculatorResponse' Int
- newDeleteRouteCalculatorResponse :: Int -> DeleteRouteCalculatorResponse
- data DeleteTracker = DeleteTracker' Text
- newDeleteTracker :: Text -> DeleteTracker
- data DeleteTrackerResponse = DeleteTrackerResponse' Int
- newDeleteTrackerResponse :: Int -> DeleteTrackerResponse
- data DescribeGeofenceCollection = DescribeGeofenceCollection' Text
- newDescribeGeofenceCollection :: Text -> DescribeGeofenceCollection
- data DescribeGeofenceCollectionResponse = DescribeGeofenceCollectionResponse' (Maybe Text) (Maybe PricingPlan) (Maybe Text) (Maybe (HashMap Text Text)) Int Text Text ISO8601 Text ISO8601
- newDescribeGeofenceCollectionResponse :: Int -> Text -> Text -> UTCTime -> Text -> UTCTime -> DescribeGeofenceCollectionResponse
- data DescribeMap = DescribeMap' Text
- newDescribeMap :: Text -> DescribeMap
- data DescribeMapResponse = DescribeMapResponse' (Maybe PricingPlan) (Maybe (HashMap Text Text)) Int MapConfiguration ISO8601 Text Text Text Text ISO8601
- newDescribeMapResponse :: Int -> MapConfiguration -> UTCTime -> Text -> Text -> Text -> Text -> UTCTime -> DescribeMapResponse
- data DescribePlaceIndex = DescribePlaceIndex' Text
- newDescribePlaceIndex :: Text -> DescribePlaceIndex
- data DescribePlaceIndexResponse = DescribePlaceIndexResponse' (Maybe PricingPlan) (Maybe (HashMap Text Text)) Int ISO8601 Text DataSourceConfiguration Text Text Text ISO8601
- newDescribePlaceIndexResponse :: Int -> UTCTime -> Text -> DataSourceConfiguration -> Text -> Text -> Text -> UTCTime -> DescribePlaceIndexResponse
- data DescribeRouteCalculator = DescribeRouteCalculator' Text
- newDescribeRouteCalculator :: Text -> DescribeRouteCalculator
- data DescribeRouteCalculatorResponse = DescribeRouteCalculatorResponse' (Maybe PricingPlan) (Maybe (HashMap Text Text)) Int Text Text ISO8601 Text Text ISO8601
- newDescribeRouteCalculatorResponse :: Int -> Text -> Text -> UTCTime -> Text -> Text -> UTCTime -> DescribeRouteCalculatorResponse
- data DescribeTracker = DescribeTracker' Text
- newDescribeTracker :: Text -> DescribeTracker
- data DescribeTrackerResponse = DescribeTrackerResponse' (Maybe Text) (Maybe PositionFiltering) (Maybe PricingPlan) (Maybe Text) (Maybe (HashMap Text Text)) Int ISO8601 Text Text Text ISO8601
- newDescribeTrackerResponse :: Int -> UTCTime -> Text -> Text -> Text -> UTCTime -> DescribeTrackerResponse
- data DisassociateTrackerConsumer = DisassociateTrackerConsumer' Text Text
- newDisassociateTrackerConsumer :: Text -> Text -> DisassociateTrackerConsumer
- data DisassociateTrackerConsumerResponse = DisassociateTrackerConsumerResponse' Int
- newDisassociateTrackerConsumerResponse :: Int -> DisassociateTrackerConsumerResponse
- data GetDevicePosition = GetDevicePosition' Text Text
- newGetDevicePosition :: Text -> Text -> GetDevicePosition
- data GetDevicePositionResponse = GetDevicePositionResponse' (Maybe PositionalAccuracy) (Maybe Text) (Maybe (Sensitive (HashMap Text Text))) Int (Sensitive (NonEmpty Double)) ISO8601 ISO8601
- newGetDevicePositionResponse :: Int -> NonEmpty Double -> UTCTime -> UTCTime -> GetDevicePositionResponse
- data GetDevicePositionHistory = GetDevicePositionHistory' (Maybe ISO8601) (Maybe Natural) (Maybe Text) (Maybe ISO8601) Text Text
- newGetDevicePositionHistory :: Text -> Text -> GetDevicePositionHistory
- data GetDevicePositionHistoryResponse = GetDevicePositionHistoryResponse' (Maybe Text) Int [DevicePosition]
- newGetDevicePositionHistoryResponse :: Int -> GetDevicePositionHistoryResponse
- data GetGeofence = GetGeofence' Text Text
- newGetGeofence :: Text -> Text -> GetGeofence
- data GetGeofenceResponse = GetGeofenceResponse' Int ISO8601 Text GeofenceGeometry Text ISO8601
- newGetGeofenceResponse :: Int -> UTCTime -> Text -> GeofenceGeometry -> Text -> UTCTime -> GetGeofenceResponse
- data GetMapGlyphs = GetMapGlyphs' Text Text Text
- newGetMapGlyphs :: Text -> Text -> Text -> GetMapGlyphs
- data GetMapGlyphsResponse = GetMapGlyphsResponse' (Maybe ByteString) (Maybe Text) Int
- newGetMapGlyphsResponse :: Int -> GetMapGlyphsResponse
- data GetMapSprites = GetMapSprites' Text Text
- newGetMapSprites :: Text -> Text -> GetMapSprites
- data GetMapSpritesResponse = GetMapSpritesResponse' (Maybe ByteString) (Maybe Text) Int
- newGetMapSpritesResponse :: Int -> GetMapSpritesResponse
- data GetMapStyleDescriptor = GetMapStyleDescriptor' Text
- newGetMapStyleDescriptor :: Text -> GetMapStyleDescriptor
- data GetMapStyleDescriptorResponse = GetMapStyleDescriptorResponse' (Maybe ByteString) (Maybe Text) Int
- newGetMapStyleDescriptorResponse :: Int -> GetMapStyleDescriptorResponse
- data GetMapTile = GetMapTile' Text Text Text Text
- newGetMapTile :: Text -> Text -> Text -> Text -> GetMapTile
- data GetMapTileResponse = GetMapTileResponse' (Maybe ByteString) (Maybe Text) Int
- newGetMapTileResponse :: Int -> GetMapTileResponse
- data GetPlace = GetPlace' (Maybe Text) Text Text
- newGetPlace :: Text -> Text -> GetPlace
- data GetPlaceResponse = GetPlaceResponse' Int Place
- newGetPlaceResponse :: Int -> Place -> GetPlaceResponse
- data ListDevicePositions = ListDevicePositions' (Maybe Natural) (Maybe Text) Text
- newListDevicePositions :: Text -> ListDevicePositions
- data ListDevicePositionsResponse = ListDevicePositionsResponse' (Maybe Text) Int [ListDevicePositionsResponseEntry]
- newListDevicePositionsResponse :: Int -> ListDevicePositionsResponse
- data ListGeofenceCollections = ListGeofenceCollections' (Maybe Natural) (Maybe Text)
- newListGeofenceCollections :: ListGeofenceCollections
- data ListGeofenceCollectionsResponse = ListGeofenceCollectionsResponse' (Maybe Text) Int [ListGeofenceCollectionsResponseEntry]
- newListGeofenceCollectionsResponse :: Int -> ListGeofenceCollectionsResponse
- data ListGeofences = ListGeofences' (Maybe Natural) (Maybe Text) Text
- newListGeofences :: Text -> ListGeofences
- data ListGeofencesResponse = ListGeofencesResponse' (Maybe Text) Int [ListGeofenceResponseEntry]
- newListGeofencesResponse :: Int -> ListGeofencesResponse
- data ListMaps = ListMaps' (Maybe Natural) (Maybe Text)
- newListMaps :: ListMaps
- data ListMapsResponse = ListMapsResponse' (Maybe Text) Int [ListMapsResponseEntry]
- newListMapsResponse :: Int -> ListMapsResponse
- data ListPlaceIndexes = ListPlaceIndexes' (Maybe Natural) (Maybe Text)
- newListPlaceIndexes :: ListPlaceIndexes
- data ListPlaceIndexesResponse = ListPlaceIndexesResponse' (Maybe Text) Int [ListPlaceIndexesResponseEntry]
- newListPlaceIndexesResponse :: Int -> ListPlaceIndexesResponse
- data ListRouteCalculators = ListRouteCalculators' (Maybe Natural) (Maybe Text)
- newListRouteCalculators :: ListRouteCalculators
- data ListRouteCalculatorsResponse = ListRouteCalculatorsResponse' (Maybe Text) Int [ListRouteCalculatorsResponseEntry]
- newListRouteCalculatorsResponse :: Int -> ListRouteCalculatorsResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ListTrackerConsumers = ListTrackerConsumers' (Maybe Natural) (Maybe Text) Text
- newListTrackerConsumers :: Text -> ListTrackerConsumers
- data ListTrackerConsumersResponse = ListTrackerConsumersResponse' (Maybe Text) Int [Text]
- newListTrackerConsumersResponse :: Int -> ListTrackerConsumersResponse
- data ListTrackers = ListTrackers' (Maybe Natural) (Maybe Text)
- newListTrackers :: ListTrackers
- data ListTrackersResponse = ListTrackersResponse' (Maybe Text) Int [ListTrackersResponseEntry]
- newListTrackersResponse :: Int -> ListTrackersResponse
- data PutGeofence = PutGeofence' Text Text GeofenceGeometry
- newPutGeofence :: Text -> Text -> GeofenceGeometry -> PutGeofence
- data PutGeofenceResponse = PutGeofenceResponse' Int ISO8601 Text ISO8601
- newPutGeofenceResponse :: Int -> UTCTime -> Text -> UTCTime -> PutGeofenceResponse
- data SearchPlaceIndexForPosition = SearchPlaceIndexForPosition' (Maybe Text) (Maybe Natural) Text (Sensitive (NonEmpty Double))
- newSearchPlaceIndexForPosition :: Text -> NonEmpty Double -> SearchPlaceIndexForPosition
- data SearchPlaceIndexForPositionResponse = SearchPlaceIndexForPositionResponse' Int [SearchForPositionResult] SearchPlaceIndexForPositionSummary
- newSearchPlaceIndexForPositionResponse :: Int -> SearchPlaceIndexForPositionSummary -> SearchPlaceIndexForPositionResponse
- data SearchPlaceIndexForSuggestions = SearchPlaceIndexForSuggestions' (Maybe (Sensitive (NonEmpty Double))) (Maybe (Sensitive (NonEmpty Double))) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Natural) Text (Sensitive Text)
- newSearchPlaceIndexForSuggestions :: Text -> Text -> SearchPlaceIndexForSuggestions
- data SearchPlaceIndexForSuggestionsResponse = SearchPlaceIndexForSuggestionsResponse' Int [SearchForSuggestionsResult] SearchPlaceIndexForSuggestionsSummary
- newSearchPlaceIndexForSuggestionsResponse :: Int -> SearchPlaceIndexForSuggestionsSummary -> SearchPlaceIndexForSuggestionsResponse
- data SearchPlaceIndexForText = SearchPlaceIndexForText' (Maybe (Sensitive (NonEmpty Double))) (Maybe (Sensitive (NonEmpty Double))) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Natural) Text (Sensitive Text)
- newSearchPlaceIndexForText :: Text -> Text -> SearchPlaceIndexForText
- data SearchPlaceIndexForTextResponse = SearchPlaceIndexForTextResponse' Int [SearchForTextResult] SearchPlaceIndexForTextSummary
- newSearchPlaceIndexForTextResponse :: Int -> SearchPlaceIndexForTextSummary -> SearchPlaceIndexForTextResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text (NonEmpty Text)
- newUntagResource :: Text -> NonEmpty Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateGeofenceCollection = UpdateGeofenceCollection' (Maybe Text) (Maybe PricingPlan) (Maybe Text) Text
- newUpdateGeofenceCollection :: Text -> UpdateGeofenceCollection
- data UpdateGeofenceCollectionResponse = UpdateGeofenceCollectionResponse' Int Text Text ISO8601
- newUpdateGeofenceCollectionResponse :: Int -> Text -> Text -> UTCTime -> UpdateGeofenceCollectionResponse
- data UpdateMap = UpdateMap' (Maybe Text) (Maybe PricingPlan) Text
- newUpdateMap :: Text -> UpdateMap
- data UpdateMapResponse = UpdateMapResponse' Int Text Text ISO8601
- newUpdateMapResponse :: Int -> Text -> Text -> UTCTime -> UpdateMapResponse
- data UpdatePlaceIndex = UpdatePlaceIndex' (Maybe DataSourceConfiguration) (Maybe Text) (Maybe PricingPlan) Text
- newUpdatePlaceIndex :: Text -> UpdatePlaceIndex
- data UpdatePlaceIndexResponse = UpdatePlaceIndexResponse' Int Text Text ISO8601
- newUpdatePlaceIndexResponse :: Int -> Text -> Text -> UTCTime -> UpdatePlaceIndexResponse
- data UpdateRouteCalculator = UpdateRouteCalculator' (Maybe Text) (Maybe PricingPlan) Text
- newUpdateRouteCalculator :: Text -> UpdateRouteCalculator
- data UpdateRouteCalculatorResponse = UpdateRouteCalculatorResponse' Int Text Text ISO8601
- newUpdateRouteCalculatorResponse :: Int -> Text -> Text -> UTCTime -> UpdateRouteCalculatorResponse
- data UpdateTracker = UpdateTracker' (Maybe Text) (Maybe PositionFiltering) (Maybe PricingPlan) (Maybe Text) Text
- newUpdateTracker :: Text -> UpdateTracker
- data UpdateTrackerResponse = UpdateTrackerResponse' Int Text Text ISO8601
- newUpdateTrackerResponse :: Int -> Text -> Text -> UTCTime -> UpdateTrackerResponse
- 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' Text BatchItemError
- newBatchDeleteDevicePositionHistoryError :: Text -> BatchItemError -> BatchDeleteDevicePositionHistoryError
- data BatchDeleteGeofenceError = BatchDeleteGeofenceError' BatchItemError Text
- newBatchDeleteGeofenceError :: BatchItemError -> Text -> BatchDeleteGeofenceError
- data BatchEvaluateGeofencesError = BatchEvaluateGeofencesError' Text BatchItemError ISO8601
- newBatchEvaluateGeofencesError :: Text -> BatchItemError -> UTCTime -> BatchEvaluateGeofencesError
- data BatchGetDevicePositionError = BatchGetDevicePositionError' Text BatchItemError
- newBatchGetDevicePositionError :: Text -> BatchItemError -> BatchGetDevicePositionError
- data BatchItemError = BatchItemError' (Maybe BatchItemErrorCode) (Maybe Text)
- newBatchItemError :: BatchItemError
- data BatchPutGeofenceError = BatchPutGeofenceError' BatchItemError Text
- newBatchPutGeofenceError :: BatchItemError -> Text -> BatchPutGeofenceError
- data BatchPutGeofenceRequestEntry = BatchPutGeofenceRequestEntry' Text GeofenceGeometry
- newBatchPutGeofenceRequestEntry :: Text -> GeofenceGeometry -> BatchPutGeofenceRequestEntry
- data BatchPutGeofenceSuccess = BatchPutGeofenceSuccess' ISO8601 Text ISO8601
- newBatchPutGeofenceSuccess :: UTCTime -> Text -> UTCTime -> BatchPutGeofenceSuccess
- data BatchUpdateDevicePositionError = BatchUpdateDevicePositionError' Text BatchItemError ISO8601
- newBatchUpdateDevicePositionError :: Text -> BatchItemError -> UTCTime -> BatchUpdateDevicePositionError
- data CalculateRouteCarModeOptions = CalculateRouteCarModeOptions' (Maybe Bool) (Maybe Bool)
- newCalculateRouteCarModeOptions :: CalculateRouteCarModeOptions
- data CalculateRouteMatrixSummary = CalculateRouteMatrixSummary' Text DistanceUnit Natural Natural
- newCalculateRouteMatrixSummary :: Text -> DistanceUnit -> Natural -> Natural -> CalculateRouteMatrixSummary
- data CalculateRouteSummary = CalculateRouteSummary' Text Double DistanceUnit Double (Sensitive (NonEmpty Double))
- newCalculateRouteSummary :: Text -> Double -> DistanceUnit -> Double -> NonEmpty Double -> CalculateRouteSummary
- data CalculateRouteTruckModeOptions = CalculateRouteTruckModeOptions' (Maybe Bool) (Maybe Bool) (Maybe TruckDimensions) (Maybe TruckWeight)
- newCalculateRouteTruckModeOptions :: CalculateRouteTruckModeOptions
- data Circle = Circle' (Sensitive (NonEmpty Double)) Double
- newCircle :: NonEmpty Double -> Double -> Circle
- data DataSourceConfiguration = DataSourceConfiguration' (Maybe IntendedUse)
- newDataSourceConfiguration :: DataSourceConfiguration
- data DevicePosition = DevicePosition' (Maybe PositionalAccuracy) (Maybe Text) (Maybe (Sensitive (HashMap Text Text))) (Sensitive (NonEmpty Double)) ISO8601 ISO8601
- newDevicePosition :: NonEmpty Double -> UTCTime -> UTCTime -> DevicePosition
- data DevicePositionUpdate = DevicePositionUpdate' (Maybe PositionalAccuracy) (Maybe (Sensitive (HashMap Text Text))) Text (Sensitive (NonEmpty Double)) ISO8601
- newDevicePositionUpdate :: Text -> NonEmpty Double -> UTCTime -> DevicePositionUpdate
- data GeofenceGeometry = GeofenceGeometry' (Maybe (Sensitive Circle)) (Maybe (NonEmpty (NonEmpty (Sensitive (NonEmpty Double)))))
- newGeofenceGeometry :: GeofenceGeometry
- data Leg = Leg' (Maybe LegGeometry) Double Double (Sensitive (NonEmpty Double)) (Sensitive (NonEmpty Double)) [Step]
- newLeg :: Double -> Double -> NonEmpty Double -> NonEmpty Double -> Leg
- data LegGeometry = LegGeometry' (Maybe (NonEmpty (Sensitive (NonEmpty Double))))
- newLegGeometry :: LegGeometry
- data ListDevicePositionsResponseEntry = ListDevicePositionsResponseEntry' (Maybe PositionalAccuracy) (Maybe (Sensitive (HashMap Text Text))) Text (Sensitive (NonEmpty Double)) ISO8601
- newListDevicePositionsResponseEntry :: Text -> NonEmpty Double -> UTCTime -> ListDevicePositionsResponseEntry
- data ListGeofenceCollectionsResponseEntry = ListGeofenceCollectionsResponseEntry' (Maybe PricingPlan) (Maybe Text) Text ISO8601 Text ISO8601
- newListGeofenceCollectionsResponseEntry :: Text -> UTCTime -> Text -> UTCTime -> ListGeofenceCollectionsResponseEntry
- data ListGeofenceResponseEntry = ListGeofenceResponseEntry' ISO8601 Text GeofenceGeometry Text ISO8601
- newListGeofenceResponseEntry :: UTCTime -> Text -> GeofenceGeometry -> Text -> UTCTime -> ListGeofenceResponseEntry
- data ListMapsResponseEntry = ListMapsResponseEntry' (Maybe PricingPlan) ISO8601 Text Text Text ISO8601
- newListMapsResponseEntry :: UTCTime -> Text -> Text -> Text -> UTCTime -> ListMapsResponseEntry
- data ListPlaceIndexesResponseEntry = ListPlaceIndexesResponseEntry' (Maybe PricingPlan) ISO8601 Text Text Text ISO8601
- newListPlaceIndexesResponseEntry :: UTCTime -> Text -> Text -> Text -> UTCTime -> ListPlaceIndexesResponseEntry
- data ListRouteCalculatorsResponseEntry = ListRouteCalculatorsResponseEntry' (Maybe PricingPlan) Text ISO8601 Text Text ISO8601
- newListRouteCalculatorsResponseEntry :: Text -> UTCTime -> Text -> Text -> UTCTime -> ListRouteCalculatorsResponseEntry
- data ListTrackersResponseEntry = ListTrackersResponseEntry' (Maybe PricingPlan) (Maybe Text) ISO8601 Text Text ISO8601
- newListTrackersResponseEntry :: UTCTime -> Text -> Text -> UTCTime -> ListTrackersResponseEntry
- data MapConfiguration = MapConfiguration' Text
- newMapConfiguration :: Text -> MapConfiguration
- data Place = Place' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe TimeZone) (Maybe Text) (Maybe Text) PlaceGeometry
- newPlace :: PlaceGeometry -> Place
- data PlaceGeometry = PlaceGeometry' (Maybe (Sensitive (NonEmpty Double)))
- newPlaceGeometry :: PlaceGeometry
- data PositionalAccuracy = PositionalAccuracy' Double
- newPositionalAccuracy :: Double -> PositionalAccuracy
- data RouteMatrixEntry = RouteMatrixEntry' (Maybe Double) (Maybe Double) (Maybe RouteMatrixEntryError)
- newRouteMatrixEntry :: RouteMatrixEntry
- data RouteMatrixEntryError = RouteMatrixEntryError' (Maybe Text) RouteMatrixErrorCode
- newRouteMatrixEntryError :: RouteMatrixErrorCode -> RouteMatrixEntryError
- data SearchForPositionResult = SearchForPositionResult' (Maybe Text) Double Place
- newSearchForPositionResult :: Double -> Place -> SearchForPositionResult
- data SearchForSuggestionsResult = SearchForSuggestionsResult' (Maybe Text) Text
- newSearchForSuggestionsResult :: Text -> SearchForSuggestionsResult
- data SearchForTextResult = SearchForTextResult' (Maybe Double) (Maybe Text) (Maybe Double) Place
- newSearchForTextResult :: Place -> SearchForTextResult
- data SearchPlaceIndexForPositionSummary = SearchPlaceIndexForPositionSummary' (Maybe Text) (Maybe Natural) Text (Sensitive (NonEmpty Double))
- newSearchPlaceIndexForPositionSummary :: Text -> NonEmpty Double -> SearchPlaceIndexForPositionSummary
- data SearchPlaceIndexForSuggestionsSummary = SearchPlaceIndexForSuggestionsSummary' (Maybe (Sensitive (NonEmpty Double))) (Maybe (Sensitive (NonEmpty Double))) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Int) Text (Sensitive Text)
- newSearchPlaceIndexForSuggestionsSummary :: Text -> Text -> SearchPlaceIndexForSuggestionsSummary
- data SearchPlaceIndexForTextSummary = SearchPlaceIndexForTextSummary' (Maybe (Sensitive (NonEmpty Double))) (Maybe (Sensitive (NonEmpty Double))) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Natural) (Maybe (Sensitive (NonEmpty Double))) Text (Sensitive Text)
- newSearchPlaceIndexForTextSummary :: Text -> Text -> SearchPlaceIndexForTextSummary
- data Step = Step' (Maybe Natural) Double Double (Sensitive (NonEmpty Double)) (Sensitive (NonEmpty Double))
- newStep :: Double -> Double -> NonEmpty Double -> NonEmpty Double -> Step
- data TimeZone = TimeZone' (Maybe Int) Text
- newTimeZone :: Text -> TimeZone
- data TruckDimensions = TruckDimensions' (Maybe Double) (Maybe Double) (Maybe DimensionUnit) (Maybe Double)
- newTruckDimensions :: TruckDimensions
- data TruckWeight = TruckWeight' (Maybe Double) (Maybe VehicleWeightUnit)
- newTruckWeight :: TruckWeight
Service Configuration
defaultService :: Service Source #
API version 2020-11-19 of the Amazon Location Service SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Location.
AccessDeniedException
_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
_ConflictException :: AsError a => Fold a ServiceError Source #
The request was unsuccessful because of a conflict.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The resource that you've entered was not found in your AWS account.
ServiceQuotaExceededException
_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
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request was denied because of request throttling.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
The input failed to meet the constraints specified by the AWS service.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
AssociateTrackerConsumer
data AssociateTrackerConsumer Source #
See: newAssociateTrackerConsumer smart constructor.
Constructors
| AssociateTrackerConsumer' Text Text |
Instances
newAssociateTrackerConsumer Source #
Arguments
| :: Text | |
| -> Text | |
| -> AssociateTrackerConsumer |
Create a value of AssociateTrackerConsumer 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:consumerArn:AssociateTrackerConsumer', associateTrackerConsumer_consumerArn - The Amazon Resource Name (ARN) for the geofence collection to be
associated to tracker resource. Used when you need to specify a resource
across all AWS.
- Format example:
arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer
AssociateTrackerConsumer, associateTrackerConsumer_trackerName - The name of the tracker resource to be associated with a geofence
collection.
data AssociateTrackerConsumerResponse Source #
See: newAssociateTrackerConsumerResponse smart constructor.
Constructors
| AssociateTrackerConsumerResponse' Int |
Instances
newAssociateTrackerConsumerResponse Source #
Create a value of AssociateTrackerConsumerResponse 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:httpStatus:AssociateTrackerConsumerResponse', associateTrackerConsumerResponse_httpStatus - The response's http status code.
BatchDeleteDevicePositionHistory
data BatchDeleteDevicePositionHistory Source #
See: newBatchDeleteDevicePositionHistory smart constructor.
Constructors
| BatchDeleteDevicePositionHistory' (NonEmpty Text) Text |
Instances
newBatchDeleteDevicePositionHistory Source #
Arguments
| :: NonEmpty Text | |
| -> Text | |
| -> BatchDeleteDevicePositionHistory |
Create a value of BatchDeleteDevicePositionHistory 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:deviceIds:BatchDeleteDevicePositionHistory', batchDeleteDevicePositionHistory_deviceIds - Devices whose position history you want to delete.
- For example, for two devices:
“DeviceIds” : [DeviceId1,DeviceId2]
BatchDeleteDevicePositionHistory, batchDeleteDevicePositionHistory_trackerName - The name of the tracker resource to delete the device position history
from.
data BatchDeleteDevicePositionHistoryResponse Source #
See: newBatchDeleteDevicePositionHistoryResponse smart constructor.
Instances
newBatchDeleteDevicePositionHistoryResponse Source #
Arguments
| :: Int | |
| -> BatchDeleteDevicePositionHistoryResponse |
Create a value of BatchDeleteDevicePositionHistoryResponse 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:httpStatus:BatchDeleteDevicePositionHistoryResponse', batchDeleteDevicePositionHistoryResponse_httpStatus - The response's http status code.
$sel:errors:BatchDeleteDevicePositionHistoryResponse', batchDeleteDevicePositionHistoryResponse_errors - Contains error details for each device history that failed to delete.
BatchDeleteGeofence
data BatchDeleteGeofence Source #
See: newBatchDeleteGeofence smart constructor.
Constructors
| BatchDeleteGeofence' Text (NonEmpty Text) |
Instances
newBatchDeleteGeofence Source #
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> BatchDeleteGeofence |
Create a value of BatchDeleteGeofence 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:
BatchDeleteGeofence, batchDeleteGeofence_collectionName - The geofence collection storing the geofences to be deleted.
$sel:geofenceIds:BatchDeleteGeofence', batchDeleteGeofence_geofenceIds - The batch of geofences to be deleted.
data BatchDeleteGeofenceResponse Source #
See: newBatchDeleteGeofenceResponse smart constructor.
Constructors
| BatchDeleteGeofenceResponse' Int [BatchDeleteGeofenceError] |
Instances
newBatchDeleteGeofenceResponse Source #
Create a value of BatchDeleteGeofenceResponse 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:httpStatus:BatchDeleteGeofenceResponse', batchDeleteGeofenceResponse_httpStatus - The response's http status code.
$sel:errors:BatchDeleteGeofenceResponse', batchDeleteGeofenceResponse_errors - Contains error details for each geofence that failed to delete.
BatchEvaluateGeofences
data BatchEvaluateGeofences Source #
See: newBatchEvaluateGeofences smart constructor.
Constructors
| BatchEvaluateGeofences' Text (NonEmpty DevicePositionUpdate) |
Instances
newBatchEvaluateGeofences Source #
Arguments
| :: Text | |
| -> NonEmpty DevicePositionUpdate | |
| -> BatchEvaluateGeofences |
Create a value of BatchEvaluateGeofences 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:
BatchEvaluateGeofences, batchEvaluateGeofences_collectionName - The geofence collection used in evaluating the position of devices
against its geofences.
$sel:devicePositionUpdates:BatchEvaluateGeofences', batchEvaluateGeofences_devicePositionUpdates - Contains device details for each device to be evaluated against the
given geofence collection.
data BatchEvaluateGeofencesResponse Source #
See: newBatchEvaluateGeofencesResponse smart constructor.
Constructors
| BatchEvaluateGeofencesResponse' Int [BatchEvaluateGeofencesError] |
Instances
newBatchEvaluateGeofencesResponse Source #
Create a value of BatchEvaluateGeofencesResponse 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:httpStatus:BatchEvaluateGeofencesResponse', batchEvaluateGeofencesResponse_httpStatus - The response's http status code.
$sel:errors:BatchEvaluateGeofencesResponse', batchEvaluateGeofencesResponse_errors - Contains error details for each device that failed to evaluate its
position against the given geofence collection.
BatchGetDevicePosition
data BatchGetDevicePosition Source #
See: newBatchGetDevicePosition smart constructor.
Constructors
| BatchGetDevicePosition' (NonEmpty Text) Text |
Instances
newBatchGetDevicePosition Source #
Arguments
| :: NonEmpty Text | |
| -> Text | |
| -> BatchGetDevicePosition |
Create a value of BatchGetDevicePosition 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:deviceIds:BatchGetDevicePosition', batchGetDevicePosition_deviceIds - Devices whose position you want to retrieve.
- For example, for two devices:
device-ids=DeviceId1&device-ids=DeviceId2
BatchGetDevicePosition, batchGetDevicePosition_trackerName - The tracker resource retrieving the device position.
data BatchGetDevicePositionResponse Source #
See: newBatchGetDevicePositionResponse smart constructor.
Constructors
| BatchGetDevicePositionResponse' Int [DevicePosition] [BatchGetDevicePositionError] |
Instances
newBatchGetDevicePositionResponse Source #
Create a value of BatchGetDevicePositionResponse 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:httpStatus:BatchGetDevicePositionResponse', batchGetDevicePositionResponse_httpStatus - The response's http status code.
$sel:devicePositions:BatchGetDevicePositionResponse', batchGetDevicePositionResponse_devicePositions - Contains device position details such as the device ID, position, and
timestamps for when the position was received and sampled.
$sel:errors:BatchGetDevicePositionResponse', batchGetDevicePositionResponse_errors - Contains error details for each device that failed to send its position
to the tracker resource.
BatchPutGeofence
data BatchPutGeofence Source #
See: newBatchPutGeofence smart constructor.
Constructors
| BatchPutGeofence' Text (NonEmpty BatchPutGeofenceRequestEntry) |
Instances
Arguments
| :: Text | |
| -> NonEmpty BatchPutGeofenceRequestEntry | |
| -> BatchPutGeofence |
Create a value of BatchPutGeofence 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:
BatchPutGeofence, batchPutGeofence_collectionName - The geofence collection storing the geofences.
$sel:entries:BatchPutGeofence', batchPutGeofence_entries - The batch of geofences to be stored in a geofence collection.
data BatchPutGeofenceResponse Source #
See: newBatchPutGeofenceResponse smart constructor.
Constructors
| BatchPutGeofenceResponse' Int [BatchPutGeofenceError] [BatchPutGeofenceSuccess] |
Instances
newBatchPutGeofenceResponse Source #
Create a value of BatchPutGeofenceResponse 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:httpStatus:BatchPutGeofenceResponse', batchPutGeofenceResponse_httpStatus - The response's http status code.
$sel:errors:BatchPutGeofenceResponse', batchPutGeofenceResponse_errors - Contains additional error details for each geofence that failed to be
stored in a geofence collection.
$sel:successes:BatchPutGeofenceResponse', batchPutGeofenceResponse_successes - Contains each geofence that was successfully stored in a geofence
collection.
BatchUpdateDevicePosition
data BatchUpdateDevicePosition Source #
See: newBatchUpdateDevicePosition smart constructor.
Constructors
| BatchUpdateDevicePosition' Text (NonEmpty DevicePositionUpdate) |
Instances
newBatchUpdateDevicePosition Source #
Arguments
| :: Text | |
| -> NonEmpty DevicePositionUpdate | |
| -> BatchUpdateDevicePosition |
Create a value of BatchUpdateDevicePosition 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:
BatchUpdateDevicePosition, batchUpdateDevicePosition_trackerName - The name of the tracker resource to update.
$sel:updates:BatchUpdateDevicePosition', batchUpdateDevicePosition_updates - Contains the position update details for each device.
data BatchUpdateDevicePositionResponse Source #
See: newBatchUpdateDevicePositionResponse smart constructor.
Instances
newBatchUpdateDevicePositionResponse Source #
Arguments
| :: Int | |
| -> BatchUpdateDevicePositionResponse |
Create a value of BatchUpdateDevicePositionResponse 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:httpStatus:BatchUpdateDevicePositionResponse', batchUpdateDevicePositionResponse_httpStatus - The response's http status code.
$sel:errors:BatchUpdateDevicePositionResponse', batchUpdateDevicePositionResponse_errors - Contains error details for each device that failed to update its
position.
CalculateRoute
data CalculateRoute Source #
See: newCalculateRoute smart constructor.
Constructors
Instances
Create a value of CalculateRoute 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:carModeOptions:CalculateRoute', calculateRoute_carModeOptions - Specifies route preferences when traveling by Car, such as avoiding
routes that use ferries or tolls.
Requirements: TravelMode must be specified as Car.
$sel:departNow:CalculateRoute', calculateRoute_departNow - Sets the time of departure as the current time. Uses the current time to
calculate a route. Otherwise, the best time of day to travel with the
best traffic conditions is used to calculate the route.
Default Value: false
Valid Values: false | true
$sel:departureTime:CalculateRoute', calculateRoute_departureTime - Specifies the desired time of departure. Uses the given time to
calculate the route. Otherwise, the best time of day to travel with the
best traffic conditions is used to calculate the route.
Setting a departure time in the past returns a 400 ValidationException
error.
- In ISO 8601
format:
YYYY-MM-DDThh:mm:ss.sssZ. For example,2020–07-2T12:15:20.000Z+01:00
CalculateRoute, calculateRoute_distanceUnit - Set the unit system to specify the distance.
Default Value: Kilometers
$sel:includeLegGeometry:CalculateRoute', calculateRoute_includeLegGeometry - Set to include the geometry details in the result for each path between
a pair of positions.
Default Value: false
Valid Values: false | true
$sel:travelMode:CalculateRoute', calculateRoute_travelMode - Specifies the mode of transport when calculating a route. Used in
estimating the speed of travel and road compatibility. You can choose
Car, Truck, or Walking as options for the TravelMode.
The TravelMode you specify also determines how you specify route
preferences:
- If traveling by
Caruse theCarModeOptionsparameter. - If traveling by
Truckuse theTruckModeOptionsparameter.
Default Value: Car
$sel:truckModeOptions:CalculateRoute', calculateRoute_truckModeOptions - Specifies route preferences when traveling by Truck, such as avoiding
routes that use ferries or tolls, and truck specifications to consider
when choosing an optimal road.
Requirements: TravelMode must be specified as Truck.
$sel:waypointPositions:CalculateRoute', calculateRoute_waypointPositions - Specifies an ordered list of up to 23 intermediate positions to include
along a route between the departure position and destination position.
- For example, from the
DeparturePosition[-123.115, 49.285], the route follows the order that the waypoint positions are given[[-122.757, 49.0021],[-122.349, 47.620]]
If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.
Specifying more than 23 waypoints returns a 400 ValidationException
error.
If Esri is the provider for your route calculator, specifying a route
that is longer than 400 km returns a 400 RoutesValidationException
error.
Valid Values: [-180 to 180,-90 to 90]
CalculateRoute, calculateRoute_calculatorName - The name of the route calculator resource that you want to use to
calculate the route.
$sel:departurePosition:CalculateRoute', calculateRoute_departurePosition - The start position for the route. Defined in
World Geodetic System (WGS 84)
format: [longitude, latitude].
- For example,
[-123.115, 49.285]
If you specify a departure that's not located on a road, Amazon
Location
moves the position to the nearest road.
If Esri is the provider for your route calculator, specifying a route
that is longer than 400 km returns a 400 RoutesValidationException
error.
Valid Values: [-180 to 180,-90 to 90]
$sel:destinationPosition:CalculateRoute', calculateRoute_destinationPosition - The finish position for the route. Defined in
World Geodetic System (WGS 84)
format: [longitude, latitude].
- For example,
[-122.339, 47.615]
If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.
Valid Values: [-180 to 180,-90 to 90]
data CalculateRouteResponse Source #
Returns the result of the route calculation. Metadata includes legs and route summary.
See: newCalculateRouteResponse smart constructor.
Constructors
| CalculateRouteResponse' Int [Leg] CalculateRouteSummary |
Instances
newCalculateRouteResponse Source #
Arguments
| :: Int | |
| -> CalculateRouteSummary | |
| -> CalculateRouteResponse |
Create a value of CalculateRouteResponse 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:httpStatus:CalculateRouteResponse', calculateRouteResponse_httpStatus - The response's http status code.
$sel:legs:CalculateRouteResponse', calculateRouteResponse_legs - Contains details about each path between a pair of positions included
along a route such as: StartPosition, EndPosition, Distance,
DurationSeconds, Geometry, and Steps. 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.
$sel:summary:CalculateRouteResponse', calculateRouteResponse_summary - Contains information about the whole route, such as: RouteBBox,
DataSource, Distance, DistanceUnit, and DurationSeconds.
CalculateRouteMatrix
data CalculateRouteMatrix Source #
See: newCalculateRouteMatrix smart constructor.
Constructors
Instances
newCalculateRouteMatrix Source #
Create a value of CalculateRouteMatrix 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:carModeOptions:CalculateRouteMatrix', calculateRouteMatrix_carModeOptions - Specifies route preferences when traveling by Car, such as avoiding
routes that use ferries or tolls.
Requirements: TravelMode must be specified as Car.
$sel:departNow:CalculateRouteMatrix', calculateRouteMatrix_departNow - Sets the time of departure as the current time. Uses the current time to
calculate the route matrix. You can't set both DepartureTime and
DepartNow. If neither is set, the best time of day to travel with the
best traffic conditions is used to calculate the route matrix.
Default Value: false
Valid Values: false | true
$sel:departureTime:CalculateRouteMatrix', calculateRouteMatrix_departureTime - Specifies the desired time of departure. Uses the given time to
calculate the route matrix. You can't set both DepartureTime and
DepartNow. If neither is set, the best time of day to travel with the
best traffic conditions is used to calculate the route matrix.
Setting a departure time in the past returns a 400 ValidationException
error.
- In ISO 8601
format:
YYYY-MM-DDThh:mm:ss.sssZ. For example,2020–07-2T12:15:20.000Z+01:00
CalculateRouteMatrix, calculateRouteMatrix_distanceUnit - Set the unit system to specify the distance.
Default Value: Kilometers
$sel:travelMode:CalculateRouteMatrix', calculateRouteMatrix_travelMode - Specifies the mode of transport when calculating a route. Used in
estimating the speed of travel and road compatibility.
The TravelMode you specify also determines how you specify route
preferences:
- If traveling by
Caruse theCarModeOptionsparameter. - If traveling by
Truckuse theTruckModeOptionsparameter.
Default Value: Car
$sel:truckModeOptions:CalculateRouteMatrix', calculateRouteMatrix_truckModeOptions - Specifies route preferences when traveling by Truck, such as avoiding
routes that use ferries or tolls, and truck specifications to consider
when choosing an optimal road.
Requirements: TravelMode must be specified as Truck.
CalculateRouteMatrix, calculateRouteMatrix_calculatorName - The name of the route calculator resource that you want to use to
calculate the route matrix.
$sel:departurePositions:CalculateRouteMatrix', calculateRouteMatrix_departurePositions - The list of departure (origin) positions for the route matrix. An array
of points, each of which is itself a 2-value array defined in
WGS 84 format:
[longitude, latitude]. For example, [-123.115, 49.285].
Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.
For route calculators that use Esri as the data provider, if you specify
a departure that's not located on a road, Amazon Location
moves the position to the nearest road.
The snapped value is available in the result in
SnappedDeparturePositions.
Valid Values: [-180 to 180,-90 to 90]
$sel:destinationPositions:CalculateRouteMatrix', calculateRouteMatrix_destinationPositions - The list of destination positions for the route matrix. An array of
points, each of which is itself a 2-value array defined in
WGS 84 format:
[longitude, latitude]. For example, [-122.339, 47.615]
Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.
For route calculators that use Esri as the data provider, if you specify
a destination that's not located on a road, Amazon Location
moves the position to the nearest road.
The snapped value is available in the result in
SnappedDestinationPositions.
Valid Values: [-180 to 180,-90 to 90]
data CalculateRouteMatrixResponse Source #
Returns the result of the route matrix calculation.
See: newCalculateRouteMatrixResponse smart constructor.
Constructors
| CalculateRouteMatrixResponse' (Maybe (NonEmpty (Sensitive (NonEmpty Double)))) (Maybe (NonEmpty (Sensitive (NonEmpty Double)))) Int [[RouteMatrixEntry]] CalculateRouteMatrixSummary |
Instances
newCalculateRouteMatrixResponse Source #
Arguments
| :: Int | |
| -> CalculateRouteMatrixSummary | |
| -> CalculateRouteMatrixResponse |
Create a value of CalculateRouteMatrixResponse 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:snappedDeparturePositions:CalculateRouteMatrixResponse', calculateRouteMatrixResponse_snappedDeparturePositions - For routes calculated using an Esri route calculator resource, departure
positions are snapped to the closest road. For Esri route calculator
resources, this returns the list of departure/origin positions used for
calculation of the RouteMatrix.
$sel:snappedDestinationPositions:CalculateRouteMatrixResponse', calculateRouteMatrixResponse_snappedDestinationPositions - The list of destination positions for the route matrix used for
calculation of the RouteMatrix.
$sel:httpStatus:CalculateRouteMatrixResponse', calculateRouteMatrixResponse_httpStatus - The response's http status code.
$sel:routeMatrix:CalculateRouteMatrixResponse', calculateRouteMatrixResponse_routeMatrix - The calculated route matrix containing the results for all pairs of
DeparturePositions to DestinationPositions. Each row corresponds to
one entry in DeparturePositions. Each entry in the row corresponds to
the route from that entry in DeparturePositions to an entry in
DestinationPositions.
$sel:summary:CalculateRouteMatrixResponse', calculateRouteMatrixResponse_summary - Contains information about the route matrix, DataSource,
DistanceUnit, RouteCount and ErrorCount.
CreateGeofenceCollection
data CreateGeofenceCollection Source #
See: newCreateGeofenceCollection smart constructor.
Constructors
| CreateGeofenceCollection' (Maybe Text) (Maybe Text) (Maybe PricingPlan) (Maybe Text) (Maybe (HashMap Text Text)) Text |
Instances
newCreateGeofenceCollection Source #
Arguments
| :: Text | |
| -> CreateGeofenceCollection |
Create a value of CreateGeofenceCollection 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:
CreateGeofenceCollection, createGeofenceCollection_description - An optional description for the geofence collection.
$sel:kmsKeyId:CreateGeofenceCollection', createGeofenceCollection_kmsKeyId - A key identifier for an
AWS KMS customer managed key.
Enter a key ID, key ARN, alias name, or alias ARN.
CreateGeofenceCollection, createGeofenceCollection_pricingPlan - No longer used. If included, the only allowed value is
RequestBasedUsage.
CreateGeofenceCollection, createGeofenceCollection_pricingPlanDataSource - This parameter is no longer used.
$sel:tags:CreateGeofenceCollection', createGeofenceCollection_tags - Applies one or more tags to the geofence collection. A tag is a
key-value pair helps manage, identify, search, and filter your resources
by labelling them.
Format: "key" : "value"
Restrictions:
- Maximum 50 tags per resource
- Each resource tag must be unique with a maximum of one value.
- Maximum key length: 128 Unicode characters in UTF-8
- Maximum value length: 256 Unicode characters in UTF-8
- Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
- Cannot use "aws:" as a prefix for a key.
CreateGeofenceCollection, createGeofenceCollection_collectionName - A custom name for the geofence collection.
Requirements:
- Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
- Must be a unique geofence collection name.
- No spaces allowed. For example,
ExampleGeofenceCollection.
data CreateGeofenceCollectionResponse Source #
See: newCreateGeofenceCollectionResponse smart constructor.
Constructors
| CreateGeofenceCollectionResponse' Int Text Text ISO8601 |
Instances
newCreateGeofenceCollectionResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> UTCTime | |
| -> CreateGeofenceCollectionResponse |
Create a value of CreateGeofenceCollectionResponse 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:httpStatus:CreateGeofenceCollectionResponse', createGeofenceCollectionResponse_httpStatus - The response's http status code.
$sel:collectionArn:CreateGeofenceCollectionResponse', createGeofenceCollectionResponse_collectionArn - The Amazon Resource Name (ARN) for the geofence collection resource.
Used when you need to specify a resource across all AWS.
- Format example:
arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection
CreateGeofenceCollection, createGeofenceCollectionResponse_collectionName - The name for the geofence collection.
CreateGeofenceCollectionResponse, createGeofenceCollectionResponse_createTime - The timestamp for when the geofence collection was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
CreateMap
See: newCreateMap smart constructor.
Constructors
| CreateMap' (Maybe Text) (Maybe PricingPlan) (Maybe (HashMap Text Text)) MapConfiguration Text |
Instances
Arguments
| :: MapConfiguration | |
| -> Text | |
| -> CreateMap |
Create a value of CreateMap 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:
CreateMap, createMap_description - An optional description for the map resource.
CreateMap, createMap_pricingPlan - No longer used. If included, the only allowed value is
RequestBasedUsage.
$sel:tags:CreateMap', createMap_tags - Applies one or more tags to the map resource. A tag is a key-value pair
helps manage, identify, search, and filter your resources by labelling
them.
Format: "key" : "value"
Restrictions:
- Maximum 50 tags per resource
- Each resource tag must be unique with a maximum of one value.
- Maximum key length: 128 Unicode characters in UTF-8
- Maximum value length: 256 Unicode characters in UTF-8
- Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
- Cannot use "aws:" as a prefix for a key.
$sel:configuration:CreateMap', createMap_configuration - Specifies the MapConfiguration, including the map style, for the map
resource that you create. The map style defines the look of maps and the
data provider for your map resource.
CreateMap, createMap_mapName - The name for the map resource.
Requirements:
- Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
- Must be a unique map resource name.
- No spaces allowed. For example,
ExampleMap.
data CreateMapResponse Source #
See: newCreateMapResponse smart constructor.
Constructors
| CreateMapResponse' Int ISO8601 Text Text |
Instances
Arguments
| :: Int | |
| -> UTCTime | |
| -> Text | |
| -> Text | |
| -> CreateMapResponse |
Create a value of CreateMapResponse 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:httpStatus:CreateMapResponse', createMapResponse_httpStatus - The response's http status code.
CreateMapResponse, createMapResponse_createTime - The timestamp for when the map resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
$sel:mapArn:CreateMapResponse', createMapResponse_mapArn - The Amazon Resource Name (ARN) for the map resource. Used to specify a
resource across all AWS.
- Format example:
arn:aws:geo:region:account-id:map/ExampleMap
CreateMap, createMapResponse_mapName - The name of the map resource.
CreatePlaceIndex
data CreatePlaceIndex Source #
See: newCreatePlaceIndex smart constructor.
Constructors
| CreatePlaceIndex' (Maybe DataSourceConfiguration) (Maybe Text) (Maybe PricingPlan) (Maybe (HashMap Text Text)) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreatePlaceIndex |
Create a value of CreatePlaceIndex 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:dataSourceConfiguration:CreatePlaceIndex', createPlaceIndex_dataSourceConfiguration - Specifies the data storage option requesting Places.
CreatePlaceIndex, createPlaceIndex_description - The optional description for the place index resource.
CreatePlaceIndex, createPlaceIndex_pricingPlan - No longer used. If included, the only allowed value is
RequestBasedUsage.
$sel:tags:CreatePlaceIndex', createPlaceIndex_tags - Applies one or more tags to the place index resource. A tag is a
key-value pair that helps you manage, identify, search, and filter your
resources.
Format: "key" : "value"
Restrictions:
- Maximum 50 tags per resource.
- Each tag key must be unique and must have exactly one associated value.
- Maximum key length: 128 Unicode characters in UTF-8.
- Maximum value length: 256 Unicode characters in UTF-8.
- Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @
- Cannot use "aws:" as a prefix for a key.
CreatePlaceIndex, createPlaceIndex_dataSource - Specifies the geospatial data provider for the new place index.
This field is case-sensitive. Enter the valid values as shown. For
example, entering HERE returns an error.
Valid values include:
Esri– For additional information about Esri's coverage in your region of interest, see Esri details on geocoding coverage.Here– For additional information about HERE Technologies' coverage in your region of interest, see HERE details on goecoding coverage.If you specify HERE Technologies (
Here) as the data provider, you may not store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.
For additional information , see Data providers on the Amazon Location Service Developer Guide.
CreatePlaceIndex, createPlaceIndex_indexName - The name of the place index resource.
Requirements:
- Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
- Must be a unique place index resource name.
- No spaces allowed. For example,
ExamplePlaceIndex.
data CreatePlaceIndexResponse Source #
See: newCreatePlaceIndexResponse smart constructor.
Constructors
| CreatePlaceIndexResponse' Int ISO8601 Text Text |
Instances
newCreatePlaceIndexResponse Source #
Arguments
| :: Int | |
| -> UTCTime | |
| -> Text | |
| -> Text | |
| -> CreatePlaceIndexResponse |
Create a value of CreatePlaceIndexResponse 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:httpStatus:CreatePlaceIndexResponse', createPlaceIndexResponse_httpStatus - The response's http status code.
CreatePlaceIndexResponse, createPlaceIndexResponse_createTime - The timestamp for when the place index resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
$sel:indexArn:CreatePlaceIndexResponse', createPlaceIndexResponse_indexArn - The Amazon Resource Name (ARN) for the place index resource. Used to
specify a resource across AWS.
- Format example:
arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
CreatePlaceIndex, createPlaceIndexResponse_indexName - The name for the place index resource.
CreateRouteCalculator
data CreateRouteCalculator Source #
See: newCreateRouteCalculator smart constructor.
Constructors
| CreateRouteCalculator' (Maybe Text) (Maybe PricingPlan) (Maybe (HashMap Text Text)) Text Text |
Instances
newCreateRouteCalculator Source #
Arguments
| :: Text | |
| -> Text | |
| -> CreateRouteCalculator |
Create a value of CreateRouteCalculator 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:
CreateRouteCalculator, createRouteCalculator_description - The optional description for the route calculator resource.
CreateRouteCalculator, createRouteCalculator_pricingPlan - No longer used. If included, the only allowed value is
RequestBasedUsage.
$sel:tags:CreateRouteCalculator', createRouteCalculator_tags - Applies one or more tags to the route calculator resource. A tag is a
key-value pair helps manage, identify, search, and filter your resources
by labelling them.
- For example: {
"tag1" : "value1","tag2" : "value2"}
Format: "key" : "value"
Restrictions:
- Maximum 50 tags per resource
- Each resource tag must be unique with a maximum of one value.
- Maximum key length: 128 Unicode characters in UTF-8
- Maximum value length: 256 Unicode characters in UTF-8
- Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
- Cannot use "aws:" as a prefix for a key.
CreateRouteCalculator, createRouteCalculator_calculatorName - The name of the route calculator resource.
Requirements:
- Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.), and underscores (_).
- Must be a unique Route calculator resource name.
- No spaces allowed. For example,
ExampleRouteCalculator.
CreateRouteCalculator, createRouteCalculator_dataSource - Specifies the data provider of traffic and road network data.
This field is case-sensitive. Enter the valid values as shown. For
example, entering HERE returns an error. Route calculators that use
Esri as a data source only calculate routes that are shorter than 400
km.
Valid values include:
Esri– For additional information about Esri's coverage in your region of interest, see Esri details on street networks and traffic coverage.Here– For additional information about HERE Technologies' coverage in your region of interest, see HERE car routing coverage and HERE truck routing coverage.
For additional information , see Data providers on the Amazon Location Service Developer Guide.
data CreateRouteCalculatorResponse Source #
See: newCreateRouteCalculatorResponse smart constructor.
Constructors
| CreateRouteCalculatorResponse' Int Text Text ISO8601 |
Instances
newCreateRouteCalculatorResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> UTCTime | |
| -> CreateRouteCalculatorResponse |
Create a value of CreateRouteCalculatorResponse 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:httpStatus:CreateRouteCalculatorResponse', createRouteCalculatorResponse_httpStatus - The response's http status code.
$sel:calculatorArn:CreateRouteCalculatorResponse', createRouteCalculatorResponse_calculatorArn - The Amazon Resource Name (ARN) for the route calculator resource. Use
the ARN when you specify a resource across all AWS.
- Format example:
arn:aws:geo:region:account-id:route-calculator/ExampleCalculator
CreateRouteCalculator, createRouteCalculatorResponse_calculatorName - The name of the route calculator resource.
- For example,
ExampleRouteCalculator.
CreateRouteCalculatorResponse, createRouteCalculatorResponse_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
CreateTracker
data CreateTracker Source #
See: newCreateTracker smart constructor.
Constructors
| CreateTracker' (Maybe Text) (Maybe Text) (Maybe PositionFiltering) (Maybe PricingPlan) (Maybe Text) (Maybe (HashMap Text Text)) Text |
Instances
Arguments
| :: Text | |
| -> CreateTracker |
Create a value of CreateTracker 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:
CreateTracker, createTracker_description - An optional description for the tracker resource.
$sel:kmsKeyId:CreateTracker', createTracker_kmsKeyId - A key identifier for an
AWS KMS customer managed key.
Enter a key ID, key ARN, alias name, or alias ARN.
$sel:positionFiltering:CreateTracker', createTracker_positionFiltering - Specifies the position filtering for the tracker resource.
Valid values:
TimeBased- Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID.DistanceBased- If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this area are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.AccuracyBased- If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This can reduce the effects of GPS noise when displaying device trajectories on a map, and can help control your costs by reducing the number of geofence evaluations.
This field is optional. If not specified, the default value is
TimeBased.
CreateTracker, createTracker_pricingPlan - No longer used. If included, the only allowed value is
RequestBasedUsage.
CreateTracker, createTracker_pricingPlanDataSource - This parameter is no longer used.
$sel:tags:CreateTracker', createTracker_tags - Applies one or more tags to the tracker resource. A tag is a key-value
pair helps manage, identify, search, and filter your resources by
labelling them.
Format: "key" : "value"
Restrictions:
- Maximum 50 tags per resource
- Each resource tag must be unique with a maximum of one value.
- Maximum key length: 128 Unicode characters in UTF-8
- Maximum value length: 256 Unicode characters in UTF-8
- Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
- Cannot use "aws:" as a prefix for a key.
CreateTracker, createTracker_trackerName - The name for the tracker resource.
Requirements:
- Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_).
- Must be a unique tracker resource name.
- No spaces allowed. For example,
ExampleTracker.
data CreateTrackerResponse Source #
See: newCreateTrackerResponse smart constructor.
Constructors
| CreateTrackerResponse' Int ISO8601 Text Text |
Instances
newCreateTrackerResponse Source #
Arguments
| :: Int | |
| -> UTCTime | |
| -> Text | |
| -> Text | |
| -> CreateTrackerResponse |
Create a value of CreateTrackerResponse 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:httpStatus:CreateTrackerResponse', createTrackerResponse_httpStatus - The response's http status code.
CreateTrackerResponse, createTrackerResponse_createTime - The timestamp for when the tracker resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
$sel:trackerArn:CreateTrackerResponse', createTrackerResponse_trackerArn - The Amazon Resource Name (ARN) for the tracker resource. Used when you
need to specify a resource across all AWS.
- Format example:
arn:aws:geo:region:account-id:tracker/ExampleTracker
CreateTracker, createTrackerResponse_trackerName - The name of the tracker resource.
DeleteGeofenceCollection
data DeleteGeofenceCollection Source #
See: newDeleteGeofenceCollection smart constructor.
Constructors
| DeleteGeofenceCollection' Text |
Instances
newDeleteGeofenceCollection Source #
Arguments
| :: Text | |
| -> DeleteGeofenceCollection |
Create a value of DeleteGeofenceCollection 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:
DeleteGeofenceCollection, deleteGeofenceCollection_collectionName - The name of the geofence collection to be deleted.
data DeleteGeofenceCollectionResponse Source #
See: newDeleteGeofenceCollectionResponse smart constructor.
Constructors
| DeleteGeofenceCollectionResponse' Int |
Instances
newDeleteGeofenceCollectionResponse Source #
Create a value of DeleteGeofenceCollectionResponse 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:httpStatus:DeleteGeofenceCollectionResponse', deleteGeofenceCollectionResponse_httpStatus - The response's http status code.
DeleteMap
See: newDeleteMap smart constructor.
Constructors
| DeleteMap' Text |
Instances
Create a value of DeleteMap 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:
DeleteMap, deleteMap_mapName - The name of the map resource to be deleted.
data DeleteMapResponse Source #
See: newDeleteMapResponse smart constructor.
Constructors
| DeleteMapResponse' Int |
Instances
Arguments
| :: Int | |
| -> DeleteMapResponse |
Create a value of DeleteMapResponse 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:httpStatus:DeleteMapResponse', deleteMapResponse_httpStatus - The response's http status code.
DeletePlaceIndex
data DeletePlaceIndex Source #
See: newDeletePlaceIndex smart constructor.
Constructors
| DeletePlaceIndex' Text |
Instances
Arguments
| :: Text | |
| -> DeletePlaceIndex |
Create a value of DeletePlaceIndex 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:
DeletePlaceIndex, deletePlaceIndex_indexName - The name of the place index resource to be deleted.
data DeletePlaceIndexResponse Source #
See: newDeletePlaceIndexResponse smart constructor.
Constructors
| DeletePlaceIndexResponse' Int |
Instances
newDeletePlaceIndexResponse Source #
Create a value of DeletePlaceIndexResponse 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:httpStatus:DeletePlaceIndexResponse', deletePlaceIndexResponse_httpStatus - The response's http status code.
DeleteRouteCalculator
data DeleteRouteCalculator Source #
See: newDeleteRouteCalculator smart constructor.
Constructors
| DeleteRouteCalculator' Text |
Instances
newDeleteRouteCalculator Source #
Arguments
| :: Text | |
| -> DeleteRouteCalculator |
Create a value of DeleteRouteCalculator 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:
DeleteRouteCalculator, deleteRouteCalculator_calculatorName - The name of the route calculator resource to be deleted.
data DeleteRouteCalculatorResponse Source #
See: newDeleteRouteCalculatorResponse smart constructor.
Constructors
| DeleteRouteCalculatorResponse' Int |
Instances
newDeleteRouteCalculatorResponse Source #
Create a value of DeleteRouteCalculatorResponse 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:httpStatus:DeleteRouteCalculatorResponse', deleteRouteCalculatorResponse_httpStatus - The response's http status code.
DeleteTracker
data DeleteTracker Source #
See: newDeleteTracker smart constructor.
Constructors
| DeleteTracker' Text |
Instances
Arguments
| :: Text | |
| -> DeleteTracker |
Create a value of DeleteTracker 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:
DeleteTracker, deleteTracker_trackerName - The name of the tracker resource to be deleted.
data DeleteTrackerResponse Source #
See: newDeleteTrackerResponse smart constructor.
Constructors
| DeleteTrackerResponse' Int |
Instances
newDeleteTrackerResponse Source #
Create a value of DeleteTrackerResponse 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:httpStatus:DeleteTrackerResponse', deleteTrackerResponse_httpStatus - The response's http status code.
DescribeGeofenceCollection
data DescribeGeofenceCollection Source #
See: newDescribeGeofenceCollection smart constructor.
Constructors
| DescribeGeofenceCollection' Text |
Instances
newDescribeGeofenceCollection Source #
Arguments
| :: Text | |
| -> DescribeGeofenceCollection |
Create a value of DescribeGeofenceCollection 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:
DescribeGeofenceCollection, describeGeofenceCollection_collectionName - The name of the geofence collection.
data DescribeGeofenceCollectionResponse Source #
See: newDescribeGeofenceCollectionResponse smart constructor.
Constructors
| DescribeGeofenceCollectionResponse' (Maybe Text) (Maybe PricingPlan) (Maybe Text) (Maybe (HashMap Text Text)) Int Text Text ISO8601 Text ISO8601 |
Instances
newDescribeGeofenceCollectionResponse Source #
Create a value of DescribeGeofenceCollectionResponse 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:kmsKeyId:DescribeGeofenceCollectionResponse', describeGeofenceCollectionResponse_kmsKeyId - A key identifier for an
AWS KMS customer managed key
assigned to the Amazon Location resource
DescribeGeofenceCollectionResponse, describeGeofenceCollectionResponse_pricingPlan - No longer used. Always returns RequestBasedUsage.
DescribeGeofenceCollectionResponse, describeGeofenceCollectionResponse_pricingPlanDataSource - No longer used. Always returns an empty string.
$sel:tags:DescribeGeofenceCollectionResponse', describeGeofenceCollectionResponse_tags - Displays the key, value pairs of tags associated with this resource.
$sel:httpStatus:DescribeGeofenceCollectionResponse', describeGeofenceCollectionResponse_httpStatus - The response's http status code.
$sel:collectionArn:DescribeGeofenceCollectionResponse', describeGeofenceCollectionResponse_collectionArn - The Amazon Resource Name (ARN) for the geofence collection resource.
Used when you need to specify a resource across all AWS.
- Format example:
arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection
DescribeGeofenceCollection, describeGeofenceCollectionResponse_collectionName - The name of the geofence collection.
DescribeGeofenceCollectionResponse, describeGeofenceCollectionResponse_createTime - The timestamp for when the geofence resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
DescribeGeofenceCollectionResponse, describeGeofenceCollectionResponse_description - The optional description for the geofence collection.
DescribeGeofenceCollectionResponse, describeGeofenceCollectionResponse_updateTime - The timestamp for when the geofence collection was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
DescribeMap
data DescribeMap Source #
See: newDescribeMap smart constructor.
Constructors
| DescribeMap' Text |
Instances
Arguments
| :: Text | |
| -> DescribeMap |
Create a value of DescribeMap 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:
DescribeMap, describeMap_mapName - The name of the map resource.
data DescribeMapResponse Source #
See: newDescribeMapResponse smart constructor.
Constructors
| DescribeMapResponse' (Maybe PricingPlan) (Maybe (HashMap Text Text)) Int MapConfiguration ISO8601 Text Text Text Text ISO8601 |
Instances
newDescribeMapResponse Source #
Arguments
| :: Int | |
| -> MapConfiguration | |
| -> UTCTime | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> UTCTime | |
| -> DescribeMapResponse |
Create a value of DescribeMapResponse 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:
DescribeMapResponse, describeMapResponse_pricingPlan - No longer used. Always returns RequestBasedUsage.
$sel:tags:DescribeMapResponse', describeMapResponse_tags - Tags associated with the map resource.
$sel:httpStatus:DescribeMapResponse', describeMapResponse_httpStatus - The response's http status code.
$sel:configuration:DescribeMapResponse', describeMapResponse_configuration - Specifies the map tile style selected from a partner data provider.
DescribeMapResponse, describeMapResponse_createTime - The timestamp for when the map resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
DescribeMapResponse, describeMapResponse_dataSource - Specifies the data provider for the associated map tiles.
DescribeMapResponse, describeMapResponse_description - The optional description for the map resource.
$sel:mapArn:DescribeMapResponse', describeMapResponse_mapArn - The Amazon Resource Name (ARN) for the map resource. Used to specify a
resource across all AWS.
- Format example:
arn:aws:geo:region:account-id:map/ExampleMap
DescribeMap, describeMapResponse_mapName - The map style selected from an available provider.
DescribeMapResponse, describeMapResponse_updateTime - The timestamp for when the map resource was last update in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
DescribePlaceIndex
data DescribePlaceIndex Source #
See: newDescribePlaceIndex smart constructor.
Constructors
| DescribePlaceIndex' Text |
Instances
newDescribePlaceIndex Source #
Arguments
| :: Text | |
| -> DescribePlaceIndex |
Create a value of DescribePlaceIndex 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:
DescribePlaceIndex, describePlaceIndex_indexName - The name of the place index resource.
data DescribePlaceIndexResponse Source #
See: newDescribePlaceIndexResponse smart constructor.
Constructors
| DescribePlaceIndexResponse' (Maybe PricingPlan) (Maybe (HashMap Text Text)) Int ISO8601 Text DataSourceConfiguration Text Text Text ISO8601 |
Instances
newDescribePlaceIndexResponse Source #
Arguments
| :: Int | |
| -> UTCTime | |
| -> Text | |
| -> DataSourceConfiguration | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> UTCTime | |
| -> DescribePlaceIndexResponse |
Create a value of DescribePlaceIndexResponse 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:
DescribePlaceIndexResponse, describePlaceIndexResponse_pricingPlan - No longer used. Always returns RequestBasedUsage.
$sel:tags:DescribePlaceIndexResponse', describePlaceIndexResponse_tags - Tags associated with place index resource.
$sel:httpStatus:DescribePlaceIndexResponse', describePlaceIndexResponse_httpStatus - The response's http status code.
DescribePlaceIndexResponse, describePlaceIndexResponse_createTime - The timestamp for when the place index resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
DescribePlaceIndexResponse, describePlaceIndexResponse_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:dataSourceConfiguration:DescribePlaceIndexResponse', describePlaceIndexResponse_dataSourceConfiguration - The specified data storage option for requesting Places.
DescribePlaceIndexResponse, describePlaceIndexResponse_description - The optional description for the place index resource.
$sel:indexArn:DescribePlaceIndexResponse', describePlaceIndexResponse_indexArn - The Amazon Resource Name (ARN) for the place index resource. Used to
specify a resource across AWS.
- Format example:
arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
DescribePlaceIndex, describePlaceIndexResponse_indexName - The name of the place index resource being described.
DescribePlaceIndexResponse, describePlaceIndexResponse_updateTime - The timestamp for when the place index resource was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
DescribeRouteCalculator
data DescribeRouteCalculator Source #
See: newDescribeRouteCalculator smart constructor.
Constructors
| DescribeRouteCalculator' Text |
Instances
newDescribeRouteCalculator Source #
Arguments
| :: Text | |
| -> DescribeRouteCalculator |
Create a value of DescribeRouteCalculator 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:
DescribeRouteCalculator, describeRouteCalculator_calculatorName - The name of the route calculator resource.
data DescribeRouteCalculatorResponse Source #
See: newDescribeRouteCalculatorResponse smart constructor.
Constructors
| DescribeRouteCalculatorResponse' (Maybe PricingPlan) (Maybe (HashMap Text Text)) Int Text Text ISO8601 Text Text ISO8601 |
Instances
newDescribeRouteCalculatorResponse Source #
Create a value of DescribeRouteCalculatorResponse 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:
DescribeRouteCalculatorResponse, describeRouteCalculatorResponse_pricingPlan - Always returns RequestBasedUsage.
$sel:tags:DescribeRouteCalculatorResponse', describeRouteCalculatorResponse_tags - Tags associated with route calculator resource.
$sel:httpStatus:DescribeRouteCalculatorResponse', describeRouteCalculatorResponse_httpStatus - The response's http status code.
$sel:calculatorArn:DescribeRouteCalculatorResponse', describeRouteCalculatorResponse_calculatorArn - The Amazon Resource Name (ARN) for the Route calculator resource. Use
the ARN when you specify a resource across AWS.
- Format example:
arn:aws:geo:region:account-id:route-calculator/ExampleCalculator
DescribeRouteCalculator, describeRouteCalculatorResponse_calculatorName - The name of the route calculator resource being described.
DescribeRouteCalculatorResponse, describeRouteCalculatorResponse_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
DescribeRouteCalculatorResponse, describeRouteCalculatorResponse_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.
DescribeRouteCalculatorResponse, describeRouteCalculatorResponse_description - The optional description of the route calculator resource.
DescribeRouteCalculatorResponse, describeRouteCalculatorResponse_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
DescribeTracker
data DescribeTracker Source #
See: newDescribeTracker smart constructor.
Constructors
| DescribeTracker' Text |
Instances
Arguments
| :: Text | |
| -> DescribeTracker |
Create a value of DescribeTracker 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:
DescribeTracker, describeTracker_trackerName - The name of the tracker resource.
data DescribeTrackerResponse Source #
See: newDescribeTrackerResponse smart constructor.
Constructors
| DescribeTrackerResponse' (Maybe Text) (Maybe PositionFiltering) (Maybe PricingPlan) (Maybe Text) (Maybe (HashMap Text Text)) Int ISO8601 Text Text Text ISO8601 |
Instances
newDescribeTrackerResponse Source #
Create a value of DescribeTrackerResponse 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:kmsKeyId:DescribeTrackerResponse', describeTrackerResponse_kmsKeyId - A key identifier for an
AWS KMS customer managed key
assigned to the Amazon Location resource.
$sel:positionFiltering:DescribeTrackerResponse', describeTrackerResponse_positionFiltering - The position filtering method of the tracker resource.
DescribeTrackerResponse, describeTrackerResponse_pricingPlan - Always returns RequestBasedUsage.
DescribeTrackerResponse, describeTrackerResponse_pricingPlanDataSource - No longer used. Always returns an empty string.
$sel:tags:DescribeTrackerResponse', describeTrackerResponse_tags - The tags associated with the tracker resource.
$sel:httpStatus:DescribeTrackerResponse', describeTrackerResponse_httpStatus - The response's http status code.
DescribeTrackerResponse, describeTrackerResponse_createTime - The timestamp for when the tracker resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
DescribeTrackerResponse, describeTrackerResponse_description - The optional description for the tracker resource.
$sel:trackerArn:DescribeTrackerResponse', describeTrackerResponse_trackerArn - The Amazon Resource Name (ARN) for the tracker resource. Used when you
need to specify a resource across all AWS.
- Format example:
arn:aws:geo:region:account-id:tracker/ExampleTracker
DescribeTracker, describeTrackerResponse_trackerName - The name of the tracker resource.
DescribeTrackerResponse, describeTrackerResponse_updateTime - The timestamp for when the tracker resource was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
DisassociateTrackerConsumer
data DisassociateTrackerConsumer Source #
See: newDisassociateTrackerConsumer smart constructor.
Constructors
| DisassociateTrackerConsumer' Text Text |
Instances
newDisassociateTrackerConsumer Source #
Arguments
| :: Text | |
| -> Text | |
| -> DisassociateTrackerConsumer |
Create a value of DisassociateTrackerConsumer 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:consumerArn:DisassociateTrackerConsumer', disassociateTrackerConsumer_consumerArn - The Amazon Resource Name (ARN) for the geofence collection to be
disassociated from the tracker resource. Used when you need to specify a
resource across all AWS.
- Format example:
arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer
DisassociateTrackerConsumer, disassociateTrackerConsumer_trackerName - The name of the tracker resource to be dissociated from the consumer.
data DisassociateTrackerConsumerResponse Source #
See: newDisassociateTrackerConsumerResponse smart constructor.
Constructors
| DisassociateTrackerConsumerResponse' Int |
Instances
newDisassociateTrackerConsumerResponse Source #
Arguments
| :: Int | |
| -> DisassociateTrackerConsumerResponse |
Create a value of DisassociateTrackerConsumerResponse 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:httpStatus:DisassociateTrackerConsumerResponse', disassociateTrackerConsumerResponse_httpStatus - The response's http status code.
GetDevicePosition
data GetDevicePosition Source #
See: newGetDevicePosition smart constructor.
Constructors
| GetDevicePosition' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> GetDevicePosition |
Create a value of GetDevicePosition 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:
GetDevicePosition, getDevicePosition_deviceId - The device whose position you want to retrieve.
GetDevicePosition, getDevicePosition_trackerName - The tracker resource receiving the position update.
data GetDevicePositionResponse Source #
See: newGetDevicePositionResponse smart constructor.
Constructors
| GetDevicePositionResponse' (Maybe PositionalAccuracy) (Maybe Text) (Maybe (Sensitive (HashMap Text Text))) Int (Sensitive (NonEmpty Double)) ISO8601 ISO8601 |
Instances
newGetDevicePositionResponse Source #
Create a value of GetDevicePositionResponse 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:
GetDevicePositionResponse, getDevicePositionResponse_accuracy - The accuracy of the device position.
GetDevicePosition, getDevicePositionResponse_deviceId - The device whose position you retrieved.
GetDevicePositionResponse, getDevicePositionResponse_positionProperties - The properties associated with the position.
$sel:httpStatus:GetDevicePositionResponse', getDevicePositionResponse_httpStatus - The response's http status code.
GetDevicePositionResponse, getDevicePositionResponse_position - The last known device position.
GetDevicePositionResponse, getDevicePositionResponse_receivedTime - The timestamp for when the tracker resource received the device position
in ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
GetDevicePositionResponse, getDevicePositionResponse_sampleTime - The timestamp at which the device's position was determined. Uses
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
GetDevicePositionHistory (Paginated)
data GetDevicePositionHistory Source #
See: newGetDevicePositionHistory smart constructor.
Constructors
| GetDevicePositionHistory' (Maybe ISO8601) (Maybe Natural) (Maybe Text) (Maybe ISO8601) Text Text |
Instances
newGetDevicePositionHistory Source #
Create a value of GetDevicePositionHistory 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:endTimeExclusive:GetDevicePositionHistory', getDevicePositionHistory_endTimeExclusive - Specify the end time for the position history in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be the
time that the request is made.
Requirement:
- The time specified for
EndTimeExclusivemust be after the time forStartTimeInclusive.
GetDevicePositionHistory, getDevicePositionHistory_maxResults - An optional limit for the number of device positions returned in a
single call.
Default value: 100
GetDevicePositionHistory, getDevicePositionHistory_nextToken - The pagination token specifying which page of results to return in the
response. If no token is provided, the default page is the first page.
Default value: null
$sel:startTimeInclusive:GetDevicePositionHistory', getDevicePositionHistory_startTimeInclusive - Specify the start time for the position history in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be 24
hours prior to the time that the request is made.
Requirement:
- The time specified for
StartTimeInclusivemust be beforeEndTimeExclusive.
GetDevicePositionHistory, getDevicePositionHistory_deviceId - The device whose position history you want to retrieve.
GetDevicePositionHistory, getDevicePositionHistory_trackerName - The tracker resource receiving the request for the device position
history.
data GetDevicePositionHistoryResponse Source #
See: newGetDevicePositionHistoryResponse smart constructor.
Constructors
| GetDevicePositionHistoryResponse' (Maybe Text) Int [DevicePosition] |
Instances
newGetDevicePositionHistoryResponse Source #
Create a value of GetDevicePositionHistoryResponse 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:
GetDevicePositionHistory, getDevicePositionHistoryResponse_nextToken - A pagination token indicating there are additional pages available. You
can use the token in a following request to fetch the next set of
results.
$sel:httpStatus:GetDevicePositionHistoryResponse', getDevicePositionHistoryResponse_httpStatus - The response's http status code.
$sel:devicePositions:GetDevicePositionHistoryResponse', getDevicePositionHistoryResponse_devicePositions - Contains the position history details for the requested device.
GetGeofence
data GetGeofence Source #
See: newGetGeofence smart constructor.
Constructors
| GetGeofence' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> GetGeofence |
Create a value of GetGeofence 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:
GetGeofence, getGeofence_collectionName - The geofence collection storing the target geofence.
GetGeofence, getGeofence_geofenceId - The geofence you're retrieving details for.
data GetGeofenceResponse Source #
See: newGetGeofenceResponse smart constructor.
Constructors
| GetGeofenceResponse' Int ISO8601 Text GeofenceGeometry Text ISO8601 |
Instances
newGetGeofenceResponse Source #
Arguments
| :: Int | |
| -> UTCTime | |
| -> Text | |
| -> GeofenceGeometry | |
| -> Text | |
| -> UTCTime | |
| -> GetGeofenceResponse |
Create a value of GetGeofenceResponse 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:httpStatus:GetGeofenceResponse', getGeofenceResponse_httpStatus - The response's http status code.
GetGeofenceResponse, getGeofenceResponse_createTime - The timestamp for when the geofence collection was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
GetGeofence, getGeofenceResponse_geofenceId - The geofence identifier.
GetGeofenceResponse, getGeofenceResponse_geometry - Contains the geofence geometry details describing a polygon or a circle.
GetGeofenceResponse, getGeofenceResponse_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.
GetGeofenceResponse, getGeofenceResponse_updateTime - The timestamp for when the geofence collection was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
GetMapGlyphs
data GetMapGlyphs Source #
See: newGetMapGlyphs smart constructor.
Constructors
| GetMapGlyphs' Text Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> GetMapGlyphs |
Create a value of GetMapGlyphs 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:fontStack:GetMapGlyphs', getMapGlyphs_fontStack - A comma-separated list of fonts to load glyphs from in order of
preference. For example, Noto Sans Regular, Arial Unicode.
Valid fonts stacks for Esri styles:
- VectorEsriDarkGrayCanvas –
Ubuntu Medium Italic|Ubuntu Medium|Ubuntu Italic|Ubuntu Regular|Ubuntu Bold - VectorEsriLightGrayCanvas –
Ubuntu Italic|Ubuntu Regular|Ubuntu Light|Ubuntu Bold - VectorEsriTopographic –
Noto Sans Italic|Noto Sans Regular|Noto Sans Bold|Noto Serif Regular|Roboto Condensed Light Italic - VectorEsriStreets –
Arial Regular|Arial Italic|Arial Bold - VectorEsriNavigation –
Arial Regular|Arial Italic|Arial Bold
Valid font stacks for HERE Technologies styles:
- VectorHereContrast –
Fira GO Regular|Fira GO Bold - VectorHereExplore, VectorHereExploreTruck,
HybridHereExploreSatellite –
Fira GO Italic|Fira GO Map|Fira GO Map Bold|Noto Sans CJK JP Bold|Noto Sans CJK JP Light|Noto Sans CJK JP Regular
Valid font stacks for Open Data (Preview) styles:
- VectorOpenDataStandardLight –
Amazon Ember Regular,Noto Sans Regular|Amazon Ember Bold,Noto Sans Bold|Amazon Ember Medium,Noto Sans Medium|Amazon Ember Regular Italic,Noto Sans Italic|Amazon Ember Condensed RC Regular,Noto Sans Regular|Amazon Ember Condensed RC Bold,Noto Sans Bold
The fonts used by VectorOpenDataStandardLight are combined fonts that
use Amazon Ember for most glyphs but Noto Sans for glyphs
unsupported by Amazon Ember.
$sel:fontUnicodeRange:GetMapGlyphs', getMapGlyphs_fontUnicodeRange - A Unicode range of characters to download glyphs for. Each response will
contain 256 characters. For example, 0–255 includes all characters from
range U+0000 to 00FF. Must be aligned to multiples of 256.
GetMapGlyphs, getMapGlyphs_mapName - The map resource associated with the glyph file.
data GetMapGlyphsResponse Source #
See: newGetMapGlyphsResponse smart constructor.
Constructors
| GetMapGlyphsResponse' (Maybe ByteString) (Maybe Text) Int |
Instances
newGetMapGlyphsResponse Source #
Arguments
| :: Int | |
| -> GetMapGlyphsResponse |
Create a value of GetMapGlyphsResponse 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:blob:GetMapGlyphsResponse', getMapGlyphsResponse_blob - The blob's content type.
$sel:contentType:GetMapGlyphsResponse', getMapGlyphsResponse_contentType - The map glyph content type. For example, application/octet-stream.
$sel:httpStatus:GetMapGlyphsResponse', getMapGlyphsResponse_httpStatus - The response's http status code.
GetMapSprites
data GetMapSprites Source #
See: newGetMapSprites smart constructor.
Constructors
| GetMapSprites' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> GetMapSprites |
Create a value of GetMapSprites 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:fileName:GetMapSprites', getMapSprites_fileName - The name of the sprite file. Use the following file names for the sprite
sheet:
sprites.png
sprites@2x.pngfor high pixel density displays
For the JSON document containing image offsets. Use the following file names:
sprites.json
sprites@2x.jsonfor high pixel density displays
GetMapSprites, getMapSprites_mapName - The map resource associated with the sprite file.
data GetMapSpritesResponse Source #
See: newGetMapSpritesResponse smart constructor.
Constructors
| GetMapSpritesResponse' (Maybe ByteString) (Maybe Text) Int |
Instances
newGetMapSpritesResponse Source #
Create a value of GetMapSpritesResponse 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:blob:GetMapSpritesResponse', getMapSpritesResponse_blob - Contains the body of the sprite sheet or JSON offset file.
$sel:contentType:GetMapSpritesResponse', getMapSpritesResponse_contentType - The content type of the sprite sheet and offsets. For example, the
sprite sheet content type is image/png, and the sprite offset JSON
document is application/json.
$sel:httpStatus:GetMapSpritesResponse', getMapSpritesResponse_httpStatus - The response's http status code.
GetMapStyleDescriptor
data GetMapStyleDescriptor Source #
See: newGetMapStyleDescriptor smart constructor.
Constructors
| GetMapStyleDescriptor' Text |
Instances
newGetMapStyleDescriptor Source #
Arguments
| :: Text | |
| -> GetMapStyleDescriptor |
Create a value of GetMapStyleDescriptor 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:
GetMapStyleDescriptor, getMapStyleDescriptor_mapName - The map resource to retrieve the style descriptor from.
data GetMapStyleDescriptorResponse Source #
See: newGetMapStyleDescriptorResponse smart constructor.
Constructors
| GetMapStyleDescriptorResponse' (Maybe ByteString) (Maybe Text) Int |
Instances
newGetMapStyleDescriptorResponse Source #
Create a value of GetMapStyleDescriptorResponse 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:blob:GetMapStyleDescriptorResponse', getMapStyleDescriptorResponse_blob - Contains the body of the style descriptor.
$sel:contentType:GetMapStyleDescriptorResponse', getMapStyleDescriptorResponse_contentType - The style descriptor's content type. For example, application/json.
$sel:httpStatus:GetMapStyleDescriptorResponse', getMapStyleDescriptorResponse_httpStatus - The response's http status code.
GetMapTile
data GetMapTile Source #
See: newGetMapTile smart constructor.
Constructors
| GetMapTile' Text Text Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> GetMapTile |
Create a value of GetMapTile 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:
GetMapTile, getMapTile_mapName - The map resource to retrieve the map tiles from.
$sel:x:GetMapTile', getMapTile_x - The X axis value for the map tile.
$sel:y:GetMapTile', getMapTile_y - The Y axis value for the map tile.
$sel:z:GetMapTile', getMapTile_z - The zoom value for the map tile.
data GetMapTileResponse Source #
See: newGetMapTileResponse smart constructor.
Constructors
| GetMapTileResponse' (Maybe ByteString) (Maybe Text) Int |
Instances
newGetMapTileResponse Source #
Arguments
| :: Int | |
| -> GetMapTileResponse |
Create a value of GetMapTileResponse 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:blob:GetMapTileResponse', getMapTileResponse_blob - Contains Mapbox Vector Tile (MVT) data.
$sel:contentType:GetMapTileResponse', getMapTileResponse_contentType - The map tile's content type. For example,
application/vnd.mapbox-vector-tile.
$sel:httpStatus:GetMapTileResponse', getMapTileResponse_httpStatus - The response's http status code.
GetPlace
See: newGetPlace smart constructor.
Instances
Create a value of GetPlace 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:
GetPlace, getPlace_language - The preferred language used to return results. The value must be a valid
BCP 47 language tag, for example,
en for English.
This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.
For an example, we'll use the Greek language. You search for a location
around Athens, Greece, with the language parameter set to en. The
city in the results will most likely be returned as Athens.
If you set the language parameter to el, for Greek, then the city
in the results will more likely be returned as Αθήνα.
If the data provider does not have a value for Greek, the result will be in a language that the provider does support.
GetPlace, getPlace_indexName - The name of the place index resource that you want to use for the
search.
GetPlace, getPlace_placeId - The identifier of the place to find.
data GetPlaceResponse Source #
See: newGetPlaceResponse smart constructor.
Constructors
| GetPlaceResponse' Int Place |
Instances
Create a value of GetPlaceResponse 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:httpStatus:GetPlaceResponse', getPlaceResponse_httpStatus - The response's http status code.
GetPlaceResponse, getPlaceResponse_place - Details about the result, such as its address and position.
ListDevicePositions (Paginated)
data ListDevicePositions Source #
See: newListDevicePositions smart constructor.
Instances
newListDevicePositions Source #
Arguments
| :: Text | |
| -> ListDevicePositions |
Create a value of ListDevicePositions 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:
ListDevicePositions, listDevicePositions_maxResults - An optional limit for the number of entries returned in a single call.
Default value: 100
ListDevicePositions, listDevicePositions_nextToken - The pagination token specifying which page of results to return in the
response. If no token is provided, the default page is the first page.
Default value: null
ListDevicePositions, listDevicePositions_trackerName - The tracker resource containing the requested devices.
data ListDevicePositionsResponse Source #
See: newListDevicePositionsResponse smart constructor.
Constructors
| ListDevicePositionsResponse' (Maybe Text) Int [ListDevicePositionsResponseEntry] |
Instances
newListDevicePositionsResponse Source #
Create a value of ListDevicePositionsResponse 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:
ListDevicePositions, listDevicePositionsResponse_nextToken - A pagination token indicating there are additional pages available. You
can use the token in a following request to fetch the next set of
results.
$sel:httpStatus:ListDevicePositionsResponse', listDevicePositionsResponse_httpStatus - The response's http status code.
$sel:entries:ListDevicePositionsResponse', listDevicePositionsResponse_entries - Contains details about each device's last known position. These details
includes the device ID, the time when the position was sampled on the
device, the time that the service received the update, and the most
recent coordinates.
ListGeofenceCollections (Paginated)
data ListGeofenceCollections Source #
See: newListGeofenceCollections smart constructor.
Constructors
| ListGeofenceCollections' (Maybe Natural) (Maybe Text) |
Instances
newListGeofenceCollections :: ListGeofenceCollections Source #
Create a value of ListGeofenceCollections 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:
ListGeofenceCollections, listGeofenceCollections_maxResults - An optional limit for the number of resources returned in a single call.
Default value: 100
ListGeofenceCollections, listGeofenceCollections_nextToken - The pagination token specifying which page of results to return in the
response. If no token is provided, the default page is the first page.
Default value: null
data ListGeofenceCollectionsResponse Source #
See: newListGeofenceCollectionsResponse smart constructor.
Constructors
| ListGeofenceCollectionsResponse' (Maybe Text) Int [ListGeofenceCollectionsResponseEntry] |
Instances
newListGeofenceCollectionsResponse Source #
Create a value of ListGeofenceCollectionsResponse 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:
ListGeofenceCollections, listGeofenceCollectionsResponse_nextToken - A pagination token indicating there are additional pages available. You
can use the token in a following request to fetch the next set of
results.
$sel:httpStatus:ListGeofenceCollectionsResponse', listGeofenceCollectionsResponse_httpStatus - The response's http status code.
$sel:entries:ListGeofenceCollectionsResponse', listGeofenceCollectionsResponse_entries - Lists the geofence collections that exist in your AWS account.
ListGeofences (Paginated)
data ListGeofences Source #
See: newListGeofences smart constructor.
Instances
Arguments
| :: Text | |
| -> ListGeofences |
Create a value of ListGeofences 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:
ListGeofences, listGeofences_maxResults - An optional limit for the number of geofences returned in a single call.
Default value: 100
ListGeofences, listGeofences_nextToken - The pagination token specifying which page of results to return in the
response. If no token is provided, the default page is the first page.
Default value: null
ListGeofences, listGeofences_collectionName - The name of the geofence collection storing the list of geofences.
data ListGeofencesResponse Source #
See: newListGeofencesResponse smart constructor.
Constructors
| ListGeofencesResponse' (Maybe Text) Int [ListGeofenceResponseEntry] |
Instances
newListGeofencesResponse Source #
Create a value of ListGeofencesResponse 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:
ListGeofences, listGeofencesResponse_nextToken - A pagination token indicating there are additional pages available. You
can use the token in a following request to fetch the next set of
results.
$sel:httpStatus:ListGeofencesResponse', listGeofencesResponse_httpStatus - The response's http status code.
$sel:entries:ListGeofencesResponse', listGeofencesResponse_entries - Contains a list of geofences stored in the geofence collection.
ListMaps (Paginated)
See: newListMaps smart constructor.
Instances
newListMaps :: ListMaps Source #
Create a value of ListMaps 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:
ListMaps, listMaps_maxResults - An optional limit for the number of resources returned in a single call.
Default value: 100
ListMaps, listMaps_nextToken - The pagination token specifying which page of results to return in the
response. If no token is provided, the default page is the first page.
Default value: null
data ListMapsResponse Source #
See: newListMapsResponse smart constructor.
Constructors
| ListMapsResponse' (Maybe Text) Int [ListMapsResponseEntry] |
Instances
Arguments
| :: Int | |
| -> ListMapsResponse |
Create a value of ListMapsResponse 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:
ListMaps, listMapsResponse_nextToken - A pagination token indicating there are additional pages available. You
can use the token in a following request to fetch the next set of
results.
$sel:httpStatus:ListMapsResponse', listMapsResponse_httpStatus - The response's http status code.
$sel:entries:ListMapsResponse', listMapsResponse_entries - Contains a list of maps in your AWS account
ListPlaceIndexes (Paginated)
data ListPlaceIndexes Source #
See: newListPlaceIndexes smart constructor.
Constructors
| ListPlaceIndexes' (Maybe Natural) (Maybe Text) |
Instances
newListPlaceIndexes :: ListPlaceIndexes Source #
Create a value of ListPlaceIndexes 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:
ListPlaceIndexes, listPlaceIndexes_maxResults - An optional limit for the maximum number of results returned in a single
call.
Default value: 100
ListPlaceIndexes, listPlaceIndexes_nextToken - The pagination token specifying which page of results to return in the
response. If no token is provided, the default page is the first page.
Default value: null
data ListPlaceIndexesResponse Source #
See: newListPlaceIndexesResponse smart constructor.
Constructors
| ListPlaceIndexesResponse' (Maybe Text) Int [ListPlaceIndexesResponseEntry] |
Instances
newListPlaceIndexesResponse Source #
Create a value of ListPlaceIndexesResponse 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:
ListPlaceIndexes, listPlaceIndexesResponse_nextToken - A pagination token indicating that there are additional pages available.
You can use the token in a new request to fetch the next page of
results.
$sel:httpStatus:ListPlaceIndexesResponse', listPlaceIndexesResponse_httpStatus - The response's http status code.
$sel:entries:ListPlaceIndexesResponse', listPlaceIndexesResponse_entries - Lists the place index resources that exist in your AWS account
ListRouteCalculators (Paginated)
data ListRouteCalculators Source #
See: newListRouteCalculators smart constructor.
Constructors
| ListRouteCalculators' (Maybe Natural) (Maybe Text) |
Instances
newListRouteCalculators :: ListRouteCalculators Source #
Create a value of ListRouteCalculators 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:
ListRouteCalculators, listRouteCalculators_maxResults - An optional maximum number of results returned in a single call.
Default Value: 100
ListRouteCalculators, listRouteCalculators_nextToken - The pagination token specifying which page of results to return in the
response. If no token is provided, the default page is the first page.
Default Value: null
data ListRouteCalculatorsResponse Source #
See: newListRouteCalculatorsResponse smart constructor.
Constructors
| ListRouteCalculatorsResponse' (Maybe Text) Int [ListRouteCalculatorsResponseEntry] |
Instances
newListRouteCalculatorsResponse Source #
Create a value of ListRouteCalculatorsResponse 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:
ListRouteCalculators, listRouteCalculatorsResponse_nextToken - A pagination token indicating there are additional pages available. You
can use the token in a subsequent request to fetch the next set of
results.
$sel:httpStatus:ListRouteCalculatorsResponse', listRouteCalculatorsResponse_httpStatus - The response's http status code.
$sel:entries:ListRouteCalculatorsResponse', listRouteCalculatorsResponse_entries - Lists the route calculator resources that exist in your AWS account
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource 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:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - The Amazon Resource Name (ARN) of the resource whose tags you want to
retrieve.
- Format example:
arn:aws:geo:region:account-id:resourcetype/ExampleResource
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse 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:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - Tags that have been applied to the specified resource. Tags are mapped
from the tag key to the tag value: "TagKey" : "TagValue".
- Format example:
{"tag1" : "value1", "tag2" : "value2"}
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
ListTrackerConsumers (Paginated)
data ListTrackerConsumers Source #
See: newListTrackerConsumers smart constructor.
Instances
newListTrackerConsumers Source #
Arguments
| :: Text | |
| -> ListTrackerConsumers |
Create a value of ListTrackerConsumers 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:
ListTrackerConsumers, listTrackerConsumers_maxResults - An optional limit for the number of resources returned in a single call.
Default value: 100
ListTrackerConsumers, listTrackerConsumers_nextToken - The pagination token specifying which page of results to return in the
response. If no token is provided, the default page is the first page.
Default value: null
ListTrackerConsumers, listTrackerConsumers_trackerName - The tracker resource whose associated geofence collections you want to
list.
data ListTrackerConsumersResponse Source #
See: newListTrackerConsumersResponse smart constructor.
Constructors
| ListTrackerConsumersResponse' (Maybe Text) Int [Text] |
Instances
newListTrackerConsumersResponse Source #
Create a value of ListTrackerConsumersResponse 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:
ListTrackerConsumers, listTrackerConsumersResponse_nextToken - A pagination token indicating there are additional pages available. You
can use the token in a following request to fetch the next set of
results.
$sel:httpStatus:ListTrackerConsumersResponse', listTrackerConsumersResponse_httpStatus - The response's http status code.
$sel:consumerArns:ListTrackerConsumersResponse', listTrackerConsumersResponse_consumerArns - Contains the list of geofence collection ARNs associated to the tracker
resource.
ListTrackers (Paginated)
data ListTrackers Source #
See: newListTrackers smart constructor.
Constructors
| ListTrackers' (Maybe Natural) (Maybe Text) |
Instances
newListTrackers :: ListTrackers Source #
Create a value of ListTrackers 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:
ListTrackers, listTrackers_maxResults - An optional limit for the number of resources returned in a single call.
Default value: 100
ListTrackers, listTrackers_nextToken - The pagination token specifying which page of results to return in the
response. If no token is provided, the default page is the first page.
Default value: null
data ListTrackersResponse Source #
See: newListTrackersResponse smart constructor.
Constructors
| ListTrackersResponse' (Maybe Text) Int [ListTrackersResponseEntry] |
Instances
newListTrackersResponse Source #
Arguments
| :: Int | |
| -> ListTrackersResponse |
Create a value of ListTrackersResponse 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:
ListTrackers, listTrackersResponse_nextToken - A pagination token indicating there are additional pages available. You
can use the token in a following request to fetch the next set of
results.
$sel:httpStatus:ListTrackersResponse', listTrackersResponse_httpStatus - The response's http status code.
$sel:entries:ListTrackersResponse', listTrackersResponse_entries - Contains tracker resources in your AWS account. Details include tracker
name, description and timestamps for when the tracker was created and
last updated.
PutGeofence
data PutGeofence Source #
See: newPutGeofence smart constructor.
Constructors
| PutGeofence' Text Text GeofenceGeometry |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> GeofenceGeometry | |
| -> PutGeofence |
Create a value of PutGeofence 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:
PutGeofence, putGeofence_collectionName - The geofence collection to store the geofence in.
PutGeofence, putGeofence_geofenceId - An identifier for the geofence. For example, ExampleGeofence-1.
PutGeofence, putGeofence_geometry - Contains the details to specify 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.
data PutGeofenceResponse Source #
See: newPutGeofenceResponse smart constructor.
Constructors
| PutGeofenceResponse' Int ISO8601 Text ISO8601 |
Instances
newPutGeofenceResponse Source #
Arguments
| :: Int | |
| -> UTCTime | |
| -> Text | |
| -> UTCTime | |
| -> PutGeofenceResponse |
Create a value of PutGeofenceResponse 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:httpStatus:PutGeofenceResponse', putGeofenceResponse_httpStatus - The response's http status code.
PutGeofenceResponse, putGeofenceResponse_createTime - The timestamp for when the geofence was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
PutGeofence, putGeofenceResponse_geofenceId - The geofence identifier entered in the request.
PutGeofenceResponse, putGeofenceResponse_updateTime - The timestamp for when the geofence was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
SearchPlaceIndexForPosition
data SearchPlaceIndexForPosition Source #
See: newSearchPlaceIndexForPosition smart constructor.
Constructors
| SearchPlaceIndexForPosition' (Maybe Text) (Maybe Natural) Text (Sensitive (NonEmpty Double)) |
Instances
newSearchPlaceIndexForPosition Source #
Arguments
| :: Text | |
| -> NonEmpty Double | |
| -> SearchPlaceIndexForPosition |
Create a value of SearchPlaceIndexForPosition 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:
SearchPlaceIndexForPosition, searchPlaceIndexForPosition_language - The preferred language used to return results. The value must be a valid
BCP 47 language tag, for example,
en for English.
This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.
For an example, we'll use the Greek language. You search for a location
around Athens, Greece, with the language parameter set to en. The
city in the results will most likely be returned as Athens.
If you set the language parameter to el, for Greek, then the city
in the results will more likely be returned as Αθήνα.
If the data provider does not have a value for Greek, the result will be in a language that the provider does support.
SearchPlaceIndexForPosition, searchPlaceIndexForPosition_maxResults - An optional parameter. The maximum number of results returned per
request.
Default value: 50
SearchPlaceIndexForPosition, searchPlaceIndexForPosition_indexName - The name of the place index resource you want to use for the search.
SearchPlaceIndexForPosition, searchPlaceIndexForPosition_position - Specifies the longitude and latitude of the position to query.
This parameter must contain 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 a position with longitude
-123.1174 and latitude 49.2847.
data SearchPlaceIndexForPositionResponse Source #
See: newSearchPlaceIndexForPositionResponse smart constructor.
Constructors
| SearchPlaceIndexForPositionResponse' Int [SearchForPositionResult] SearchPlaceIndexForPositionSummary |
Instances
newSearchPlaceIndexForPositionResponse Source #
Arguments
| :: Int | |
| -> SearchPlaceIndexForPositionSummary | |
| -> SearchPlaceIndexForPositionResponse |
Create a value of SearchPlaceIndexForPositionResponse 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:httpStatus:SearchPlaceIndexForPositionResponse', searchPlaceIndexForPositionResponse_httpStatus - The response's http status code.
$sel:results:SearchPlaceIndexForPositionResponse', searchPlaceIndexForPositionResponse_results - Returns a list of Places closest to the specified position. Each result
contains additional information about the Places returned.
$sel:summary:SearchPlaceIndexForPositionResponse', searchPlaceIndexForPositionResponse_summary - Contains a summary of the request. Echoes the input values for
Position, Language, MaxResults, and the DataSource of the place
index.
SearchPlaceIndexForSuggestions
data SearchPlaceIndexForSuggestions Source #
See: newSearchPlaceIndexForSuggestions smart constructor.
Constructors
| SearchPlaceIndexForSuggestions' (Maybe (Sensitive (NonEmpty Double))) (Maybe (Sensitive (NonEmpty Double))) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Natural) Text (Sensitive Text) |
Instances
newSearchPlaceIndexForSuggestions Source #
Arguments
| :: Text | |
| -> Text | |
| -> SearchPlaceIndexForSuggestions |
Create a value of SearchPlaceIndexForSuggestions 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:
SearchPlaceIndexForSuggestions, searchPlaceIndexForSuggestions_biasPosition - An optional parameter that indicates a preference for place suggestions
that are closer to a specified position.
If provided, this parameter must contain 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.
BiasPosition and FilterBBox are mutually exclusive. Specifying both
options results in an error.
SearchPlaceIndexForSuggestions, searchPlaceIndexForSuggestions_filterBBox - An optional parameter that limits the search results by returning only
suggestions within a specified bounding box.
If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.
For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a
bounding box where the southwest corner has longitude -12.7935 and
latitude -37.4835, and the northeast corner has longitude -12.0684
and latitude -36.9542.
FilterBBox and BiasPosition are mutually exclusive. Specifying both
options results in an error.
SearchPlaceIndexForSuggestions, searchPlaceIndexForSuggestions_filterCountries - An optional parameter that limits the search results by returning only
suggestions within the provided list of countries.
- Use the ISO 3166
3-digit country code. For example, Australia uses three upper-case
characters:
AUS.
SearchPlaceIndexForSuggestions, searchPlaceIndexForSuggestions_language - The preferred language used to return results. The value must be a valid
BCP 47 language tag, for example,
en for English.
This setting affects the languages used in the results. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.
For an example, we'll use the Greek language. You search for
Athens, Gr to get suggestions with the language parameter set to
en. The results found will most likely be returned as
Athens, Greece.
If you set the language parameter to el, for Greek, then the result
found will more likely be returned as Αθήνα, Ελλάδα.
If the data provider does not have a value for Greek, the result will be in a language that the provider does support.
SearchPlaceIndexForSuggestions, searchPlaceIndexForSuggestions_maxResults - An optional parameter. The maximum number of results returned per
request.
The default: 5
SearchPlaceIndexForSuggestions, searchPlaceIndexForSuggestions_indexName - The name of the place index resource you want to use for the search.
SearchPlaceIndexForSuggestions, searchPlaceIndexForSuggestions_text - The free-form partial text to use to generate place suggestions. For
example, eiffel tow.
data SearchPlaceIndexForSuggestionsResponse Source #
See: newSearchPlaceIndexForSuggestionsResponse smart constructor.
Constructors
| SearchPlaceIndexForSuggestionsResponse' Int [SearchForSuggestionsResult] SearchPlaceIndexForSuggestionsSummary |
Instances
newSearchPlaceIndexForSuggestionsResponse Source #
Create a value of SearchPlaceIndexForSuggestionsResponse 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:httpStatus:SearchPlaceIndexForSuggestionsResponse', searchPlaceIndexForSuggestionsResponse_httpStatus - The response's http status code.
$sel:results:SearchPlaceIndexForSuggestionsResponse', searchPlaceIndexForSuggestionsResponse_results - A list of place suggestions that best match the search text.
$sel:summary:SearchPlaceIndexForSuggestionsResponse', searchPlaceIndexForSuggestionsResponse_summary - Contains a summary of the request. Echoes the input values for
BiasPosition, FilterBBox, FilterCountries, Language,
MaxResults, and Text. Also includes the DataSource of the place
index.
SearchPlaceIndexForText
data SearchPlaceIndexForText Source #
See: newSearchPlaceIndexForText smart constructor.
Constructors
| SearchPlaceIndexForText' (Maybe (Sensitive (NonEmpty Double))) (Maybe (Sensitive (NonEmpty Double))) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Natural) Text (Sensitive Text) |
Instances
newSearchPlaceIndexForText Source #
Create a value of SearchPlaceIndexForText 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:
SearchPlaceIndexForText, searchPlaceIndexForText_biasPosition - An optional parameter that indicates a preference for places that are
closer to a specified position.
If provided, this parameter must contain 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.
BiasPosition and FilterBBox are mutually exclusive. Specifying both
options results in an error.
SearchPlaceIndexForText, searchPlaceIndexForText_filterBBox - An optional parameter that limits the search results by returning only
places that are within the provided bounding box.
If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.
For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a
bounding box where the southwest corner has longitude -12.7935 and
latitude -37.4835, and the northeast corner has longitude -12.0684
and latitude -36.9542.
FilterBBox and BiasPosition are mutually exclusive. Specifying both
options results in an error.
SearchPlaceIndexForText, searchPlaceIndexForText_filterCountries - An optional parameter that limits the search results by returning only
places that are in a specified list of countries.
- Valid values include
ISO 3166 3-digit
country codes. For example, Australia uses three upper-case
characters:
AUS.
SearchPlaceIndexForText, searchPlaceIndexForText_language - The preferred language used to return results. The value must be a valid
BCP 47 language tag, for example,
en for English.
This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.
For an example, we'll use the Greek language. You search for
Athens, Greece, with the language parameter set to en. The result
found will most likely be returned as Athens.
If you set the language parameter to el, for Greek, then the result
found will more likely be returned as Αθήνα.
If the data provider does not have a value for Greek, the result will be in a language that the provider does support.
SearchPlaceIndexForText, searchPlaceIndexForText_maxResults - An optional parameter. The maximum number of results returned per
request.
The default: 50
SearchPlaceIndexForText, searchPlaceIndexForText_indexName - The name of the place index resource you want to use for the search.
SearchPlaceIndexForText, searchPlaceIndexForText_text - The address, name, city, or region to be used in the search in free-form
text format. For example, 123 Any Street.
data SearchPlaceIndexForTextResponse Source #
See: newSearchPlaceIndexForTextResponse smart constructor.
Constructors
| SearchPlaceIndexForTextResponse' Int [SearchForTextResult] SearchPlaceIndexForTextSummary |
Instances
newSearchPlaceIndexForTextResponse Source #
Arguments
| :: Int | |
| -> SearchPlaceIndexForTextSummary | |
| -> SearchPlaceIndexForTextResponse |
Create a value of SearchPlaceIndexForTextResponse 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:httpStatus:SearchPlaceIndexForTextResponse', searchPlaceIndexForTextResponse_httpStatus - The response's http status code.
$sel:results:SearchPlaceIndexForTextResponse', searchPlaceIndexForTextResponse_results - A list of Places matching the input text. Each result contains
additional information about the specific point of interest.
Not all response properties are included with all responses. Some properties may only be returned by specific data partners.
$sel:summary:SearchPlaceIndexForTextResponse', searchPlaceIndexForTextResponse_summary - Contains a summary of the request. Echoes the input values for
BiasPosition, FilterBBox, FilterCountries, Language,
MaxResults, and Text. Also includes the DataSource of the place
index and the bounding box, ResultBBox, which surrounds the search
results.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text (HashMap Text Text) |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource 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:resourceArn:TagResource', tagResource_resourceArn - The Amazon Resource Name (ARN) of the resource whose tags you want to
update.
- Format example:
arn:aws:geo:region:account-id:resourcetype/ExampleResource
$sel:tags:TagResource', tagResource_tags - Applies one or more tags to specific resource. A tag is a key-value pair
that helps you manage, identify, search, and filter your resources.
Format: "key" : "value"
Restrictions:
- Maximum 50 tags per resource.
- Each tag key must be unique and must have exactly one associated value.
- Maximum key length: 128 Unicode characters in UTF-8.
- Maximum value length: 256 Unicode characters in UTF-8.
- Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @
- Cannot use "aws:" as a prefix for a key.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse 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:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text (NonEmpty Text) |
Instances
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> UntagResource |
Create a value of UntagResource 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:resourceArn:UntagResource', untagResource_resourceArn - The Amazon Resource Name (ARN) of the resource from which you want to
remove tags.
- Format example:
arn:aws:geo:region:account-id:resourcetype/ExampleResource
$sel:tagKeys:UntagResource', untagResource_tagKeys - The list of tag keys to remove from the specified resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse 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:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
UpdateGeofenceCollection
data UpdateGeofenceCollection Source #
See: newUpdateGeofenceCollection smart constructor.
Constructors
| UpdateGeofenceCollection' (Maybe Text) (Maybe PricingPlan) (Maybe Text) Text |
Instances
newUpdateGeofenceCollection Source #
Arguments
| :: Text | |
| -> UpdateGeofenceCollection |
Create a value of UpdateGeofenceCollection 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:
UpdateGeofenceCollection, updateGeofenceCollection_description - Updates the description for the geofence collection.
UpdateGeofenceCollection, updateGeofenceCollection_pricingPlan - No longer used. If included, the only allowed value is
RequestBasedUsage.
UpdateGeofenceCollection, updateGeofenceCollection_pricingPlanDataSource - This parameter is no longer used.
UpdateGeofenceCollection, updateGeofenceCollection_collectionName - The name of the geofence collection to update.
data UpdateGeofenceCollectionResponse Source #
See: newUpdateGeofenceCollectionResponse smart constructor.
Constructors
| UpdateGeofenceCollectionResponse' Int Text Text ISO8601 |
Instances
newUpdateGeofenceCollectionResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> UTCTime | |
| -> UpdateGeofenceCollectionResponse |
Create a value of UpdateGeofenceCollectionResponse 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:httpStatus:UpdateGeofenceCollectionResponse', updateGeofenceCollectionResponse_httpStatus - The response's http status code.
$sel:collectionArn:UpdateGeofenceCollectionResponse', updateGeofenceCollectionResponse_collectionArn - The Amazon Resource Name (ARN) of the updated geofence collection. Used
to specify a resource across AWS.
- Format example:
arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection
UpdateGeofenceCollection, updateGeofenceCollectionResponse_collectionName - The name of the updated geofence collection.
UpdateGeofenceCollectionResponse, updateGeofenceCollectionResponse_updateTime - The time when the geofence collection was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
UpdateMap
See: newUpdateMap smart constructor.
Constructors
| UpdateMap' (Maybe Text) (Maybe PricingPlan) Text |
Instances
Create a value of UpdateMap 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:
UpdateMap, updateMap_description - Updates the description for the map resource.
UpdateMap, updateMap_pricingPlan - No longer used. If included, the only allowed value is
RequestBasedUsage.
UpdateMap, updateMap_mapName - The name of the map resource to update.
data UpdateMapResponse Source #
See: newUpdateMapResponse smart constructor.
Constructors
| UpdateMapResponse' Int Text Text ISO8601 |
Instances
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> UTCTime | |
| -> UpdateMapResponse |
Create a value of UpdateMapResponse 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:httpStatus:UpdateMapResponse', updateMapResponse_httpStatus - The response's http status code.
$sel:mapArn:UpdateMapResponse', updateMapResponse_mapArn - The Amazon Resource Name (ARN) of the updated map resource. Used to
specify a resource across AWS.
- Format example:
arn:aws:geo:region:account-id:map/ExampleMap
UpdateMap, updateMapResponse_mapName - The name of the updated map resource.
UpdateMapResponse, updateMapResponse_updateTime - The timestamp for when the map resource was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
UpdatePlaceIndex
data UpdatePlaceIndex Source #
See: newUpdatePlaceIndex smart constructor.
Constructors
| UpdatePlaceIndex' (Maybe DataSourceConfiguration) (Maybe Text) (Maybe PricingPlan) Text |
Instances
Arguments
| :: Text | |
| -> UpdatePlaceIndex |
Create a value of UpdatePlaceIndex 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:dataSourceConfiguration:UpdatePlaceIndex', updatePlaceIndex_dataSourceConfiguration - Updates the data storage option for the place index resource.
UpdatePlaceIndex, updatePlaceIndex_description - Updates the description for the place index resource.
UpdatePlaceIndex, updatePlaceIndex_pricingPlan - No longer used. If included, the only allowed value is
RequestBasedUsage.
UpdatePlaceIndex, updatePlaceIndex_indexName - The name of the place index resource to update.
data UpdatePlaceIndexResponse Source #
See: newUpdatePlaceIndexResponse smart constructor.
Constructors
| UpdatePlaceIndexResponse' Int Text Text ISO8601 |
Instances
newUpdatePlaceIndexResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> UTCTime | |
| -> UpdatePlaceIndexResponse |
Create a value of UpdatePlaceIndexResponse 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:httpStatus:UpdatePlaceIndexResponse', updatePlaceIndexResponse_httpStatus - The response's http status code.
$sel:indexArn:UpdatePlaceIndexResponse', updatePlaceIndexResponse_indexArn - The Amazon Resource Name (ARN) of the upated place index resource. Used
to specify a resource across AWS.
- Format example:
arn:aws:geo:region:account-id:place- index/ExamplePlaceIndex
UpdatePlaceIndex, updatePlaceIndexResponse_indexName - The name of the updated place index resource.
UpdatePlaceIndexResponse, updatePlaceIndexResponse_updateTime - The timestamp for when the place index resource was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
UpdateRouteCalculator
data UpdateRouteCalculator Source #
See: newUpdateRouteCalculator smart constructor.
Constructors
| UpdateRouteCalculator' (Maybe Text) (Maybe PricingPlan) Text |
Instances
newUpdateRouteCalculator Source #
Arguments
| :: Text | |
| -> UpdateRouteCalculator |
Create a value of UpdateRouteCalculator 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:
UpdateRouteCalculator, updateRouteCalculator_description - Updates the description for the route calculator resource.
UpdateRouteCalculator, updateRouteCalculator_pricingPlan - No longer used. If included, the only allowed value is
RequestBasedUsage.
UpdateRouteCalculator, updateRouteCalculator_calculatorName - The name of the route calculator resource to update.
data UpdateRouteCalculatorResponse Source #
See: newUpdateRouteCalculatorResponse smart constructor.
Constructors
| UpdateRouteCalculatorResponse' Int Text Text ISO8601 |
Instances
newUpdateRouteCalculatorResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> UTCTime | |
| -> UpdateRouteCalculatorResponse |
Create a value of UpdateRouteCalculatorResponse 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:httpStatus:UpdateRouteCalculatorResponse', updateRouteCalculatorResponse_httpStatus - The response's http status code.
$sel:calculatorArn:UpdateRouteCalculatorResponse', updateRouteCalculatorResponse_calculatorArn - The Amazon Resource Name (ARN) of the updated route calculator resource.
Used to specify a resource across AWS.
- Format example:
arn:aws:geo:region:account-id:route- calculator/ExampleCalculator
UpdateRouteCalculator, updateRouteCalculatorResponse_calculatorName - The name of the updated route calculator resource.
UpdateRouteCalculatorResponse, updateRouteCalculatorResponse_updateTime - The timestamp for when the route calculator was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
UpdateTracker
data UpdateTracker Source #
See: newUpdateTracker smart constructor.
Constructors
| UpdateTracker' (Maybe Text) (Maybe PositionFiltering) (Maybe PricingPlan) (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> UpdateTracker |
Create a value of UpdateTracker 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:
UpdateTracker, updateTracker_description - Updates the description for the tracker resource.
$sel:positionFiltering:UpdateTracker', updateTracker_positionFiltering - Updates the position filtering for the tracker resource.
Valid values:
TimeBased- Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID.DistanceBased- If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.AccuracyBased- If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This helps educe the effects of GPS noise when displaying device trajectories on a map, and can help control costs by reducing the number of geofence evaluations.
UpdateTracker, updateTracker_pricingPlan - No longer used. If included, the only allowed value is
RequestBasedUsage.
UpdateTracker, updateTracker_pricingPlanDataSource - This parameter is no longer used.
UpdateTracker, updateTracker_trackerName - The name of the tracker resource to update.
data UpdateTrackerResponse Source #
See: newUpdateTrackerResponse smart constructor.
Constructors
| UpdateTrackerResponse' Int Text Text ISO8601 |
Instances
newUpdateTrackerResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> UTCTime | |
| -> UpdateTrackerResponse |
Create a value of UpdateTrackerResponse 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:httpStatus:UpdateTrackerResponse', updateTrackerResponse_httpStatus - The response's http status code.
$sel:trackerArn:UpdateTrackerResponse', updateTrackerResponse_trackerArn - The Amazon Resource Name (ARN) of the updated tracker resource. Used to
specify a resource across AWS.
- Format example:
arn:aws:geo:region:account-id:tracker/ExampleTracker
UpdateTracker, updateTrackerResponse_trackerName - The name of the updated tracker resource.
UpdateTrackerResponse, updateTrackerResponse_updateTime - The timestamp for when the tracker resource was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ.
Types
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' Text BatchItemError |
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.
BatchDeleteGeofenceError
data BatchDeleteGeofenceError Source #
Contains error details for each geofence that failed to delete from the geofence collection.
See: newBatchDeleteGeofenceError smart constructor.
Constructors
| BatchDeleteGeofenceError' BatchItemError Text |
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.
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' Text BatchItemError ISO8601 |
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
BatchGetDevicePositionError
data BatchGetDevicePositionError Source #
Contains error details for each device that didn't return a position.
See: newBatchGetDevicePositionError smart constructor.
Constructors
| BatchGetDevicePositionError' Text BatchItemError |
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.
BatchItemError
data BatchItemError Source #
Contains the batch request error details associated with the request.
See: newBatchItemError smart constructor.
Constructors
| BatchItemError' (Maybe BatchItemErrorCode) (Maybe Text) |
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.
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' BatchItemError Text |
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.
BatchPutGeofenceRequestEntry
data BatchPutGeofenceRequestEntry Source #
Contains geofence geometry details.
See: newBatchPutGeofenceRequestEntry smart constructor.
Constructors
| BatchPutGeofenceRequestEntry' Text GeofenceGeometry |
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.
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' ISO8601 Text ISO8601 |
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
BatchUpdateDevicePositionError
data BatchUpdateDevicePositionError Source #
Contains error details for each device that failed to update its position.
See: newBatchUpdateDevicePositionError smart constructor.
Constructors
| BatchUpdateDevicePositionError' Text BatchItemError ISO8601 |
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.
CalculateRouteCarModeOptions
data CalculateRouteCarModeOptions Source #
Contains details about additional route preferences for requests that
specify TravelMode as Car.
See: newCalculateRouteCarModeOptions smart constructor.
Constructors
| CalculateRouteCarModeOptions' (Maybe Bool) (Maybe Bool) |
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
CalculateRouteMatrixSummary
data CalculateRouteMatrixSummary Source #
A summary of the calculated route matrix.
See: newCalculateRouteMatrixSummary smart constructor.
Constructors
| CalculateRouteMatrixSummary' Text DistanceUnit Natural Natural |
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.
CalculateRouteSummary
data CalculateRouteSummary Source #
A summary of the calculated route.
See: newCalculateRouteSummary smart constructor.
Constructors
| CalculateRouteSummary' Text Double DistanceUnit Double (Sensitive (NonEmpty Double)) |
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.
CalculateRouteTruckModeOptions
data CalculateRouteTruckModeOptions Source #
Contains details about additional route preferences for requests that
specify TravelMode as Truck.
See: newCalculateRouteTruckModeOptions smart constructor.
Constructors
| CalculateRouteTruckModeOptions' (Maybe Bool) (Maybe Bool) (Maybe TruckDimensions) (Maybe TruckWeight) |
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.
Circle
A circle on the earth, as defined by a center point and a radius.
See: newCircle smart constructor.
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).
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' (Maybe IntendedUse) |
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
DevicePosition
data DevicePosition Source #
Contains the device position details.
See: newDevicePosition smart constructor.
Constructors
| DevicePosition' (Maybe PositionalAccuracy) (Maybe Text) (Maybe (Sensitive (HashMap Text Text))) (Sensitive (NonEmpty Double)) ISO8601 ISO8601 |
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.
DevicePositionUpdate
data DevicePositionUpdate Source #
Contains the position update details for a device.
See: newDevicePositionUpdate smart constructor.
Constructors
| DevicePositionUpdate' (Maybe PositionalAccuracy) (Maybe (Sensitive (HashMap Text Text))) Text (Sensitive (NonEmpty Double)) ISO8601 |
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
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' (Maybe (Sensitive Circle)) (Maybe (NonEmpty (NonEmpty (Sensitive (NonEmpty Double))))) |
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.
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' (Maybe LegGeometry) Double Double (Sensitive (NonEmpty Double)) (Sensitive (NonEmpty Double)) [Step] |
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.
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.
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]]
ListDevicePositionsResponseEntry
data ListDevicePositionsResponseEntry Source #
Contains the tracker resource details.
See: newListDevicePositionsResponseEntry smart constructor.
Constructors
| ListDevicePositionsResponseEntry' (Maybe PositionalAccuracy) (Maybe (Sensitive (HashMap Text Text))) Text (Sensitive (NonEmpty Double)) ISO8601 |
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.
ListGeofenceCollectionsResponseEntry
data ListGeofenceCollectionsResponseEntry Source #
Contains the geofence collection details.
See: newListGeofenceCollectionsResponseEntry smart constructor.
Constructors
| ListGeofenceCollectionsResponseEntry' (Maybe PricingPlan) (Maybe Text) Text ISO8601 Text ISO8601 |
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
ListGeofenceResponseEntry
data ListGeofenceResponseEntry Source #
Contains a list of geofences stored in a given geofence collection.
See: newListGeofenceResponseEntry smart constructor.
Constructors
| ListGeofenceResponseEntry' ISO8601 Text GeofenceGeometry Text ISO8601 |
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
ListMapsResponseEntry
data ListMapsResponseEntry Source #
Contains details of an existing map resource in your AWS account.
See: newListMapsResponseEntry smart constructor.
Constructors
| ListMapsResponseEntry' (Maybe PricingPlan) ISO8601 Text Text Text ISO8601 |
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.
ListPlaceIndexesResponseEntry
data ListPlaceIndexesResponseEntry Source #
A place index resource listed in your AWS account.
See: newListPlaceIndexesResponseEntry smart constructor.
Constructors
| ListPlaceIndexesResponseEntry' (Maybe PricingPlan) ISO8601 Text Text Text ISO8601 |
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.
ListRouteCalculatorsResponseEntry
data ListRouteCalculatorsResponseEntry Source #
A route calculator resource listed in your AWS account.
See: newListRouteCalculatorsResponseEntry smart constructor.
Constructors
| ListRouteCalculatorsResponseEntry' (Maybe PricingPlan) Text ISO8601 Text Text ISO8601 |
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
ListTrackersResponseEntry
data ListTrackersResponseEntry Source #
Contains the tracker resource details.
See: newListTrackersResponseEntry smart constructor.
Constructors
| ListTrackersResponseEntry' (Maybe PricingPlan) (Maybe Text) ISO8601 Text Text ISO8601 |
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.
MapConfiguration
data MapConfiguration Source #
Specifies the map tile style selected from an available provider.
See: newMapConfiguration smart constructor.
Constructors
| MapConfiguration' Text |
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.
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' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe TimeZone) (Maybe Text) (Maybe Text) PlaceGeometry |
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.
PlaceGeometry
data PlaceGeometry Source #
Places uses a point geometry to specify a location or a Place.
See: newPlaceGeometry smart constructor.
Constructors
| PlaceGeometry' (Maybe (Sensitive (NonEmpty Double))) |
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.
PositionalAccuracy
data PositionalAccuracy Source #
Defines the level of certainty of the position.
See: newPositionalAccuracy smart constructor.
Constructors
| PositionalAccuracy' Double |
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.
RouteMatrixEntry
data RouteMatrixEntry Source #
The result for the calculated route of one DeparturePosition
DestinationPosition pair.
See: newRouteMatrixEntry smart constructor.
Constructors
| RouteMatrixEntry' (Maybe Double) (Maybe Double) (Maybe RouteMatrixEntryError) |
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.
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' (Maybe Text) RouteMatrixErrorCode |
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.
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' (Maybe Text) Double Place |
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.
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' (Maybe Text) Text |
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.
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.
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.
SearchPlaceIndexForPositionSummary
data SearchPlaceIndexForPositionSummary Source #
A summary of the request sent by using SearchPlaceIndexForPosition.
See: newSearchPlaceIndexForPositionSummary smart constructor.
Constructors
| SearchPlaceIndexForPositionSummary' (Maybe Text) (Maybe Natural) Text (Sensitive (NonEmpty Double)) |
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.
SearchPlaceIndexForSuggestionsSummary
data SearchPlaceIndexForSuggestionsSummary Source #
A summary of the request sent by using SearchPlaceIndexForSuggestions.
See: newSearchPlaceIndexForSuggestionsSummary smart constructor.
Constructors
| SearchPlaceIndexForSuggestionsSummary' (Maybe (Sensitive (NonEmpty Double))) (Maybe (Sensitive (NonEmpty Double))) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Int) Text (Sensitive Text) |
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.
SearchPlaceIndexForTextSummary
data SearchPlaceIndexForTextSummary Source #
A summary of the request sent by using SearchPlaceIndexForText.
See: newSearchPlaceIndexForTextSummary smart constructor.
Constructors
| SearchPlaceIndexForTextSummary' (Maybe (Sensitive (NonEmpty Double))) (Maybe (Sensitive (NonEmpty Double))) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Natural) (Maybe (Sensitive (NonEmpty Double))) Text (Sensitive Text) |
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.
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' (Maybe Natural) Double Double (Sensitive (NonEmpty Double)) (Sensitive (NonEmpty Double)) |
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.
TimeZone
Information about a time zone. Includes the name of the time zone and the offset from UTC in seconds.
See: newTimeZone smart constructor.
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.
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' (Maybe Double) (Maybe Double) (Maybe DimensionUnit) (Maybe Double) |
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.
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' (Maybe Double) (Maybe VehicleWeightUnit) |
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