Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
- Service Configuration
- Errors
- Waiters
- Operations
- BatchUpdateDevicePosition
- DeleteRouteCalculator
- UpdateRouteCalculator
- CreateGeofenceCollection
- ListRouteCalculators (Paginated)
- CreateTracker
- ListTrackerConsumers (Paginated)
- GetDevicePosition
- ListTagsForResource
- SearchPlaceIndexForText
- DescribeGeofenceCollection
- ListMaps (Paginated)
- GetMapSprites
- CreateMap
- DescribeRouteCalculator
- BatchGetDevicePosition
- GetMapStyleDescriptor
- GetMapTile
- ListGeofenceCollections (Paginated)
- DeleteGeofenceCollection
- UpdateGeofenceCollection
- ListTrackers (Paginated)
- DeletePlaceIndex
- UpdatePlaceIndex
- DisassociateTrackerConsumer
- PutGeofence
- ListGeofences (Paginated)
- AssociateTrackerConsumer
- BatchEvaluateGeofences
- CalculateRoute
- DeleteMap
- UpdateMap
- GetDevicePositionHistory (Paginated)
- DescribeTracker
- DescribePlaceIndex
- GetGeofence
- ListDevicePositions (Paginated)
- TagResource
- GetMapGlyphs
- BatchPutGeofence
- BatchDeleteGeofence
- UntagResource
- BatchDeleteDevicePositionHistory
- ListPlaceIndexes (Paginated)
- SearchPlaceIndexForPosition
- DeleteTracker
- CreatePlaceIndex
- UpdateTracker
- CreateRouteCalculator
- DescribeMap
- Types
- BatchItemErrorCode
- DimensionUnit
- DistanceUnit
- IntendedUse
- PositionFiltering
- PricingPlan
- TravelMode
- VehicleWeightUnit
- BatchDeleteDevicePositionHistoryError
- BatchDeleteGeofenceError
- BatchEvaluateGeofencesError
- BatchGetDevicePositionError
- BatchItemError
- BatchPutGeofenceError
- BatchPutGeofenceRequestEntry
- BatchPutGeofenceSuccess
- BatchUpdateDevicePositionError
- CalculateRouteCarModeOptions
- CalculateRouteSummary
- CalculateRouteTruckModeOptions
- DataSourceConfiguration
- DevicePosition
- DevicePositionUpdate
- GeofenceGeometry
- Leg
- LegGeometry
- ListDevicePositionsResponseEntry
- ListGeofenceCollectionsResponseEntry
- ListGeofenceResponseEntry
- ListMapsResponseEntry
- ListPlaceIndexesResponseEntry
- ListRouteCalculatorsResponseEntry
- ListTrackersResponseEntry
- MapConfiguration
- Place
- PlaceGeometry
- SearchForPositionResult
- SearchForTextResult
- SearchPlaceIndexForPositionSummary
- SearchPlaceIndexForTextSummary
- Step
- TruckDimensions
- TruckWeight
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
- _ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConflictException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- data BatchUpdateDevicePosition = BatchUpdateDevicePosition' Text (NonEmpty DevicePositionUpdate)
- newBatchUpdateDevicePosition :: Text -> NonEmpty DevicePositionUpdate -> BatchUpdateDevicePosition
- data BatchUpdateDevicePositionResponse = BatchUpdateDevicePositionResponse' Int [BatchUpdateDevicePositionError]
- newBatchUpdateDevicePositionResponse :: Int -> BatchUpdateDevicePositionResponse
- data DeleteRouteCalculator = DeleteRouteCalculator' Text
- newDeleteRouteCalculator :: Text -> DeleteRouteCalculator
- data DeleteRouteCalculatorResponse = DeleteRouteCalculatorResponse' Int
- newDeleteRouteCalculatorResponse :: Int -> DeleteRouteCalculatorResponse
- data UpdateRouteCalculator = UpdateRouteCalculator' (Maybe PricingPlan) (Maybe Text) Text
- newUpdateRouteCalculator :: Text -> UpdateRouteCalculator
- data UpdateRouteCalculatorResponse = UpdateRouteCalculatorResponse' Int Text Text POSIX
- newUpdateRouteCalculatorResponse :: Int -> Text -> Text -> UTCTime -> UpdateRouteCalculatorResponse
- data CreateGeofenceCollection = CreateGeofenceCollection' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Text PricingPlan
- newCreateGeofenceCollection :: Text -> PricingPlan -> CreateGeofenceCollection
- data CreateGeofenceCollectionResponse = CreateGeofenceCollectionResponse' Int Text Text POSIX
- newCreateGeofenceCollectionResponse :: Int -> Text -> Text -> UTCTime -> CreateGeofenceCollectionResponse
- data ListRouteCalculators = ListRouteCalculators' (Maybe Text) (Maybe Natural)
- newListRouteCalculators :: ListRouteCalculators
- data ListRouteCalculatorsResponse = ListRouteCalculatorsResponse' (Maybe Text) Int [ListRouteCalculatorsResponseEntry]
- newListRouteCalculatorsResponse :: Int -> ListRouteCalculatorsResponse
- data CreateTracker = CreateTracker' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe PositionFiltering) PricingPlan Text
- newCreateTracker :: PricingPlan -> Text -> CreateTracker
- data CreateTrackerResponse = CreateTrackerResponse' Int POSIX Text Text
- newCreateTrackerResponse :: Int -> UTCTime -> Text -> Text -> CreateTrackerResponse
- data ListTrackerConsumers = ListTrackerConsumers' (Maybe Text) (Maybe Natural) Text
- newListTrackerConsumers :: Text -> ListTrackerConsumers
- data ListTrackerConsumersResponse = ListTrackerConsumersResponse' (Maybe Text) Int [Text]
- newListTrackerConsumersResponse :: Int -> ListTrackerConsumersResponse
- data GetDevicePosition = GetDevicePosition' Text Text
- newGetDevicePosition :: Text -> Text -> GetDevicePosition
- data GetDevicePositionResponse = GetDevicePositionResponse' (Maybe Text) Int (Sensitive (NonEmpty Double)) POSIX POSIX
- newGetDevicePositionResponse :: Int -> NonEmpty Double -> UTCTime -> UTCTime -> GetDevicePositionResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data SearchPlaceIndexForText = SearchPlaceIndexForText' (Maybe (Sensitive (NonEmpty Double))) (Maybe (Sensitive (NonEmpty Double))) (Maybe (NonEmpty Text)) (Maybe Natural) Text (Sensitive Text)
- newSearchPlaceIndexForText :: Text -> Text -> SearchPlaceIndexForText
- data SearchPlaceIndexForTextResponse = SearchPlaceIndexForTextResponse' Int [SearchForTextResult] SearchPlaceIndexForTextSummary
- newSearchPlaceIndexForTextResponse :: Int -> SearchPlaceIndexForTextSummary -> SearchPlaceIndexForTextResponse
- data DescribeGeofenceCollection = DescribeGeofenceCollection' Text
- newDescribeGeofenceCollection :: Text -> DescribeGeofenceCollection
- data DescribeGeofenceCollectionResponse = DescribeGeofenceCollectionResponse' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Int Text Text POSIX Text PricingPlan POSIX
- newDescribeGeofenceCollectionResponse :: Int -> Text -> Text -> UTCTime -> Text -> PricingPlan -> UTCTime -> DescribeGeofenceCollectionResponse
- data ListMaps = ListMaps' (Maybe Text) (Maybe Natural)
- newListMaps :: ListMaps
- data ListMapsResponse = ListMapsResponse' (Maybe Text) Int [ListMapsResponseEntry]
- newListMapsResponse :: Int -> ListMapsResponse
- data GetMapSprites = GetMapSprites' Text Text
- newGetMapSprites :: Text -> Text -> GetMapSprites
- data GetMapSpritesResponse = GetMapSpritesResponse' (Maybe ByteString) (Maybe Text) Int
- newGetMapSpritesResponse :: Int -> GetMapSpritesResponse
- data CreateMap = CreateMap' (Maybe Text) (Maybe (HashMap Text Text)) MapConfiguration Text PricingPlan
- newCreateMap :: MapConfiguration -> Text -> PricingPlan -> CreateMap
- data CreateMapResponse = CreateMapResponse' Int POSIX Text Text
- newCreateMapResponse :: Int -> UTCTime -> Text -> Text -> CreateMapResponse
- data DescribeRouteCalculator = DescribeRouteCalculator' Text
- newDescribeRouteCalculator :: Text -> DescribeRouteCalculator
- data DescribeRouteCalculatorResponse = DescribeRouteCalculatorResponse' (Maybe (HashMap Text Text)) Int Text Text POSIX Text Text PricingPlan POSIX
- newDescribeRouteCalculatorResponse :: Int -> Text -> Text -> UTCTime -> Text -> Text -> PricingPlan -> UTCTime -> DescribeRouteCalculatorResponse
- data BatchGetDevicePosition = BatchGetDevicePosition' (NonEmpty Text) Text
- newBatchGetDevicePosition :: NonEmpty Text -> Text -> BatchGetDevicePosition
- data BatchGetDevicePositionResponse = BatchGetDevicePositionResponse' Int [DevicePosition] [BatchGetDevicePositionError]
- newBatchGetDevicePositionResponse :: Int -> BatchGetDevicePositionResponse
- 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 ListGeofenceCollections = ListGeofenceCollections' (Maybe Text) (Maybe Natural)
- newListGeofenceCollections :: ListGeofenceCollections
- data ListGeofenceCollectionsResponse = ListGeofenceCollectionsResponse' (Maybe Text) Int [ListGeofenceCollectionsResponseEntry]
- newListGeofenceCollectionsResponse :: Int -> ListGeofenceCollectionsResponse
- data DeleteGeofenceCollection = DeleteGeofenceCollection' Text
- newDeleteGeofenceCollection :: Text -> DeleteGeofenceCollection
- data DeleteGeofenceCollectionResponse = DeleteGeofenceCollectionResponse' Int
- newDeleteGeofenceCollectionResponse :: Int -> DeleteGeofenceCollectionResponse
- data UpdateGeofenceCollection = UpdateGeofenceCollection' (Maybe PricingPlan) (Maybe Text) (Maybe Text) Text
- newUpdateGeofenceCollection :: Text -> UpdateGeofenceCollection
- data UpdateGeofenceCollectionResponse = UpdateGeofenceCollectionResponse' Int Text Text POSIX
- newUpdateGeofenceCollectionResponse :: Int -> Text -> Text -> UTCTime -> UpdateGeofenceCollectionResponse
- data ListTrackers = ListTrackers' (Maybe Text) (Maybe Natural)
- newListTrackers :: ListTrackers
- data ListTrackersResponse = ListTrackersResponse' (Maybe Text) Int [ListTrackersResponseEntry]
- newListTrackersResponse :: Int -> ListTrackersResponse
- data DeletePlaceIndex = DeletePlaceIndex' Text
- newDeletePlaceIndex :: Text -> DeletePlaceIndex
- data DeletePlaceIndexResponse = DeletePlaceIndexResponse' Int
- newDeletePlaceIndexResponse :: Int -> DeletePlaceIndexResponse
- data UpdatePlaceIndex = UpdatePlaceIndex' (Maybe PricingPlan) (Maybe DataSourceConfiguration) (Maybe Text) Text
- newUpdatePlaceIndex :: Text -> UpdatePlaceIndex
- data UpdatePlaceIndexResponse = UpdatePlaceIndexResponse' Int Text Text POSIX
- newUpdatePlaceIndexResponse :: Int -> Text -> Text -> UTCTime -> UpdatePlaceIndexResponse
- data DisassociateTrackerConsumer = DisassociateTrackerConsumer' Text Text
- newDisassociateTrackerConsumer :: Text -> Text -> DisassociateTrackerConsumer
- data DisassociateTrackerConsumerResponse = DisassociateTrackerConsumerResponse' Int
- newDisassociateTrackerConsumerResponse :: Int -> DisassociateTrackerConsumerResponse
- data PutGeofence = PutGeofence' Text Text GeofenceGeometry
- newPutGeofence :: Text -> Text -> GeofenceGeometry -> PutGeofence
- data PutGeofenceResponse = PutGeofenceResponse' Int POSIX Text POSIX
- newPutGeofenceResponse :: Int -> UTCTime -> Text -> UTCTime -> PutGeofenceResponse
- data ListGeofences = ListGeofences' (Maybe Text) Text
- newListGeofences :: Text -> ListGeofences
- data ListGeofencesResponse = ListGeofencesResponse' (Maybe Text) Int [ListGeofenceResponseEntry]
- newListGeofencesResponse :: Int -> ListGeofencesResponse
- data AssociateTrackerConsumer = AssociateTrackerConsumer' Text Text
- newAssociateTrackerConsumer :: Text -> Text -> AssociateTrackerConsumer
- data AssociateTrackerConsumerResponse = AssociateTrackerConsumerResponse' Int
- newAssociateTrackerConsumerResponse :: Int -> AssociateTrackerConsumerResponse
- data BatchEvaluateGeofences = BatchEvaluateGeofences' Text (NonEmpty DevicePositionUpdate)
- newBatchEvaluateGeofences :: Text -> NonEmpty DevicePositionUpdate -> BatchEvaluateGeofences
- data BatchEvaluateGeofencesResponse = BatchEvaluateGeofencesResponse' Int [BatchEvaluateGeofencesError]
- newBatchEvaluateGeofencesResponse :: Int -> BatchEvaluateGeofencesResponse
- data CalculateRoute = CalculateRoute' (Maybe DistanceUnit) (Maybe CalculateRouteTruckModeOptions) (Maybe [Sensitive (NonEmpty Double)]) (Maybe Bool) (Maybe Bool) (Maybe TravelMode) (Maybe CalculateRouteCarModeOptions) (Maybe POSIX) 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 DeleteMap = DeleteMap' Text
- newDeleteMap :: Text -> DeleteMap
- data DeleteMapResponse = DeleteMapResponse' Int
- newDeleteMapResponse :: Int -> DeleteMapResponse
- data UpdateMap = UpdateMap' (Maybe PricingPlan) (Maybe Text) Text
- newUpdateMap :: Text -> UpdateMap
- data UpdateMapResponse = UpdateMapResponse' Int Text Text POSIX
- newUpdateMapResponse :: Int -> Text -> Text -> UTCTime -> UpdateMapResponse
- data GetDevicePositionHistory = GetDevicePositionHistory' (Maybe Text) (Maybe POSIX) (Maybe POSIX) Text Text
- newGetDevicePositionHistory :: Text -> Text -> GetDevicePositionHistory
- data GetDevicePositionHistoryResponse = GetDevicePositionHistoryResponse' (Maybe Text) Int [DevicePosition]
- newGetDevicePositionHistoryResponse :: Int -> GetDevicePositionHistoryResponse
- data DescribeTracker = DescribeTracker' Text
- newDescribeTracker :: Text -> DescribeTracker
- data DescribeTrackerResponse = DescribeTrackerResponse' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe PositionFiltering) Int POSIX Text PricingPlan Text Text POSIX
- newDescribeTrackerResponse :: Int -> UTCTime -> Text -> PricingPlan -> Text -> Text -> UTCTime -> DescribeTrackerResponse
- data DescribePlaceIndex = DescribePlaceIndex' Text
- newDescribePlaceIndex :: Text -> DescribePlaceIndex
- data DescribePlaceIndexResponse = DescribePlaceIndexResponse' (Maybe (HashMap Text Text)) Int POSIX Text DataSourceConfiguration Text Text Text PricingPlan POSIX
- newDescribePlaceIndexResponse :: Int -> UTCTime -> Text -> DataSourceConfiguration -> Text -> Text -> Text -> PricingPlan -> UTCTime -> DescribePlaceIndexResponse
- data GetGeofence = GetGeofence' Text Text
- newGetGeofence :: Text -> Text -> GetGeofence
- data GetGeofenceResponse = GetGeofenceResponse' Int POSIX Text GeofenceGeometry Text POSIX
- newGetGeofenceResponse :: Int -> UTCTime -> Text -> GeofenceGeometry -> Text -> UTCTime -> GetGeofenceResponse
- data ListDevicePositions = ListDevicePositions' (Maybe Text) (Maybe Natural) Text
- newListDevicePositions :: Text -> ListDevicePositions
- data ListDevicePositionsResponse = ListDevicePositionsResponse' (Maybe Text) Int [ListDevicePositionsResponseEntry]
- newListDevicePositionsResponse :: Int -> ListDevicePositionsResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data GetMapGlyphs = GetMapGlyphs' Text Text Text
- newGetMapGlyphs :: Text -> Text -> Text -> GetMapGlyphs
- data GetMapGlyphsResponse = GetMapGlyphsResponse' (Maybe ByteString) (Maybe Text) Int
- newGetMapGlyphsResponse :: Int -> GetMapGlyphsResponse
- data BatchPutGeofence = BatchPutGeofence' Text (NonEmpty BatchPutGeofenceRequestEntry)
- newBatchPutGeofence :: Text -> NonEmpty BatchPutGeofenceRequestEntry -> BatchPutGeofence
- data BatchPutGeofenceResponse = BatchPutGeofenceResponse' Int [BatchPutGeofenceError] [BatchPutGeofenceSuccess]
- newBatchPutGeofenceResponse :: Int -> BatchPutGeofenceResponse
- data BatchDeleteGeofence = BatchDeleteGeofence' Text (NonEmpty Text)
- newBatchDeleteGeofence :: Text -> NonEmpty Text -> BatchDeleteGeofence
- data BatchDeleteGeofenceResponse = BatchDeleteGeofenceResponse' Int [BatchDeleteGeofenceError]
- newBatchDeleteGeofenceResponse :: Int -> BatchDeleteGeofenceResponse
- data UntagResource = UntagResource' Text (NonEmpty Text)
- newUntagResource :: Text -> NonEmpty Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data BatchDeleteDevicePositionHistory = BatchDeleteDevicePositionHistory' (NonEmpty Text) Text
- newBatchDeleteDevicePositionHistory :: NonEmpty Text -> Text -> BatchDeleteDevicePositionHistory
- data BatchDeleteDevicePositionHistoryResponse = BatchDeleteDevicePositionHistoryResponse' Int [BatchDeleteDevicePositionHistoryError]
- newBatchDeleteDevicePositionHistoryResponse :: Int -> BatchDeleteDevicePositionHistoryResponse
- data ListPlaceIndexes = ListPlaceIndexes' (Maybe Text) (Maybe Natural)
- newListPlaceIndexes :: ListPlaceIndexes
- data ListPlaceIndexesResponse = ListPlaceIndexesResponse' (Maybe Text) Int [ListPlaceIndexesResponseEntry]
- newListPlaceIndexesResponse :: Int -> ListPlaceIndexesResponse
- data SearchPlaceIndexForPosition = SearchPlaceIndexForPosition' (Maybe Natural) Text (Sensitive (NonEmpty Double))
- newSearchPlaceIndexForPosition :: Text -> NonEmpty Double -> SearchPlaceIndexForPosition
- data SearchPlaceIndexForPositionResponse = SearchPlaceIndexForPositionResponse' Int [SearchForPositionResult] SearchPlaceIndexForPositionSummary
- newSearchPlaceIndexForPositionResponse :: Int -> SearchPlaceIndexForPositionSummary -> SearchPlaceIndexForPositionResponse
- data DeleteTracker = DeleteTracker' Text
- newDeleteTracker :: Text -> DeleteTracker
- data DeleteTrackerResponse = DeleteTrackerResponse' Int
- newDeleteTrackerResponse :: Int -> DeleteTrackerResponse
- data CreatePlaceIndex = CreatePlaceIndex' (Maybe DataSourceConfiguration) (Maybe Text) (Maybe (HashMap Text Text)) Text Text PricingPlan
- newCreatePlaceIndex :: Text -> Text -> PricingPlan -> CreatePlaceIndex
- data CreatePlaceIndexResponse = CreatePlaceIndexResponse' Int POSIX Text Text
- newCreatePlaceIndexResponse :: Int -> UTCTime -> Text -> Text -> CreatePlaceIndexResponse
- data UpdateTracker = UpdateTracker' (Maybe PricingPlan) (Maybe Text) (Maybe Text) (Maybe PositionFiltering) Text
- newUpdateTracker :: Text -> UpdateTracker
- data UpdateTrackerResponse = UpdateTrackerResponse' Int Text Text POSIX
- newUpdateTrackerResponse :: Int -> Text -> Text -> UTCTime -> UpdateTrackerResponse
- data CreateRouteCalculator = CreateRouteCalculator' (Maybe Text) (Maybe (HashMap Text Text)) Text Text PricingPlan
- newCreateRouteCalculator :: Text -> Text -> PricingPlan -> CreateRouteCalculator
- data CreateRouteCalculatorResponse = CreateRouteCalculatorResponse' Int Text Text POSIX
- newCreateRouteCalculatorResponse :: Int -> Text -> Text -> UTCTime -> CreateRouteCalculatorResponse
- data DescribeMap = DescribeMap' Text
- newDescribeMap :: Text -> DescribeMap
- data DescribeMapResponse = DescribeMapResponse' (Maybe (HashMap Text Text)) Int MapConfiguration POSIX Text Text Text Text PricingPlan POSIX
- newDescribeMapResponse :: Int -> MapConfiguration -> UTCTime -> Text -> Text -> Text -> Text -> PricingPlan -> UTCTime -> DescribeMapResponse
- 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 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 POSIX
- 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' POSIX Text POSIX
- newBatchPutGeofenceSuccess :: UTCTime -> Text -> UTCTime -> BatchPutGeofenceSuccess
- data BatchUpdateDevicePositionError = BatchUpdateDevicePositionError' Text BatchItemError POSIX
- newBatchUpdateDevicePositionError :: Text -> BatchItemError -> UTCTime -> BatchUpdateDevicePositionError
- data CalculateRouteCarModeOptions = CalculateRouteCarModeOptions' (Maybe Bool) (Maybe Bool)
- newCalculateRouteCarModeOptions :: CalculateRouteCarModeOptions
- data CalculateRouteSummary = CalculateRouteSummary' Text Double DistanceUnit Double (Sensitive (NonEmpty Double))
- newCalculateRouteSummary :: Text -> Double -> DistanceUnit -> Double -> NonEmpty Double -> CalculateRouteSummary
- data CalculateRouteTruckModeOptions = CalculateRouteTruckModeOptions' (Maybe TruckWeight) (Maybe Bool) (Maybe TruckDimensions) (Maybe Bool)
- newCalculateRouteTruckModeOptions :: CalculateRouteTruckModeOptions
- data DataSourceConfiguration = DataSourceConfiguration' (Maybe IntendedUse)
- newDataSourceConfiguration :: DataSourceConfiguration
- data DevicePosition = DevicePosition' (Maybe Text) (Sensitive (NonEmpty Double)) POSIX POSIX
- newDevicePosition :: NonEmpty Double -> UTCTime -> UTCTime -> DevicePosition
- data DevicePositionUpdate = DevicePositionUpdate' Text (Sensitive (NonEmpty Double)) POSIX
- newDevicePositionUpdate :: Text -> NonEmpty Double -> UTCTime -> DevicePositionUpdate
- data GeofenceGeometry = GeofenceGeometry' (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' Text (Sensitive (NonEmpty Double)) POSIX
- newListDevicePositionsResponseEntry :: Text -> NonEmpty Double -> UTCTime -> ListDevicePositionsResponseEntry
- data ListGeofenceCollectionsResponseEntry = ListGeofenceCollectionsResponseEntry' (Maybe Text) Text POSIX Text PricingPlan POSIX
- newListGeofenceCollectionsResponseEntry :: Text -> UTCTime -> Text -> PricingPlan -> UTCTime -> ListGeofenceCollectionsResponseEntry
- data ListGeofenceResponseEntry = ListGeofenceResponseEntry' POSIX Text GeofenceGeometry Text POSIX
- newListGeofenceResponseEntry :: UTCTime -> Text -> GeofenceGeometry -> Text -> UTCTime -> ListGeofenceResponseEntry
- data ListMapsResponseEntry = ListMapsResponseEntry' POSIX Text Text Text PricingPlan POSIX
- newListMapsResponseEntry :: UTCTime -> Text -> Text -> Text -> PricingPlan -> UTCTime -> ListMapsResponseEntry
- data ListPlaceIndexesResponseEntry = ListPlaceIndexesResponseEntry' POSIX Text Text Text PricingPlan POSIX
- newListPlaceIndexesResponseEntry :: UTCTime -> Text -> Text -> Text -> PricingPlan -> UTCTime -> ListPlaceIndexesResponseEntry
- data ListRouteCalculatorsResponseEntry = ListRouteCalculatorsResponseEntry' Text POSIX Text Text PricingPlan POSIX
- newListRouteCalculatorsResponseEntry :: Text -> UTCTime -> Text -> Text -> PricingPlan -> UTCTime -> ListRouteCalculatorsResponseEntry
- data ListTrackersResponseEntry = ListTrackersResponseEntry' (Maybe Text) POSIX Text PricingPlan Text POSIX
- newListTrackersResponseEntry :: UTCTime -> Text -> PricingPlan -> Text -> UTCTime -> ListTrackersResponseEntry
- data MapConfiguration = MapConfiguration' Text
- newMapConfiguration :: Text -> MapConfiguration
- data Place = Place' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) PlaceGeometry
- newPlace :: PlaceGeometry -> Place
- data PlaceGeometry = PlaceGeometry' (Maybe (Sensitive (NonEmpty Double)))
- newPlaceGeometry :: PlaceGeometry
- data SearchForPositionResult = SearchForPositionResult' Place
- newSearchForPositionResult :: Place -> SearchForPositionResult
- data SearchForTextResult = SearchForTextResult' Place
- newSearchForTextResult :: Place -> SearchForTextResult
- data SearchPlaceIndexForPositionSummary = SearchPlaceIndexForPositionSummary' (Maybe Natural) Text (Sensitive (NonEmpty Double))
- newSearchPlaceIndexForPositionSummary :: Text -> NonEmpty Double -> SearchPlaceIndexForPositionSummary
- data SearchPlaceIndexForTextSummary = SearchPlaceIndexForTextSummary' (Maybe (Sensitive (NonEmpty Double))) (Maybe (Sensitive (NonEmpty Double))) (Maybe (Sensitive (NonEmpty Double))) (Maybe (NonEmpty Text)) (Maybe Natural) 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 TruckDimensions = TruckDimensions' (Maybe Double) (Maybe Double) (Maybe Double) (Maybe DimensionUnit)
- 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
.
ValidationException
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The input failed to meet the constraints specified by the AWS service.
AccessDeniedException
_AccessDeniedException :: AsError a => Getting (First ServiceError) 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 => Getting (First ServiceError) a ServiceError Source #
The request was unsuccessful because of a conflict.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The operation was denied because the request would exceed the maximum quota set for Amazon Location Service.
ThrottlingException
_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was denied because of request throttling.
InternalServerException
_InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource that you've entered was not found in your AWS account.
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.
BatchUpdateDevicePosition
data BatchUpdateDevicePosition Source #
See: newBatchUpdateDevicePosition
smart constructor.
Instances
newBatchUpdateDevicePosition Source #
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:
$sel:trackerName: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
Eq BatchUpdateDevicePositionResponse Source # | |
Read BatchUpdateDevicePositionResponse Source # | |
Show BatchUpdateDevicePositionResponse Source # | |
Generic BatchUpdateDevicePositionResponse Source # | |
NFData BatchUpdateDevicePositionResponse Source # | |
Defined in Amazonka.Location.BatchUpdateDevicePosition rnf :: BatchUpdateDevicePositionResponse -> () # | |
type Rep BatchUpdateDevicePositionResponse Source # | |
Defined in Amazonka.Location.BatchUpdateDevicePosition type Rep BatchUpdateDevicePositionResponse = D1 ('MetaData "BatchUpdateDevicePositionResponse" "Amazonka.Location.BatchUpdateDevicePosition" "libZSservicesZSamazonka-locationZSamazonka-location" 'False) (C1 ('MetaCons "BatchUpdateDevicePositionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "errors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BatchUpdateDevicePositionError]))) |
newBatchUpdateDevicePositionResponse Source #
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.
DeleteRouteCalculator
data DeleteRouteCalculator Source #
See: newDeleteRouteCalculator
smart constructor.
Instances
newDeleteRouteCalculator Source #
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:
$sel:calculatorName:DeleteRouteCalculator'
, deleteRouteCalculator_calculatorName
- The name of the route calculator resource to be deleted.
data DeleteRouteCalculatorResponse Source #
See: newDeleteRouteCalculatorResponse
smart constructor.
Instances
Eq DeleteRouteCalculatorResponse Source # | |
Read DeleteRouteCalculatorResponse Source # | |
Show DeleteRouteCalculatorResponse Source # | |
Defined in Amazonka.Location.DeleteRouteCalculator showsPrec :: Int -> DeleteRouteCalculatorResponse -> ShowS # show :: DeleteRouteCalculatorResponse -> String # showList :: [DeleteRouteCalculatorResponse] -> ShowS # | |
Generic DeleteRouteCalculatorResponse Source # | |
NFData DeleteRouteCalculatorResponse Source # | |
Defined in Amazonka.Location.DeleteRouteCalculator rnf :: DeleteRouteCalculatorResponse -> () # | |
type Rep DeleteRouteCalculatorResponse Source # | |
Defined in Amazonka.Location.DeleteRouteCalculator type Rep DeleteRouteCalculatorResponse = D1 ('MetaData "DeleteRouteCalculatorResponse" "Amazonka.Location.DeleteRouteCalculator" "libZSservicesZSamazonka-locationZSamazonka-location" 'False) (C1 ('MetaCons "DeleteRouteCalculatorResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
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.
UpdateRouteCalculator
data UpdateRouteCalculator Source #
See: newUpdateRouteCalculator
smart constructor.
Instances
newUpdateRouteCalculator Source #
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:
$sel:pricingPlan:UpdateRouteCalculator'
, updateRouteCalculator_pricingPlan
- Updates the pricing plan for the route calculator resource.
For more information about each pricing plan option restrictions, see Amazon Location Service pricing.
$sel:description:UpdateRouteCalculator'
, updateRouteCalculator_description
- Updates the description for the route calculator resource.
$sel:calculatorName:UpdateRouteCalculator'
, updateRouteCalculator_calculatorName
- The name of the route calculator resource to update.
data UpdateRouteCalculatorResponse Source #
See: newUpdateRouteCalculatorResponse
smart constructor.
Instances
newUpdateRouteCalculatorResponse Source #
:: 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
$sel:calculatorName:UpdateRouteCalculator'
, updateRouteCalculatorResponse_calculatorName
- The name of the updated route calculator resource.
$sel:updateTime:UpdateRouteCalculatorResponse'
, updateRouteCalculatorResponse_updateTime
- The timestamp for when the route calculator was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
CreateGeofenceCollection
data CreateGeofenceCollection Source #
See: newCreateGeofenceCollection
smart constructor.
CreateGeofenceCollection' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Text PricingPlan |
Instances
newCreateGeofenceCollection Source #
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:
$sel:pricingPlanDataSource:CreateGeofenceCollection'
, createGeofenceCollection_pricingPlanDataSource
- Specifies the data provider for the geofence collection.
- Required value for the following pricing plans:
MobileAssetTracking
|MobileAssetManagement
For more information about Data Providers, and Pricing plans, see the Amazon Location Service product page.
Amazon Location Service only uses PricingPlanDataSource
to calculate
billing for your geofence collection. Your data won't be shared with
the data provider, and will remain in your AWS account or Region unless
you move it.
Valid Values: Esri
| Here
$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.
$sel:description:CreateGeofenceCollection'
, createGeofenceCollection_description
- An optional description for the geofence collection.
$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: + - = . _ : / @.
$sel:collectionName: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
.
$sel:pricingPlan:CreateGeofenceCollection'
, createGeofenceCollection_pricingPlan
- Specifies the pricing plan for the geofence collection.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
data CreateGeofenceCollectionResponse Source #
See: newCreateGeofenceCollectionResponse
smart constructor.
Instances
newCreateGeofenceCollectionResponse Source #
:: 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
$sel:collectionName:CreateGeofenceCollection'
, createGeofenceCollectionResponse_collectionName
- The name for the geofence collection.
$sel:createTime:CreateGeofenceCollectionResponse'
, createGeofenceCollectionResponse_createTime
- The timestamp for when the geofence collection was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
ListRouteCalculators (Paginated)
data ListRouteCalculators Source #
See: newListRouteCalculators
smart constructor.
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:
$sel:nextToken: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
$sel:maxResults:ListRouteCalculators'
, listRouteCalculators_maxResults
- An optional maximum number of results returned in a single call.
Default Value: 100
data ListRouteCalculatorsResponse Source #
See: newListRouteCalculatorsResponse
smart constructor.
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:
$sel:nextToken: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
CreateTracker
data CreateTracker Source #
See: newCreateTracker
smart constructor.
CreateTracker' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe PositionFiltering) PricingPlan Text |
Instances
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:
$sel:pricingPlanDataSource:CreateTracker'
, createTracker_pricingPlanDataSource
- Specifies the data provider for the tracker resource.
- Required value for the following pricing plans:
MobileAssetTracking
|MobileAssetManagement
For more information about Data Providers, and Pricing plans, see the Amazon Location Service product page.
Amazon Location Service only uses PricingPlanDataSource
to calculate
billing for your tracker resource. Your data will not be shared with the
data provider, and will remain in your AWS account or Region unless you
move it.
Valid values: Esri
| Here
$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:description:CreateTracker'
, createTracker_description
- An optional description for the tracker resource.
$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: + - = . _ : / @.
$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 distance are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and device positions to retrieve. Distance-based filtering can also reduce the jitter effect when displaying device trajectory on a map.
This field is optional. If not specified, the default value is
TimeBased
.
$sel:pricingPlan:CreateTracker'
, createTracker_pricingPlan
- Specifies the pricing plan for the tracker resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
$sel:trackerName: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.
Instances
newCreateTrackerResponse Source #
:: 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.
$sel:createTime: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
$sel:trackerName:CreateTracker'
, createTrackerResponse_trackerName
- The name of the tracker resource.
ListTrackerConsumers (Paginated)
data ListTrackerConsumers Source #
See: newListTrackerConsumers
smart constructor.
Instances
newListTrackerConsumers Source #
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:
$sel:nextToken: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
$sel:maxResults:ListTrackerConsumers'
, listTrackerConsumers_maxResults
- An optional limit for the number of resources returned in a single call.
Default value: 100
$sel:trackerName:ListTrackerConsumers'
, listTrackerConsumers_trackerName
- The tracker resource whose associated geofence collections you want to
list.
data ListTrackerConsumersResponse Source #
See: newListTrackerConsumersResponse
smart constructor.
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:
$sel:nextToken: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.
GetDevicePosition
data GetDevicePosition Source #
See: newGetDevicePosition
smart constructor.
Instances
:: 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:
$sel:deviceId:GetDevicePosition'
, getDevicePosition_deviceId
- The device whose position you want to retrieve.
$sel:trackerName:GetDevicePosition'
, getDevicePosition_trackerName
- The tracker resource receiving the position update.
data GetDevicePositionResponse Source #
See: newGetDevicePositionResponse
smart constructor.
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:
$sel:deviceId:GetDevicePosition'
, getDevicePositionResponse_deviceId
- The device whose position you retrieved.
$sel:httpStatus:GetDevicePositionResponse'
, getDevicePositionResponse_httpStatus
- The response's http status code.
$sel:position:GetDevicePositionResponse'
, getDevicePositionResponse_position
- The last known device position.
$sel:receivedTime:GetDevicePositionResponse'
, getDevicePositionResponse_receivedTime
- The timestamp for when the tracker resource received the device position
in ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
$sel:sampleTime:GetDevicePositionResponse'
, getDevicePositionResponse_sampleTime
- The timestamp at which the device's position was determined. Uses
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
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.
SearchPlaceIndexForText
data SearchPlaceIndexForText Source #
See: newSearchPlaceIndexForText
smart constructor.
SearchPlaceIndexForText' (Maybe (Sensitive (NonEmpty Double))) (Maybe (Sensitive (NonEmpty Double))) (Maybe (NonEmpty Text)) (Maybe Natural) Text (Sensitive Text) |
Instances
newSearchPlaceIndexForText Source #
:: Text | |
-> Text | |
-> SearchPlaceIndexForText |
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:
$sel:filterBBox:SearchPlaceIndexForText'
, searchPlaceIndexForText_filterBBox
- Filters the results by returning only Places within the provided
bounding box. An optional parameter.
The first 2 bbox
parameters describe the lower southwest corner:
- The first
bbox
position is the X coordinate or longitude of the lower southwest corner. - The second
bbox
position is the Y coordinate or latitude of the lower southwest corner.
For example, bbox=xLongitudeSW&bbox=yLatitudeSW
.
The next bbox
parameters describe the upper northeast corner:
- The third
bbox
position is the X coordinate, or longitude of the upper northeast corner. - The fourth
bbox
position is the Y coordinate, or longitude of the upper northeast corner.
For example, bbox=xLongitudeNE&bbox=yLatitudeNE
$sel:biasPosition:SearchPlaceIndexForText'
, searchPlaceIndexForText_biasPosition
- Searches for results closest to the given position. An optional
parameter defined by longitude, and latitude.
- The first
bias
position is the X coordinate, or longitude. - The second
bias
position is the Y coordinate, or latitude.
For example, bias=xLongitude&bias=yLatitude
.
$sel:filterCountries:SearchPlaceIndexForText'
, searchPlaceIndexForText_filterCountries
- Limits the search to the given a list of countries/regions. An optional
parameter.
- Use the ISO 3166
3-digit country code. For example, Australia uses three upper-case
characters:
AUS
.
$sel:maxResults:SearchPlaceIndexForText'
, searchPlaceIndexForText_maxResults
- An optional parameter. The maximum number of results returned per
request.
The default: 50
$sel:indexName:SearchPlaceIndexForText'
, searchPlaceIndexForText_indexName
- The name of the place index resource you want to use for the search.
$sel:text: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.
Instances
newSearchPlaceIndexForTextResponse Source #
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 closest to the specified position. Each result contains
additional information about the specific point of interest.
$sel:summary:SearchPlaceIndexForTextResponse'
, searchPlaceIndexForTextResponse_summary
- Contains a summary of the request. Contains the BiasPosition
,
DataSource
, FilterBBox
, FilterCountries
, MaxResults
,
ResultBBox
, and Text
.
DescribeGeofenceCollection
data DescribeGeofenceCollection Source #
See: newDescribeGeofenceCollection
smart constructor.
Instances
newDescribeGeofenceCollection Source #
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:
$sel:collectionName:DescribeGeofenceCollection'
, describeGeofenceCollection_collectionName
- The name of the geofence collection.
data DescribeGeofenceCollectionResponse Source #
See: newDescribeGeofenceCollectionResponse
smart constructor.
DescribeGeofenceCollectionResponse' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Int Text Text POSIX Text PricingPlan POSIX |
Instances
newDescribeGeofenceCollectionResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> UTCTime | |
-> Text | |
-> PricingPlan | |
-> UTCTime | |
-> DescribeGeofenceCollectionResponse |
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:pricingPlanDataSource:DescribeGeofenceCollectionResponse'
, describeGeofenceCollectionResponse_pricingPlanDataSource
- The specified data provider for the geofence collection.
$sel:kmsKeyId:DescribeGeofenceCollectionResponse'
, describeGeofenceCollectionResponse_kmsKeyId
- A key identifier for an
AWS KMS customer managed key
assigned to the Amazon Location resource
$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
$sel:collectionName:DescribeGeofenceCollection'
, describeGeofenceCollectionResponse_collectionName
- The name of the geofence collection.
$sel:createTime:DescribeGeofenceCollectionResponse'
, describeGeofenceCollectionResponse_createTime
- The timestamp for when the geofence resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
$sel:description:DescribeGeofenceCollectionResponse'
, describeGeofenceCollectionResponse_description
- The optional description for the geofence collection.
$sel:pricingPlan:DescribeGeofenceCollectionResponse'
, describeGeofenceCollectionResponse_pricingPlan
- The pricing plan selected for the specified geofence collection.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
$sel:updateTime:DescribeGeofenceCollectionResponse'
, describeGeofenceCollectionResponse_updateTime
- The timestamp for when the geofence collection was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
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:
$sel:nextToken: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
$sel:maxResults:ListMaps'
, listMaps_maxResults
- An optional limit for the number of resources returned in a single call.
Default value: 100
data ListMapsResponse Source #
See: newListMapsResponse
smart constructor.
Instances
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:
$sel:nextToken: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
GetMapSprites
data GetMapSprites Source #
See: newGetMapSprites
smart constructor.
Instances
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.png
for high pixel density displays
For the JSON document contain image offsets. Use the following file names:
sprites.json
sprites@2x.json
for high pixel density displays
$sel:mapName:GetMapSprites'
, getMapSprites_mapName
- The map resource associated with the sprite file.
data GetMapSpritesResponse Source #
See: newGetMapSpritesResponse
smart constructor.
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.
CreateMap
See: newCreateMap
smart constructor.
Instances
:: MapConfiguration | |
-> Text | |
-> PricingPlan | |
-> 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:
$sel:description:CreateMap'
, createMap_description
- An optional description for the map resource.
$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: + - = . _ : / @.
$sel:configuration:CreateMap'
, createMap_configuration
- Specifies the map style selected from an available data provider.
$sel:mapName: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
.
$sel:pricingPlan:CreateMap'
, createMap_pricingPlan
- Specifies the pricing plan for your map resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
data CreateMapResponse Source #
See: newCreateMapResponse
smart constructor.
Instances
:: 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.
$sel:createTime: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:maps/ExampleMap
$sel:mapName:CreateMap'
, createMapResponse_mapName
- The name of the map resource.
DescribeRouteCalculator
data DescribeRouteCalculator Source #
See: newDescribeRouteCalculator
smart constructor.
Instances
newDescribeRouteCalculator Source #
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:
$sel:calculatorName:DescribeRouteCalculator'
, describeRouteCalculator_calculatorName
- The name of the route calculator resource.
data DescribeRouteCalculatorResponse Source #
See: newDescribeRouteCalculatorResponse
smart constructor.
DescribeRouteCalculatorResponse' (Maybe (HashMap Text Text)) Int Text Text POSIX Text Text PricingPlan POSIX |
Instances
newDescribeRouteCalculatorResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> UTCTime | |
-> Text | |
-> Text | |
-> PricingPlan | |
-> UTCTime | |
-> DescribeRouteCalculatorResponse |
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:
$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
$sel:calculatorName:DescribeRouteCalculator'
, describeRouteCalculatorResponse_calculatorName
- The name of the route calculator resource being described.
$sel:createTime: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
$sel:dataSource: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.
$sel:description:DescribeRouteCalculatorResponse'
, describeRouteCalculatorResponse_description
- The optional description of the route calculator resource.
$sel:pricingPlan:DescribeRouteCalculatorResponse'
, describeRouteCalculatorResponse_pricingPlan
- The pricing plan selected for the specified route calculator resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
$sel:updateTime: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
BatchGetDevicePosition
data BatchGetDevicePosition Source #
See: newBatchGetDevicePosition
smart constructor.
Instances
newBatchGetDevicePosition Source #
:: 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
$sel:trackerName:BatchGetDevicePosition'
, batchGetDevicePosition_trackerName
- The tracker resource retrieving the device position.
data BatchGetDevicePositionResponse Source #
See: newBatchGetDevicePositionResponse
smart constructor.
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.
GetMapStyleDescriptor
data GetMapStyleDescriptor Source #
See: newGetMapStyleDescriptor
smart constructor.
Instances
newGetMapStyleDescriptor Source #
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:
$sel:mapName:GetMapStyleDescriptor'
, getMapStyleDescriptor_mapName
- The map resource to retrieve the style descriptor from.
data GetMapStyleDescriptorResponse Source #
See: newGetMapStyleDescriptorResponse
smart constructor.
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.
Instances
:: 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:
$sel:mapName: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.
Instances
newGetMapTileResponse Source #
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.
ListGeofenceCollections (Paginated)
data ListGeofenceCollections Source #
See: newListGeofenceCollections
smart constructor.
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:
$sel:nextToken: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
$sel:maxResults:ListGeofenceCollections'
, listGeofenceCollections_maxResults
- An optional limit for the number of resources returned in a single call.
Default value: 100
data ListGeofenceCollectionsResponse Source #
See: newListGeofenceCollectionsResponse
smart constructor.
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:
$sel:nextToken: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.
DeleteGeofenceCollection
data DeleteGeofenceCollection Source #
See: newDeleteGeofenceCollection
smart constructor.
Instances
newDeleteGeofenceCollection Source #
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:
$sel:collectionName:DeleteGeofenceCollection'
, deleteGeofenceCollection_collectionName
- The name of the geofence collection to be deleted.
data DeleteGeofenceCollectionResponse Source #
See: newDeleteGeofenceCollectionResponse
smart constructor.
Instances
Eq DeleteGeofenceCollectionResponse Source # | |
Read DeleteGeofenceCollectionResponse Source # | |
Show DeleteGeofenceCollectionResponse Source # | |
Generic DeleteGeofenceCollectionResponse Source # | |
NFData DeleteGeofenceCollectionResponse Source # | |
Defined in Amazonka.Location.DeleteGeofenceCollection rnf :: DeleteGeofenceCollectionResponse -> () # | |
type Rep DeleteGeofenceCollectionResponse Source # | |
Defined in Amazonka.Location.DeleteGeofenceCollection type Rep DeleteGeofenceCollectionResponse = D1 ('MetaData "DeleteGeofenceCollectionResponse" "Amazonka.Location.DeleteGeofenceCollection" "libZSservicesZSamazonka-locationZSamazonka-location" 'False) (C1 ('MetaCons "DeleteGeofenceCollectionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
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.
UpdateGeofenceCollection
data UpdateGeofenceCollection Source #
See: newUpdateGeofenceCollection
smart constructor.
Instances
newUpdateGeofenceCollection Source #
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:
$sel:pricingPlan:UpdateGeofenceCollection'
, updateGeofenceCollection_pricingPlan
- Updates the pricing plan for the geofence collection.
For more information about each pricing plan option restrictions, see Amazon Location Service pricing.
$sel:pricingPlanDataSource:UpdateGeofenceCollection'
, updateGeofenceCollection_pricingPlanDataSource
- Updates the data provider for the geofence collection.
A required value for the following pricing plans: MobileAssetTracking
|
MobileAssetManagement
For more information about data providers and pricing plans, see the Amazon Location Service product page.
This can only be updated when updating the PricingPlan
in the same
request.
Amazon Location Service uses PricingPlanDataSource
to calculate
billing for your geofence collection. Your data won't be shared with
the data provider, and will remain in your AWS account and Region unless
you move it.
$sel:description:UpdateGeofenceCollection'
, updateGeofenceCollection_description
- Updates the description for the geofence collection.
$sel:collectionName:UpdateGeofenceCollection'
, updateGeofenceCollection_collectionName
- The name of the geofence collection to update.
data UpdateGeofenceCollectionResponse Source #
See: newUpdateGeofenceCollectionResponse
smart constructor.
Instances
newUpdateGeofenceCollectionResponse Source #
:: 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
$sel:collectionName:UpdateGeofenceCollection'
, updateGeofenceCollectionResponse_collectionName
- The name of the updated geofence collection.
$sel:updateTime:UpdateGeofenceCollectionResponse'
, updateGeofenceCollectionResponse_updateTime
- The time when the geofence collection was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
ListTrackers (Paginated)
data ListTrackers Source #
See: newListTrackers
smart constructor.
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:
$sel:nextToken: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
$sel:maxResults:ListTrackers'
, listTrackers_maxResults
- An optional limit for the number of resources returned in a single call.
Default value: 100
data ListTrackersResponse Source #
See: newListTrackersResponse
smart constructor.
Instances
newListTrackersResponse Source #
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:
$sel:nextToken: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.
DeletePlaceIndex
data DeletePlaceIndex Source #
See: newDeletePlaceIndex
smart constructor.
Instances
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:
$sel:indexName:DeletePlaceIndex'
, deletePlaceIndex_indexName
- The name of the place index resource to be deleted.
data DeletePlaceIndexResponse Source #
See: newDeletePlaceIndexResponse
smart constructor.
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.
UpdatePlaceIndex
data UpdatePlaceIndex Source #
See: newUpdatePlaceIndex
smart constructor.
Instances
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:pricingPlan:UpdatePlaceIndex'
, updatePlaceIndex_pricingPlan
- Updates the pricing plan for the place index resource.
For more information about each pricing plan option restrictions, see Amazon Location Service pricing.
$sel:dataSourceConfiguration:UpdatePlaceIndex'
, updatePlaceIndex_dataSourceConfiguration
- Updates the data storage option for the place index resource.
$sel:description:UpdatePlaceIndex'
, updatePlaceIndex_description
- Updates the description for the place index resource.
$sel:indexName:UpdatePlaceIndex'
, updatePlaceIndex_indexName
- The name of the place index resource to update.
data UpdatePlaceIndexResponse Source #
See: newUpdatePlaceIndexResponse
smart constructor.
Instances
newUpdatePlaceIndexResponse Source #
:: 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
$sel:indexName:UpdatePlaceIndex'
, updatePlaceIndexResponse_indexName
- The name of the updated place index resource.
$sel:updateTime:UpdatePlaceIndexResponse'
, updatePlaceIndexResponse_updateTime
- The timestamp for when the place index resource was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
DisassociateTrackerConsumer
data DisassociateTrackerConsumer Source #
See: newDisassociateTrackerConsumer
smart constructor.
Instances
newDisassociateTrackerConsumer Source #
:: 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
$sel:trackerName:DisassociateTrackerConsumer'
, disassociateTrackerConsumer_trackerName
- The name of the tracker resource to be dissociated from the consumer.
data DisassociateTrackerConsumerResponse Source #
See: newDisassociateTrackerConsumerResponse
smart constructor.
Instances
Eq DisassociateTrackerConsumerResponse Source # | |
Read DisassociateTrackerConsumerResponse Source # | |
Show DisassociateTrackerConsumerResponse Source # | |
Generic DisassociateTrackerConsumerResponse Source # | |
NFData DisassociateTrackerConsumerResponse Source # | |
Defined in Amazonka.Location.DisassociateTrackerConsumer rnf :: DisassociateTrackerConsumerResponse -> () # | |
type Rep DisassociateTrackerConsumerResponse Source # | |
Defined in Amazonka.Location.DisassociateTrackerConsumer type Rep DisassociateTrackerConsumerResponse = D1 ('MetaData "DisassociateTrackerConsumerResponse" "Amazonka.Location.DisassociateTrackerConsumer" "libZSservicesZSamazonka-locationZSamazonka-location" 'False) (C1 ('MetaCons "DisassociateTrackerConsumerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDisassociateTrackerConsumerResponse Source #
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.
PutGeofence
data PutGeofence Source #
See: newPutGeofence
smart constructor.
Instances
:: 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:
$sel:collectionName:PutGeofence'
, putGeofence_collectionName
- The geofence collection to store the geofence in.
$sel:geofenceId:PutGeofence'
, putGeofence_geofenceId
- An identifier for the geofence. For example, ExampleGeofence-1
.
$sel:geometry:PutGeofence'
, putGeofence_geometry
- Contains the polygon details to specify the position of the geofence.
Each geofence polygon can have a maximum of 1,000 vertices.
data PutGeofenceResponse Source #
See: newPutGeofenceResponse
smart constructor.
Instances
newPutGeofenceResponse Source #
:: 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.
$sel:createTime:PutGeofenceResponse'
, putGeofenceResponse_createTime
- The timestamp for when the geofence was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
$sel:geofenceId:PutGeofence'
, putGeofenceResponse_geofenceId
- The geofence identifier entered in the request.
$sel:updateTime:PutGeofenceResponse'
, putGeofenceResponse_updateTime
- The timestamp for when the geofence was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
ListGeofences (Paginated)
data ListGeofences Source #
See: newListGeofences
smart constructor.
Instances
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:
$sel:nextToken: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
$sel:collectionName:ListGeofences'
, listGeofences_collectionName
- The name of the geofence collection storing the list of geofences.
data ListGeofencesResponse Source #
See: newListGeofencesResponse
smart constructor.
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:
$sel:nextToken: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.
AssociateTrackerConsumer
data AssociateTrackerConsumer Source #
See: newAssociateTrackerConsumer
smart constructor.
Instances
newAssociateTrackerConsumer Source #
:: 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
$sel:trackerName:AssociateTrackerConsumer'
, associateTrackerConsumer_trackerName
- The name of the tracker resource to be associated with a geofence
collection.
data AssociateTrackerConsumerResponse Source #
See: newAssociateTrackerConsumerResponse
smart constructor.
Instances
Eq AssociateTrackerConsumerResponse Source # | |
Read AssociateTrackerConsumerResponse Source # | |
Show AssociateTrackerConsumerResponse Source # | |
Generic AssociateTrackerConsumerResponse Source # | |
NFData AssociateTrackerConsumerResponse Source # | |
Defined in Amazonka.Location.AssociateTrackerConsumer rnf :: AssociateTrackerConsumerResponse -> () # | |
type Rep AssociateTrackerConsumerResponse Source # | |
Defined in Amazonka.Location.AssociateTrackerConsumer type Rep AssociateTrackerConsumerResponse = D1 ('MetaData "AssociateTrackerConsumerResponse" "Amazonka.Location.AssociateTrackerConsumer" "libZSservicesZSamazonka-locationZSamazonka-location" 'False) (C1 ('MetaCons "AssociateTrackerConsumerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
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.
BatchEvaluateGeofences
data BatchEvaluateGeofences Source #
See: newBatchEvaluateGeofences
smart constructor.
Instances
newBatchEvaluateGeofences Source #
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:
$sel:collectionName: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.
Instances
Eq BatchEvaluateGeofencesResponse Source # | |
Read BatchEvaluateGeofencesResponse Source # | |
Show BatchEvaluateGeofencesResponse Source # | |
Defined in Amazonka.Location.BatchEvaluateGeofences | |
Generic BatchEvaluateGeofencesResponse Source # | |
NFData BatchEvaluateGeofencesResponse Source # | |
Defined in Amazonka.Location.BatchEvaluateGeofences rnf :: BatchEvaluateGeofencesResponse -> () # | |
type Rep BatchEvaluateGeofencesResponse Source # | |
Defined in Amazonka.Location.BatchEvaluateGeofences type Rep BatchEvaluateGeofencesResponse = D1 ('MetaData "BatchEvaluateGeofencesResponse" "Amazonka.Location.BatchEvaluateGeofences" "libZSservicesZSamazonka-locationZSamazonka-location" 'False) (C1 ('MetaCons "BatchEvaluateGeofencesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "errors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BatchEvaluateGeofencesError]))) |
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.
CalculateRoute
data CalculateRoute Source #
See: newCalculateRoute
smart constructor.
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:distanceUnit:CalculateRoute'
, calculateRoute_distanceUnit
- Set the unit system to specify the distance.
Default Value: Kilometers
$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]
$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: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:travelMode:CalculateRoute'
, calculateRoute_travelMode
- Specifies the mode of transport when calculating a route. Used in
estimating the speed of travel and road compatibility.
The TravelMode
you specify determines how you specify route
preferences:
- If traveling by
Car
use theCarModeOptions
parameter. - If traveling by
Truck
use theTruckModeOptions
parameter.
Default Value: Car
$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:departureTime:CalculateRoute'
, calculateRoute_departureTime
- Specifies the desired time of departure. Uses the given time to
calculate a 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
$sel:calculatorName:CalculateRoute'
, calculateRoute_calculatorName
- The name of the route calculator resource that you want to use to
calculate a route.
$sel:departurePosition:CalculateRoute'
, calculateRoute_departurePosition
- The start position for the route. Defined in
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
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.
Instances
newCalculateRouteResponse Source #
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
StartPosition
is the departure position. - The
EndPosition
is 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
StartPosition
is the departure position . TheEndPosition
is the waypoint positon. - Leg 2: The
StartPosition
is the waypoint position. TheEndPosition
is the destination position.
$sel:summary:CalculateRouteResponse'
, calculateRouteResponse_summary
- Contains information about the whole route, such as: RouteBBox
,
DataSource
, Distance
, DistanceUnit
, and DurationSeconds
.
DeleteMap
See: newDeleteMap
smart constructor.
Instances
Eq DeleteMap Source # | |
Read DeleteMap Source # | |
Show DeleteMap Source # | |
Generic DeleteMap Source # | |
NFData DeleteMap Source # | |
Defined in Amazonka.Location.DeleteMap | |
Hashable DeleteMap Source # | |
Defined in Amazonka.Location.DeleteMap | |
AWSRequest DeleteMap Source # | |
Defined in Amazonka.Location.DeleteMap type AWSResponse DeleteMap # request :: DeleteMap -> Request DeleteMap # response :: MonadResource m => Logger -> Service -> Proxy DeleteMap -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteMap))) # | |
ToHeaders DeleteMap Source # | |
Defined in Amazonka.Location.DeleteMap | |
ToPath DeleteMap Source # | |
Defined in Amazonka.Location.DeleteMap toPath :: DeleteMap -> ByteString # | |
ToQuery DeleteMap Source # | |
Defined in Amazonka.Location.DeleteMap toQuery :: DeleteMap -> QueryString # | |
type Rep DeleteMap Source # | |
Defined in Amazonka.Location.DeleteMap | |
type AWSResponse DeleteMap Source # | |
Defined in Amazonka.Location.DeleteMap |
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:
$sel:mapName:DeleteMap'
, deleteMap_mapName
- The name of the map resource to be deleted.
data DeleteMapResponse Source #
See: newDeleteMapResponse
smart constructor.
Instances
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.
UpdateMap
See: newUpdateMap
smart constructor.
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:
$sel:pricingPlan:UpdateMap'
, updateMap_pricingPlan
- Updates the pricing plan for the map resource.
For more information about each pricing plan option restrictions, see Amazon Location Service pricing.
$sel:description:UpdateMap'
, updateMap_description
- Updates the description for the map resource.
$sel:mapName:UpdateMap'
, updateMap_mapName
- The name of the map resource to update.
data UpdateMapResponse Source #
See: newUpdateMapResponse
smart constructor.
Instances
:: 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:maps/ExampleMap
$sel:mapName:UpdateMap'
, updateMapResponse_mapName
- The name of the updated map resource.
$sel:updateTime:UpdateMapResponse'
, updateMapResponse_updateTime
- The timestamp for when the map resource was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
GetDevicePositionHistory (Paginated)
data GetDevicePositionHistory Source #
See: newGetDevicePositionHistory
smart constructor.
Instances
newGetDevicePositionHistory Source #
:: Text | |
-> Text | |
-> GetDevicePositionHistory |
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:nextToken: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: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
EndTimeExclusive
must be after the time forStartTimeInclusive
.
$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
StartTimeInclusive
must be beforeEndTimeExclusive
.
$sel:deviceId:GetDevicePositionHistory'
, getDevicePositionHistory_deviceId
- The device whose position history you want to retrieve.
$sel:trackerName:GetDevicePositionHistory'
, getDevicePositionHistory_trackerName
- The tracker resource receiving the request for the device position
history.
data GetDevicePositionHistoryResponse Source #
See: newGetDevicePositionHistoryResponse
smart constructor.
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:
$sel:nextToken: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.
DescribeTracker
data DescribeTracker Source #
See: newDescribeTracker
smart constructor.
Instances
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:
$sel:trackerName:DescribeTracker'
, describeTracker_trackerName
- The name of the tracker resource.
data DescribeTrackerResponse Source #
See: newDescribeTrackerResponse
smart constructor.
DescribeTrackerResponse' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe PositionFiltering) Int POSIX Text PricingPlan Text Text POSIX |
Instances
newDescribeTrackerResponse Source #
:: Int | |
-> UTCTime | |
-> Text | |
-> PricingPlan | |
-> Text | |
-> Text | |
-> UTCTime | |
-> DescribeTrackerResponse |
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:pricingPlanDataSource:DescribeTrackerResponse'
, describeTrackerResponse_pricingPlanDataSource
- The specified data provider for the tracker resource.
$sel:kmsKeyId:DescribeTrackerResponse'
, describeTrackerResponse_kmsKeyId
- A key identifier for an
AWS KMS customer managed key
assigned to the Amazon Location resource.
$sel:tags:DescribeTrackerResponse'
, describeTrackerResponse_tags
- The tags associated with the tracker resource.
$sel:positionFiltering:DescribeTrackerResponse'
, describeTrackerResponse_positionFiltering
- The position filtering method of the tracker resource.
$sel:httpStatus:DescribeTrackerResponse'
, describeTrackerResponse_httpStatus
- The response's http status code.
$sel:createTime:DescribeTrackerResponse'
, describeTrackerResponse_createTime
- The timestamp for when the tracker resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
$sel:description:DescribeTrackerResponse'
, describeTrackerResponse_description
- The optional description for the tracker resource.
$sel:pricingPlan:DescribeTrackerResponse'
, describeTrackerResponse_pricingPlan
- The pricing plan selected for the specified tracker resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
$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
$sel:trackerName:DescribeTracker'
, describeTrackerResponse_trackerName
- The name of the tracker resource.
$sel:updateTime:DescribeTrackerResponse'
, describeTrackerResponse_updateTime
- The timestamp for when the tracker resource was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
DescribePlaceIndex
data DescribePlaceIndex Source #
See: newDescribePlaceIndex
smart constructor.
Instances
newDescribePlaceIndex Source #
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:
$sel:indexName:DescribePlaceIndex'
, describePlaceIndex_indexName
- The name of the place index resource.
data DescribePlaceIndexResponse Source #
See: newDescribePlaceIndexResponse
smart constructor.
DescribePlaceIndexResponse' (Maybe (HashMap Text Text)) Int POSIX Text DataSourceConfiguration Text Text Text PricingPlan POSIX |
Instances
newDescribePlaceIndexResponse Source #
:: Int | |
-> UTCTime | |
-> Text | |
-> DataSourceConfiguration | |
-> Text | |
-> Text | |
-> Text | |
-> PricingPlan | |
-> 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:
$sel:tags:DescribePlaceIndexResponse'
, describePlaceIndexResponse_tags
- Tags associated with place index resource.
$sel:httpStatus:DescribePlaceIndexResponse'
, describePlaceIndexResponse_httpStatus
- The response's http status code.
$sel:createTime:DescribePlaceIndexResponse'
, describePlaceIndexResponse_createTime
- The timestamp for when the place index resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
$sel:dataSource:DescribePlaceIndexResponse'
, describePlaceIndexResponse_dataSource
- The data provider of geospatial data. Indicates one of the available
providers:
Esri
Here
For additional details on data providers, see Amazon Location Service data providers.
$sel:dataSourceConfiguration:DescribePlaceIndexResponse'
, describePlaceIndexResponse_dataSourceConfiguration
- The specified data storage option for requesting Places.
$sel:description: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
$sel:indexName:DescribePlaceIndex'
, describePlaceIndexResponse_indexName
- The name of the place index resource being described.
$sel:pricingPlan:DescribePlaceIndexResponse'
, describePlaceIndexResponse_pricingPlan
- The pricing plan selected for the specified place index resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
$sel:updateTime:DescribePlaceIndexResponse'
, describePlaceIndexResponse_updateTime
- The timestamp for when the place index resource was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
GetGeofence
data GetGeofence Source #
See: newGetGeofence
smart constructor.
Instances
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:
$sel:collectionName:GetGeofence'
, getGeofence_collectionName
- The geofence collection storing the target geofence.
$sel:geofenceId:GetGeofence'
, getGeofence_geofenceId
- The geofence you're retrieving details for.
data GetGeofenceResponse Source #
See: newGetGeofenceResponse
smart constructor.
Instances
newGetGeofenceResponse Source #
:: 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.
$sel:createTime:GetGeofenceResponse'
, getGeofenceResponse_createTime
- The timestamp for when the geofence collection was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
$sel:geofenceId:GetGeofence'
, getGeofenceResponse_geofenceId
- The geofence identifier.
$sel:geometry:GetGeofenceResponse'
, getGeofenceResponse_geometry
- Contains the geofence geometry details describing a polygon.
$sel:status: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.
$sel:updateTime:GetGeofenceResponse'
, getGeofenceResponse_updateTime
- The timestamp for when the geofence collection was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
ListDevicePositions (Paginated)
data ListDevicePositions Source #
See: newListDevicePositions
smart constructor.
Instances
newListDevicePositions Source #
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:
$sel:nextToken: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
$sel:maxResults:ListDevicePositions'
, listDevicePositions_maxResults
- An optional limit for the number of entries returned in a single call.
Default value: 100
$sel:trackerName:ListDevicePositions'
, listDevicePositions_trackerName
- The tracker resource containing the requested devices.
data ListDevicePositionsResponse Source #
See: newListDevicePositionsResponse
smart constructor.
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:
$sel:nextToken: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.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
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
- 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"}
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
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.
GetMapGlyphs
data GetMapGlyphs Source #
See: newGetMapGlyphs
smart constructor.
Instances
:: 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:
- VectorHereBerlin –
Fira GO Regular
|Fira GO Bold
$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.
$sel:mapName:GetMapGlyphs'
, getMapGlyphs_mapName
- The map resource associated with the glyph file.
data GetMapGlyphsResponse Source #
See: newGetMapGlyphsResponse
smart constructor.
Instances
newGetMapGlyphsResponse Source #
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.
BatchPutGeofence
data BatchPutGeofence Source #
See: newBatchPutGeofence
smart constructor.
Instances
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:
$sel:collectionName: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.
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.
BatchDeleteGeofence
data BatchDeleteGeofence Source #
See: newBatchDeleteGeofence
smart constructor.
Instances
newBatchDeleteGeofence Source #
:: 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:
$sel:collectionName: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.
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.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
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.
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.
BatchDeleteDevicePositionHistory
data BatchDeleteDevicePositionHistory Source #
See: newBatchDeleteDevicePositionHistory
smart constructor.
Instances
newBatchDeleteDevicePositionHistory Source #
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]
$sel:trackerName: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 #
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.
ListPlaceIndexes (Paginated)
data ListPlaceIndexes Source #
See: newListPlaceIndexes
smart constructor.
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:
$sel:nextToken: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
$sel:maxResults:ListPlaceIndexes'
, listPlaceIndexes_maxResults
- An optional limit for the maximum number of results returned in a single
call.
Default value: 100
data ListPlaceIndexesResponse Source #
See: newListPlaceIndexesResponse
smart constructor.
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:
$sel:nextToken:ListPlaceIndexes'
, listPlaceIndexesResponse_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: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
SearchPlaceIndexForPosition
data SearchPlaceIndexForPosition Source #
See: newSearchPlaceIndexForPosition
smart constructor.
Instances
newSearchPlaceIndexForPosition Source #
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:
$sel:maxResults:SearchPlaceIndexForPosition'
, searchPlaceIndexForPosition_maxResults
- An optional paramer. The maximum number of results returned per request.
Default value: 50
$sel:indexName:SearchPlaceIndexForPosition'
, searchPlaceIndexForPosition_indexName
- The name of the place index resource you want to use for the search.
$sel:position:SearchPlaceIndexForPosition'
, searchPlaceIndexForPosition_position
- Specifies a coordinate for the query defined by a longitude, and
latitude.
- The first position is the X coordinate, or longitude.
- The second position is the Y coordinate, or latitude.
For example, position=xLongitude&position=yLatitude
.
data SearchPlaceIndexForPositionResponse Source #
See: newSearchPlaceIndexForPositionResponse
smart constructor.
SearchPlaceIndexForPositionResponse' Int [SearchForPositionResult] SearchPlaceIndexForPositionSummary |
Instances
newSearchPlaceIndexForPositionResponse Source #
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.
DeleteTracker
data DeleteTracker Source #
See: newDeleteTracker
smart constructor.
Instances
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:
$sel:trackerName:DeleteTracker'
, deleteTracker_trackerName
- The name of the tracker resource to be deleted.
data DeleteTrackerResponse Source #
See: newDeleteTrackerResponse
smart constructor.
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.
CreatePlaceIndex
data CreatePlaceIndex Source #
See: newCreatePlaceIndex
smart constructor.
CreatePlaceIndex' (Maybe DataSourceConfiguration) (Maybe Text) (Maybe (HashMap Text Text)) Text Text PricingPlan |
Instances
:: Text | |
-> Text | |
-> PricingPlan | |
-> 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.
$sel:description:CreatePlaceIndex'
, createPlaceIndex_description
- The optional description for the place index resource.
$sel:tags:CreatePlaceIndex'
, createPlaceIndex_tags
- Applies one or more tags to the place index 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: + - = . _ : / @.
$sel:dataSource:CreatePlaceIndex'
, createPlaceIndex_dataSource
- Specifies the data provider of geospatial data.
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.Place index resources using HERE Technologies as a data provider can't 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.
$sel:indexName: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
.
$sel:pricingPlan:CreatePlaceIndex'
, createPlaceIndex_pricingPlan
- Specifies the pricing plan for your place index resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
data CreatePlaceIndexResponse Source #
See: newCreatePlaceIndexResponse
smart constructor.
Instances
newCreatePlaceIndexResponse Source #
:: 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.
$sel:createTime: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
$sel:indexName:CreatePlaceIndex'
, createPlaceIndexResponse_indexName
- The name for the place index resource.
UpdateTracker
data UpdateTracker Source #
See: newUpdateTracker
smart constructor.
Instances
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:
$sel:pricingPlan:UpdateTracker'
, updateTracker_pricingPlan
- Updates the pricing plan for the tracker resource.
For more information about each pricing plan option restrictions, see Amazon Location Service pricing.
$sel:pricingPlanDataSource:UpdateTracker'
, updateTracker_pricingPlanDataSource
- Updates the data provider for the tracker resource.
A required value for the following pricing plans: MobileAssetTracking
|
MobileAssetManagement
For more information about data providers and pricing plans, see the Amazon Location Service product page
This can only be updated when updating the PricingPlan
in the same
request.
Amazon Location Service uses PricingPlanDataSource
to calculate
billing for your tracker resource. Your data won't be shared with the
data provider, and will remain in your AWS account and Region unless you
move it.
$sel:description: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 device positions to retrieve. Distance-based filtering can also reduce the jitter effect when displaying device trajectory on a map.
$sel:trackerName:UpdateTracker'
, updateTracker_trackerName
- The name of the tracker resource to update.
data UpdateTrackerResponse Source #
See: newUpdateTrackerResponse
smart constructor.
Instances
newUpdateTrackerResponse Source #
:: 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
$sel:trackerName:UpdateTracker'
, updateTrackerResponse_trackerName
- The name of the updated tracker resource.
$sel:updateTime:UpdateTrackerResponse'
, updateTrackerResponse_updateTime
- The timestamp for when the tracker resource was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
CreateRouteCalculator
data CreateRouteCalculator Source #
See: newCreateRouteCalculator
smart constructor.
Instances
newCreateRouteCalculator Source #
:: Text | |
-> Text | |
-> PricingPlan | |
-> 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:
$sel:description:CreateRouteCalculator'
, createRouteCalculator_description
- The optional description for the route calculator resource.
$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: + - = . _ : / @.
$sel:calculatorName: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
.
$sel:dataSource: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.
$sel:pricingPlan:CreateRouteCalculator'
, createRouteCalculator_pricingPlan
- Specifies the pricing plan for your route calculator resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
data CreateRouteCalculatorResponse Source #
See: newCreateRouteCalculatorResponse
smart constructor.
Instances
newCreateRouteCalculatorResponse Source #
:: 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
$sel:calculatorName:CreateRouteCalculator'
, createRouteCalculatorResponse_calculatorName
- The name of the route calculator resource.
- For example,
ExampleRouteCalculator
.
$sel:createTime: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
DescribeMap
data DescribeMap Source #
See: newDescribeMap
smart constructor.
Instances
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:
$sel:mapName:DescribeMap'
, describeMap_mapName
- The name of the map resource.
data DescribeMapResponse Source #
See: newDescribeMapResponse
smart constructor.
DescribeMapResponse' (Maybe (HashMap Text Text)) Int MapConfiguration POSIX Text Text Text Text PricingPlan POSIX |
Instances
newDescribeMapResponse Source #
:: Int | |
-> MapConfiguration | |
-> UTCTime | |
-> Text | |
-> Text | |
-> Text | |
-> Text | |
-> PricingPlan | |
-> 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:
$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.
$sel:createTime:DescribeMapResponse'
, describeMapResponse_createTime
- The timestamp for when the map resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
$sel:dataSource:DescribeMapResponse'
, describeMapResponse_dataSource
- Specifies the data provider for the associated map tiles.
$sel:description: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:maps/ExampleMap
$sel:mapName:DescribeMap'
, describeMapResponse_mapName
- The map style selected from an available provider.
$sel:pricingPlan:DescribeMapResponse'
, describeMapResponse_pricingPlan
- The pricing plan selected for the specified map resource.
<p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
$sel:updateTime:DescribeMapResponse'
, describeMapResponse_updateTime
- The timestamp for when the map resource was last update in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
Types
BatchItemErrorCode
newtype BatchItemErrorCode Source #
Instances
DimensionUnit
newtype DimensionUnit Source #
pattern DimensionUnit_Feet :: DimensionUnit | |
pattern DimensionUnit_Meters :: DimensionUnit |
Instances
DistanceUnit
newtype DistanceUnit Source #
pattern DistanceUnit_Kilometers :: DistanceUnit | |
pattern DistanceUnit_Miles :: DistanceUnit |
Instances
IntendedUse
newtype IntendedUse Source #
pattern IntendedUse_SingleUse :: IntendedUse | |
pattern IntendedUse_Storage :: IntendedUse |
Instances
PositionFiltering
newtype PositionFiltering Source #
pattern PositionFiltering_DistanceBased :: PositionFiltering | |
pattern PositionFiltering_TimeBased :: PositionFiltering |
Instances
PricingPlan
newtype PricingPlan Source #
pattern PricingPlan_MobileAssetManagement :: PricingPlan | |
pattern PricingPlan_MobileAssetTracking :: PricingPlan | |
pattern PricingPlan_RequestBasedUsage :: PricingPlan |
Instances
TravelMode
newtype TravelMode Source #
pattern TravelMode_Car :: TravelMode | |
pattern TravelMode_Truck :: TravelMode | |
pattern TravelMode_Walking :: TravelMode |
Instances
VehicleWeightUnit
newtype VehicleWeightUnit Source #
pattern VehicleWeightUnit_Kilograms :: VehicleWeightUnit | |
pattern VehicleWeightUnit_Pounds :: VehicleWeightUnit |
Instances
BatchDeleteDevicePositionHistoryError
data BatchDeleteDevicePositionHistoryError Source #
Contains the tracker resource details.
See: newBatchDeleteDevicePositionHistoryError
smart constructor.
Instances
newBatchDeleteDevicePositionHistoryError Source #
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.
Instances
newBatchDeleteGeofenceError Source #
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.
Instances
newBatchEvaluateGeofencesError Source #
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.
Instances
newBatchGetDevicePositionError Source #
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.
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.
Instances
newBatchPutGeofenceError Source #
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.
Instances
newBatchPutGeofenceRequestEntry Source #
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 polygon details to specify the position of the geofence.
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.
Instances
newBatchPutGeofenceSuccess Source #
:: 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.
Instances
newBatchUpdateDevicePositionError Source #
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.
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:avoidTolls:CalculateRouteCarModeOptions'
, calculateRouteCarModeOptions_avoidTolls
- Avoids tolls when calculating routes.
Default Value: false
Valid Values: false
| true
$sel:avoidFerries:CalculateRouteCarModeOptions'
, calculateRouteCarModeOptions_avoidFerries
- Avoids ferries when calculating routes.
Default Value: false
Valid Values: false
| true
CalculateRouteSummary
data CalculateRouteSummary Source #
A summary of the calculated route.
See: newCalculateRouteSummary
smart constructor.
Instances
newCalculateRouteSummary Source #
:: 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 the distance.
$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
bbox
position is the X coordinate or longitude of the lower southwest corner. - The second
bbox
position is the Y coordinate or latitude of the lower southwest corner.
The next 2 bbox
parameters describe the upper northeast corner:
- The third
bbox
position is the X coordinate, or longitude of the upper northeast corner. - The fourth
bbox
position 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.
CalculateRouteTruckModeOptions' (Maybe TruckWeight) (Maybe Bool) (Maybe TruckDimensions) (Maybe Bool) |
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: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.
$sel:avoidTolls:CalculateRouteTruckModeOptions'
, calculateRouteTruckModeOptions_avoidTolls
- Avoids ferries 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:avoidFerries:CalculateRouteTruckModeOptions'
, calculateRouteTruckModeOptions_avoidFerries
- Avoids ferries when calculating routes.
Default Value: false
Valid Values: false
| true
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
IntendedUse
toStorage
. parameter. - Under the
MobileAssetTracking
orMobilAssetManagement
pricing plan, you can't store results from your place index resources by settingIntendedUse
toStorage
. This returns a validation exception error.
For more information, see the AWS Service Terms for Amazon Location Service.
See: newDataSourceConfiguration
smart constructor.
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:
SingleUse
specifies that the results won't be stored.Storage
specifies 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.
Instances
:: 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:deviceId:DevicePosition'
, devicePosition_deviceId
- The device whose position you retrieved.
$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.
Instances
newDevicePositionUpdate Source #
:: 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: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.
Amazon Location doesn't currently support polygons with holes, multipolygons, polygons that are wound clockwise, or that cross the antimeridian.
See: newGeofenceGeometry
smart constructor.
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:polygon:GeofenceGeometry'
, geofenceGeometry_polygon
- An array of 1 or more linear rings. A linear ring is an array of 4 or
more vertices, where the first and last vertex are the same to form a
closed boundary. Each vertex is a 2-dimensional point of the form:
[longitude, latitude]
.
The first linear ring is an outer ring, describing the polygon's boundary. Subsequent linear rings may be inner or outer rings to describe holes and islands. Outer rings must list their vertices in counter-clockwise order around the ring's center, where the left side is the polygon's exterior. Inner rings must list their vertices in clockwise order, where the left side is the polygon's interior.
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
StartPosition
is the departure position. - The
EndPosition
is 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
StartPosition
is the departure position . TheEndPosition
is the waypoint positon. - Leg 2: The
StartPosition
is the waypoint position. TheEndPosition
is the destination position.
See: newLeg
smart constructor.
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.
$sel:distance:Leg'
, leg_distance
- The distance between the leg's StartPosition
and EndPosition
along
a calculated route.
- The default measurement is
Kilometers
unless the request specifies aDistanceUnit
ofMiles
.
$sel:durationSeconds: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.
$sel:endPosition: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.
$sel:startPosition: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.
Instances
newListDevicePositionsResponseEntry Source #
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: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.
Instances
newListGeofenceCollectionsResponseEntry Source #
:: Text | |
-> UTCTime | |
-> Text | |
-> PricingPlan | |
-> 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:pricingPlanDataSource:ListGeofenceCollectionsResponseEntry'
, listGeofenceCollectionsResponseEntry_pricingPlanDataSource
- The specified data provider for the geofence collection.
$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:pricingPlan:ListGeofenceCollectionsResponseEntry'
, listGeofenceCollectionsResponseEntry_pricingPlan
- The pricing plan for the specified geofence collection.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
$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.
Instances
newListGeofenceResponseEntry Source #
:: 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.
$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.
Instances
newListMapsResponseEntry Source #
:: UTCTime | |
-> Text | |
-> Text | |
-> Text | |
-> PricingPlan | |
-> UTCTime | |
-> ListMapsResponseEntry |
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: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:pricingPlan:ListMapsResponseEntry'
, listMapsResponseEntry_pricingPlan
- The pricing plan for the specified map resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
$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.
Instances
newListPlaceIndexesResponseEntry Source #
:: UTCTime | |
-> Text | |
-> Text | |
-> Text | |
-> PricingPlan | |
-> UTCTime | |
-> ListPlaceIndexesResponseEntry |
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: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. Indicates one of the available
providers:
Esri
Here
For additional details on 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:pricingPlan:ListPlaceIndexesResponseEntry'
, listPlaceIndexesResponseEntry_pricingPlan
- The pricing plan for the specified place index resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
$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.
Instances
newListRouteCalculatorsResponseEntry Source #
:: Text | |
-> UTCTime | |
-> Text | |
-> Text | |
-> PricingPlan | |
-> UTCTime | |
-> ListRouteCalculatorsResponseEntry |
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: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:pricingPlan:ListRouteCalculatorsResponseEntry'
, listRouteCalculatorsResponseEntry_pricingPlan
- The pricing plan for the specified route calculator resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
$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.
Instances
newListTrackersResponseEntry Source #
:: UTCTime | |
-> Text | |
-> PricingPlan | |
-> 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:pricingPlanDataSource:ListTrackersResponseEntry'
, listTrackersResponseEntry_pricingPlanDataSource
- The specified data provider for the tracker resource.
$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:pricingPlan:ListTrackersResponseEntry'
, listTrackersResponseEntry_pricingPlan
- The pricing plan for the specified tracker resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
$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.
Instances
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:
VectorHereBerlin
– The HERE Berlin map style is a high contrast detailed base map of the world that blends 3D and 2D rendering.When using HERE as your data provider, and selecting the Style
VectorHereBerlin
, you may not use HERE Technologies maps for Asset Management. See the AWS Service Terms for Amazon Location Service.
Place
Contains details about addresses or points of interest that match the search criteria.
See: newPlace
smart constructor.
Place' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) PlaceGeometry |
Instances
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:municipality:Place'
, place_municipality
- A name for a local area, such as a city or town name. For example,
Toronto
.
$sel:addressNumber:Place'
, place_addressNumber
- The numerical portion of an address, such as a building number.
$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:country:Place'
, place_country
- A country/region specified using
ISO 3166 3-digit
country/region code. For example, CAN
.
$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:region:Place'
, place_region
- A name for an area or geographical division, such as a province or state
name. For example, British Columbia
.
$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:neighborhood:Place'
, place_neighborhood
- The name of a community district. For example, Downtown
.
$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.
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.
SearchForPositionResult
data SearchForPositionResult Source #
Specifies a single point of interest, or Place as a result of a search query obtained from a dataset configured in the place index resource.
See: newSearchForPositionResult
smart constructor.
Instances
newSearchForPositionResult Source #
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:place:SearchForPositionResult'
, searchForPositionResult_place
- Contains details about the relevant point of interest.
SearchForTextResult
data SearchForTextResult Source #
Contains relevant Places returned by calling SearchPlaceIndexForText
.
See: newSearchForTextResult
smart constructor.
Instances
newSearchForTextResult Source #
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:place:SearchForTextResult'
, searchForTextResult_place
- Contains details about the relevant point of interest.
SearchPlaceIndexForPositionSummary
data SearchPlaceIndexForPositionSummary Source #
A summary of the reverse geocoding request sent using
SearchPlaceIndexForPosition
.
See: newSearchPlaceIndexForPositionSummary
smart constructor.
Instances
newSearchPlaceIndexForPositionSummary Source #
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:maxResults:SearchPlaceIndexForPositionSummary'
, searchPlaceIndexForPositionSummary_maxResults
- An optional parameter. The maximum number of results returned per
request.
Default value: 50
$sel:dataSource:SearchPlaceIndexForPositionSummary'
, searchPlaceIndexForPositionSummary_dataSource
- The data provider of geospatial data. Indicates one of the available
providers:
- Esri
- HERE
For additional details on data providers, see Amazon Location Service data providers.
$sel:position:SearchPlaceIndexForPositionSummary'
, searchPlaceIndexForPositionSummary_position
- The position given in the reverse geocoding request.
SearchPlaceIndexForTextSummary
data SearchPlaceIndexForTextSummary Source #
A summary of the geocoding request sent using SearchPlaceIndexForText
.
See: newSearchPlaceIndexForTextSummary
smart constructor.
SearchPlaceIndexForTextSummary' (Maybe (Sensitive (NonEmpty Double))) (Maybe (Sensitive (NonEmpty Double))) (Maybe (Sensitive (NonEmpty Double))) (Maybe (NonEmpty Text)) (Maybe Natural) Text (Sensitive Text) |
Instances
newSearchPlaceIndexForTextSummary Source #
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:filterBBox:SearchPlaceIndexForTextSummary'
, searchPlaceIndexForTextSummary_filterBBox
- Contains the coordinates for the optional bounding box coordinated
entered in the geocoding request.
$sel:resultBBox:SearchPlaceIndexForTextSummary'
, searchPlaceIndexForTextSummary_resultBBox
- A bounding box that contains the search results within the specified
area indicated by FilterBBox
. A subset of bounding box specified using
FilterBBox
.
$sel:biasPosition:SearchPlaceIndexForTextSummary'
, searchPlaceIndexForTextSummary_biasPosition
- Contains the coordinates for the bias position entered in the geocoding
request.
$sel:filterCountries:SearchPlaceIndexForTextSummary'
, searchPlaceIndexForTextSummary_filterCountries
- Contains the country filter entered in the geocoding request.
$sel:maxResults:SearchPlaceIndexForTextSummary'
, searchPlaceIndexForTextSummary_maxResults
- Contains the maximum number of results indicated for the request.
$sel:dataSource:SearchPlaceIndexForTextSummary'
, searchPlaceIndexForTextSummary_dataSource
- The data provider of geospatial data. Indicates one of the available
providers:
- Esri
- HERE
For additional details on data providers, see Amazon Location Service data providers.
$sel:text:SearchPlaceIndexForTextSummary'
, searchPlaceIndexForTextSummary_text
- The address, name, city or region to be used in the geocoding request.
In free-form text format. For example, Vancouver
.
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.
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.
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.
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:length:TruckDimensions'
, truckDimensions_length
- The length of the truck.
- For example,
15.5
.
$sel:height:TruckDimensions'
, truckDimensions_height
- The height of the truck.
- For example,
4.5
.
$sel:width:TruckDimensions'
, truckDimensions_width
- The width of the truck.
- For example,
4.5
.
$sel:unit:TruckDimensions'
, truckDimensions_unit
- Specifies the unit of measurement for the truck dimensions.
Default Value: 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.
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