Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Operations
- AssociateTrackerConsumer
- BatchDeleteDevicePositionHistory
- BatchDeleteGeofence
- BatchEvaluateGeofences
- BatchGetDevicePosition
- BatchPutGeofence
- BatchUpdateDevicePosition
- CalculateRoute
- CalculateRouteMatrix
- CreateGeofenceCollection
- CreateMap
- CreatePlaceIndex
- CreateRouteCalculator
- CreateTracker
- DeleteGeofenceCollection
- DeleteMap
- DeletePlaceIndex
- DeleteRouteCalculator
- DeleteTracker
- DescribeGeofenceCollection
- DescribeMap
- DescribePlaceIndex
- DescribeRouteCalculator
- DescribeTracker
- DisassociateTrackerConsumer
- GetDevicePosition
- GetDevicePositionHistory
- GetGeofence
- GetMapGlyphs
- GetMapSprites
- GetMapStyleDescriptor
- GetMapTile
- GetPlace
- ListDevicePositions
- ListGeofenceCollections
- ListGeofences
- ListMaps
- ListPlaceIndexes
- ListRouteCalculators
- ListTagsForResource
- ListTrackerConsumers
- ListTrackers
- PutGeofence
- SearchPlaceIndexForPosition
- SearchPlaceIndexForSuggestions
- SearchPlaceIndexForText
- TagResource
- UntagResource
- UpdateGeofenceCollection
- UpdateMap
- UpdatePlaceIndex
- UpdateRouteCalculator
- UpdateTracker
- Types
- BatchDeleteDevicePositionHistoryError
- BatchDeleteGeofenceError
- BatchEvaluateGeofencesError
- BatchGetDevicePositionError
- BatchItemError
- BatchPutGeofenceError
- BatchPutGeofenceRequestEntry
- BatchPutGeofenceSuccess
- BatchUpdateDevicePositionError
- CalculateRouteCarModeOptions
- CalculateRouteMatrixSummary
- CalculateRouteSummary
- CalculateRouteTruckModeOptions
- Circle
- DataSourceConfiguration
- DevicePosition
- DevicePositionUpdate
- GeofenceGeometry
- Leg
- LegGeometry
- ListDevicePositionsResponseEntry
- ListGeofenceCollectionsResponseEntry
- ListGeofenceResponseEntry
- ListMapsResponseEntry
- ListPlaceIndexesResponseEntry
- ListRouteCalculatorsResponseEntry
- ListTrackersResponseEntry
- MapConfiguration
- Place
- PlaceGeometry
- PositionalAccuracy
- RouteMatrixEntry
- RouteMatrixEntryError
- SearchForPositionResult
- SearchForSuggestionsResult
- SearchForTextResult
- SearchPlaceIndexForPositionSummary
- SearchPlaceIndexForSuggestionsSummary
- SearchPlaceIndexForTextSummary
- Step
- TimeZone
- TruckDimensions
- TruckWeight
Synopsis
- associateTrackerConsumer_consumerArn :: Lens' AssociateTrackerConsumer Text
- associateTrackerConsumer_trackerName :: Lens' AssociateTrackerConsumer Text
- associateTrackerConsumerResponse_httpStatus :: Lens' AssociateTrackerConsumerResponse Int
- batchDeleteDevicePositionHistory_deviceIds :: Lens' BatchDeleteDevicePositionHistory (NonEmpty Text)
- batchDeleteDevicePositionHistory_trackerName :: Lens' BatchDeleteDevicePositionHistory Text
- batchDeleteDevicePositionHistoryResponse_httpStatus :: Lens' BatchDeleteDevicePositionHistoryResponse Int
- batchDeleteDevicePositionHistoryResponse_errors :: Lens' BatchDeleteDevicePositionHistoryResponse [BatchDeleteDevicePositionHistoryError]
- batchDeleteGeofence_collectionName :: Lens' BatchDeleteGeofence Text
- batchDeleteGeofence_geofenceIds :: Lens' BatchDeleteGeofence (NonEmpty Text)
- batchDeleteGeofenceResponse_httpStatus :: Lens' BatchDeleteGeofenceResponse Int
- batchDeleteGeofenceResponse_errors :: Lens' BatchDeleteGeofenceResponse [BatchDeleteGeofenceError]
- batchEvaluateGeofences_collectionName :: Lens' BatchEvaluateGeofences Text
- batchEvaluateGeofences_devicePositionUpdates :: Lens' BatchEvaluateGeofences (NonEmpty DevicePositionUpdate)
- batchEvaluateGeofencesResponse_httpStatus :: Lens' BatchEvaluateGeofencesResponse Int
- batchEvaluateGeofencesResponse_errors :: Lens' BatchEvaluateGeofencesResponse [BatchEvaluateGeofencesError]
- batchGetDevicePosition_deviceIds :: Lens' BatchGetDevicePosition (NonEmpty Text)
- batchGetDevicePosition_trackerName :: Lens' BatchGetDevicePosition Text
- batchGetDevicePositionResponse_httpStatus :: Lens' BatchGetDevicePositionResponse Int
- batchGetDevicePositionResponse_devicePositions :: Lens' BatchGetDevicePositionResponse [DevicePosition]
- batchGetDevicePositionResponse_errors :: Lens' BatchGetDevicePositionResponse [BatchGetDevicePositionError]
- batchPutGeofence_collectionName :: Lens' BatchPutGeofence Text
- batchPutGeofence_entries :: Lens' BatchPutGeofence (NonEmpty BatchPutGeofenceRequestEntry)
- batchPutGeofenceResponse_httpStatus :: Lens' BatchPutGeofenceResponse Int
- batchPutGeofenceResponse_errors :: Lens' BatchPutGeofenceResponse [BatchPutGeofenceError]
- batchPutGeofenceResponse_successes :: Lens' BatchPutGeofenceResponse [BatchPutGeofenceSuccess]
- batchUpdateDevicePosition_trackerName :: Lens' BatchUpdateDevicePosition Text
- batchUpdateDevicePosition_updates :: Lens' BatchUpdateDevicePosition (NonEmpty DevicePositionUpdate)
- batchUpdateDevicePositionResponse_httpStatus :: Lens' BatchUpdateDevicePositionResponse Int
- batchUpdateDevicePositionResponse_errors :: Lens' BatchUpdateDevicePositionResponse [BatchUpdateDevicePositionError]
- calculateRoute_carModeOptions :: Lens' CalculateRoute (Maybe CalculateRouteCarModeOptions)
- calculateRoute_departNow :: Lens' CalculateRoute (Maybe Bool)
- calculateRoute_departureTime :: Lens' CalculateRoute (Maybe UTCTime)
- calculateRoute_distanceUnit :: Lens' CalculateRoute (Maybe DistanceUnit)
- calculateRoute_includeLegGeometry :: Lens' CalculateRoute (Maybe Bool)
- calculateRoute_travelMode :: Lens' CalculateRoute (Maybe TravelMode)
- calculateRoute_truckModeOptions :: Lens' CalculateRoute (Maybe CalculateRouteTruckModeOptions)
- calculateRoute_waypointPositions :: Lens' CalculateRoute (Maybe [NonEmpty Double])
- calculateRoute_calculatorName :: Lens' CalculateRoute Text
- calculateRoute_departurePosition :: Lens' CalculateRoute (NonEmpty Double)
- calculateRoute_destinationPosition :: Lens' CalculateRoute (NonEmpty Double)
- calculateRouteResponse_httpStatus :: Lens' CalculateRouteResponse Int
- calculateRouteResponse_legs :: Lens' CalculateRouteResponse [Leg]
- calculateRouteResponse_summary :: Lens' CalculateRouteResponse CalculateRouteSummary
- calculateRouteMatrix_carModeOptions :: Lens' CalculateRouteMatrix (Maybe CalculateRouteCarModeOptions)
- calculateRouteMatrix_departNow :: Lens' CalculateRouteMatrix (Maybe Bool)
- calculateRouteMatrix_departureTime :: Lens' CalculateRouteMatrix (Maybe UTCTime)
- calculateRouteMatrix_distanceUnit :: Lens' CalculateRouteMatrix (Maybe DistanceUnit)
- calculateRouteMatrix_travelMode :: Lens' CalculateRouteMatrix (Maybe TravelMode)
- calculateRouteMatrix_truckModeOptions :: Lens' CalculateRouteMatrix (Maybe CalculateRouteTruckModeOptions)
- calculateRouteMatrix_calculatorName :: Lens' CalculateRouteMatrix Text
- calculateRouteMatrix_departurePositions :: Lens' CalculateRouteMatrix (NonEmpty (NonEmpty Double))
- calculateRouteMatrix_destinationPositions :: Lens' CalculateRouteMatrix (NonEmpty (NonEmpty Double))
- calculateRouteMatrixResponse_snappedDeparturePositions :: Lens' CalculateRouteMatrixResponse (Maybe (NonEmpty (NonEmpty Double)))
- calculateRouteMatrixResponse_snappedDestinationPositions :: Lens' CalculateRouteMatrixResponse (Maybe (NonEmpty (NonEmpty Double)))
- calculateRouteMatrixResponse_httpStatus :: Lens' CalculateRouteMatrixResponse Int
- calculateRouteMatrixResponse_routeMatrix :: Lens' CalculateRouteMatrixResponse [[RouteMatrixEntry]]
- calculateRouteMatrixResponse_summary :: Lens' CalculateRouteMatrixResponse CalculateRouteMatrixSummary
- createGeofenceCollection_description :: Lens' CreateGeofenceCollection (Maybe Text)
- createGeofenceCollection_kmsKeyId :: Lens' CreateGeofenceCollection (Maybe Text)
- createGeofenceCollection_pricingPlan :: Lens' CreateGeofenceCollection (Maybe PricingPlan)
- createGeofenceCollection_pricingPlanDataSource :: Lens' CreateGeofenceCollection (Maybe Text)
- createGeofenceCollection_tags :: Lens' CreateGeofenceCollection (Maybe (HashMap Text Text))
- createGeofenceCollection_collectionName :: Lens' CreateGeofenceCollection Text
- createGeofenceCollectionResponse_httpStatus :: Lens' CreateGeofenceCollectionResponse Int
- createGeofenceCollectionResponse_collectionArn :: Lens' CreateGeofenceCollectionResponse Text
- createGeofenceCollectionResponse_collectionName :: Lens' CreateGeofenceCollectionResponse Text
- createGeofenceCollectionResponse_createTime :: Lens' CreateGeofenceCollectionResponse UTCTime
- createMap_description :: Lens' CreateMap (Maybe Text)
- createMap_pricingPlan :: Lens' CreateMap (Maybe PricingPlan)
- createMap_tags :: Lens' CreateMap (Maybe (HashMap Text Text))
- createMap_configuration :: Lens' CreateMap MapConfiguration
- createMap_mapName :: Lens' CreateMap Text
- createMapResponse_httpStatus :: Lens' CreateMapResponse Int
- createMapResponse_createTime :: Lens' CreateMapResponse UTCTime
- createMapResponse_mapArn :: Lens' CreateMapResponse Text
- createMapResponse_mapName :: Lens' CreateMapResponse Text
- createPlaceIndex_dataSourceConfiguration :: Lens' CreatePlaceIndex (Maybe DataSourceConfiguration)
- createPlaceIndex_description :: Lens' CreatePlaceIndex (Maybe Text)
- createPlaceIndex_pricingPlan :: Lens' CreatePlaceIndex (Maybe PricingPlan)
- createPlaceIndex_tags :: Lens' CreatePlaceIndex (Maybe (HashMap Text Text))
- createPlaceIndex_dataSource :: Lens' CreatePlaceIndex Text
- createPlaceIndex_indexName :: Lens' CreatePlaceIndex Text
- createPlaceIndexResponse_httpStatus :: Lens' CreatePlaceIndexResponse Int
- createPlaceIndexResponse_createTime :: Lens' CreatePlaceIndexResponse UTCTime
- createPlaceIndexResponse_indexArn :: Lens' CreatePlaceIndexResponse Text
- createPlaceIndexResponse_indexName :: Lens' CreatePlaceIndexResponse Text
- createRouteCalculator_description :: Lens' CreateRouteCalculator (Maybe Text)
- createRouteCalculator_pricingPlan :: Lens' CreateRouteCalculator (Maybe PricingPlan)
- createRouteCalculator_tags :: Lens' CreateRouteCalculator (Maybe (HashMap Text Text))
- createRouteCalculator_calculatorName :: Lens' CreateRouteCalculator Text
- createRouteCalculator_dataSource :: Lens' CreateRouteCalculator Text
- createRouteCalculatorResponse_httpStatus :: Lens' CreateRouteCalculatorResponse Int
- createRouteCalculatorResponse_calculatorArn :: Lens' CreateRouteCalculatorResponse Text
- createRouteCalculatorResponse_calculatorName :: Lens' CreateRouteCalculatorResponse Text
- createRouteCalculatorResponse_createTime :: Lens' CreateRouteCalculatorResponse UTCTime
- createTracker_description :: Lens' CreateTracker (Maybe Text)
- createTracker_kmsKeyId :: Lens' CreateTracker (Maybe Text)
- createTracker_positionFiltering :: Lens' CreateTracker (Maybe PositionFiltering)
- createTracker_pricingPlan :: Lens' CreateTracker (Maybe PricingPlan)
- createTracker_pricingPlanDataSource :: Lens' CreateTracker (Maybe Text)
- createTracker_tags :: Lens' CreateTracker (Maybe (HashMap Text Text))
- createTracker_trackerName :: Lens' CreateTracker Text
- createTrackerResponse_httpStatus :: Lens' CreateTrackerResponse Int
- createTrackerResponse_createTime :: Lens' CreateTrackerResponse UTCTime
- createTrackerResponse_trackerArn :: Lens' CreateTrackerResponse Text
- createTrackerResponse_trackerName :: Lens' CreateTrackerResponse Text
- deleteGeofenceCollection_collectionName :: Lens' DeleteGeofenceCollection Text
- deleteGeofenceCollectionResponse_httpStatus :: Lens' DeleteGeofenceCollectionResponse Int
- deleteMap_mapName :: Lens' DeleteMap Text
- deleteMapResponse_httpStatus :: Lens' DeleteMapResponse Int
- deletePlaceIndex_indexName :: Lens' DeletePlaceIndex Text
- deletePlaceIndexResponse_httpStatus :: Lens' DeletePlaceIndexResponse Int
- deleteRouteCalculator_calculatorName :: Lens' DeleteRouteCalculator Text
- deleteRouteCalculatorResponse_httpStatus :: Lens' DeleteRouteCalculatorResponse Int
- deleteTracker_trackerName :: Lens' DeleteTracker Text
- deleteTrackerResponse_httpStatus :: Lens' DeleteTrackerResponse Int
- describeGeofenceCollection_collectionName :: Lens' DescribeGeofenceCollection Text
- describeGeofenceCollectionResponse_kmsKeyId :: Lens' DescribeGeofenceCollectionResponse (Maybe Text)
- describeGeofenceCollectionResponse_pricingPlan :: Lens' DescribeGeofenceCollectionResponse (Maybe PricingPlan)
- describeGeofenceCollectionResponse_pricingPlanDataSource :: Lens' DescribeGeofenceCollectionResponse (Maybe Text)
- describeGeofenceCollectionResponse_tags :: Lens' DescribeGeofenceCollectionResponse (Maybe (HashMap Text Text))
- describeGeofenceCollectionResponse_httpStatus :: Lens' DescribeGeofenceCollectionResponse Int
- describeGeofenceCollectionResponse_collectionArn :: Lens' DescribeGeofenceCollectionResponse Text
- describeGeofenceCollectionResponse_collectionName :: Lens' DescribeGeofenceCollectionResponse Text
- describeGeofenceCollectionResponse_createTime :: Lens' DescribeGeofenceCollectionResponse UTCTime
- describeGeofenceCollectionResponse_description :: Lens' DescribeGeofenceCollectionResponse Text
- describeGeofenceCollectionResponse_updateTime :: Lens' DescribeGeofenceCollectionResponse UTCTime
- describeMap_mapName :: Lens' DescribeMap Text
- describeMapResponse_pricingPlan :: Lens' DescribeMapResponse (Maybe PricingPlan)
- describeMapResponse_tags :: Lens' DescribeMapResponse (Maybe (HashMap Text Text))
- describeMapResponse_httpStatus :: Lens' DescribeMapResponse Int
- describeMapResponse_configuration :: Lens' DescribeMapResponse MapConfiguration
- describeMapResponse_createTime :: Lens' DescribeMapResponse UTCTime
- describeMapResponse_dataSource :: Lens' DescribeMapResponse Text
- describeMapResponse_description :: Lens' DescribeMapResponse Text
- describeMapResponse_mapArn :: Lens' DescribeMapResponse Text
- describeMapResponse_mapName :: Lens' DescribeMapResponse Text
- describeMapResponse_updateTime :: Lens' DescribeMapResponse UTCTime
- describePlaceIndex_indexName :: Lens' DescribePlaceIndex Text
- describePlaceIndexResponse_pricingPlan :: Lens' DescribePlaceIndexResponse (Maybe PricingPlan)
- describePlaceIndexResponse_tags :: Lens' DescribePlaceIndexResponse (Maybe (HashMap Text Text))
- describePlaceIndexResponse_httpStatus :: Lens' DescribePlaceIndexResponse Int
- describePlaceIndexResponse_createTime :: Lens' DescribePlaceIndexResponse UTCTime
- describePlaceIndexResponse_dataSource :: Lens' DescribePlaceIndexResponse Text
- describePlaceIndexResponse_dataSourceConfiguration :: Lens' DescribePlaceIndexResponse DataSourceConfiguration
- describePlaceIndexResponse_description :: Lens' DescribePlaceIndexResponse Text
- describePlaceIndexResponse_indexArn :: Lens' DescribePlaceIndexResponse Text
- describePlaceIndexResponse_indexName :: Lens' DescribePlaceIndexResponse Text
- describePlaceIndexResponse_updateTime :: Lens' DescribePlaceIndexResponse UTCTime
- describeRouteCalculator_calculatorName :: Lens' DescribeRouteCalculator Text
- describeRouteCalculatorResponse_pricingPlan :: Lens' DescribeRouteCalculatorResponse (Maybe PricingPlan)
- describeRouteCalculatorResponse_tags :: Lens' DescribeRouteCalculatorResponse (Maybe (HashMap Text Text))
- describeRouteCalculatorResponse_httpStatus :: Lens' DescribeRouteCalculatorResponse Int
- describeRouteCalculatorResponse_calculatorArn :: Lens' DescribeRouteCalculatorResponse Text
- describeRouteCalculatorResponse_calculatorName :: Lens' DescribeRouteCalculatorResponse Text
- describeRouteCalculatorResponse_createTime :: Lens' DescribeRouteCalculatorResponse UTCTime
- describeRouteCalculatorResponse_dataSource :: Lens' DescribeRouteCalculatorResponse Text
- describeRouteCalculatorResponse_description :: Lens' DescribeRouteCalculatorResponse Text
- describeRouteCalculatorResponse_updateTime :: Lens' DescribeRouteCalculatorResponse UTCTime
- describeTracker_trackerName :: Lens' DescribeTracker Text
- describeTrackerResponse_kmsKeyId :: Lens' DescribeTrackerResponse (Maybe Text)
- describeTrackerResponse_positionFiltering :: Lens' DescribeTrackerResponse (Maybe PositionFiltering)
- describeTrackerResponse_pricingPlan :: Lens' DescribeTrackerResponse (Maybe PricingPlan)
- describeTrackerResponse_pricingPlanDataSource :: Lens' DescribeTrackerResponse (Maybe Text)
- describeTrackerResponse_tags :: Lens' DescribeTrackerResponse (Maybe (HashMap Text Text))
- describeTrackerResponse_httpStatus :: Lens' DescribeTrackerResponse Int
- describeTrackerResponse_createTime :: Lens' DescribeTrackerResponse UTCTime
- describeTrackerResponse_description :: Lens' DescribeTrackerResponse Text
- describeTrackerResponse_trackerArn :: Lens' DescribeTrackerResponse Text
- describeTrackerResponse_trackerName :: Lens' DescribeTrackerResponse Text
- describeTrackerResponse_updateTime :: Lens' DescribeTrackerResponse UTCTime
- disassociateTrackerConsumer_consumerArn :: Lens' DisassociateTrackerConsumer Text
- disassociateTrackerConsumer_trackerName :: Lens' DisassociateTrackerConsumer Text
- disassociateTrackerConsumerResponse_httpStatus :: Lens' DisassociateTrackerConsumerResponse Int
- getDevicePosition_deviceId :: Lens' GetDevicePosition Text
- getDevicePosition_trackerName :: Lens' GetDevicePosition Text
- getDevicePositionResponse_accuracy :: Lens' GetDevicePositionResponse (Maybe PositionalAccuracy)
- getDevicePositionResponse_deviceId :: Lens' GetDevicePositionResponse (Maybe Text)
- getDevicePositionResponse_positionProperties :: Lens' GetDevicePositionResponse (Maybe (HashMap Text Text))
- getDevicePositionResponse_httpStatus :: Lens' GetDevicePositionResponse Int
- getDevicePositionResponse_position :: Lens' GetDevicePositionResponse (NonEmpty Double)
- getDevicePositionResponse_receivedTime :: Lens' GetDevicePositionResponse UTCTime
- getDevicePositionResponse_sampleTime :: Lens' GetDevicePositionResponse UTCTime
- getDevicePositionHistory_endTimeExclusive :: Lens' GetDevicePositionHistory (Maybe UTCTime)
- getDevicePositionHistory_maxResults :: Lens' GetDevicePositionHistory (Maybe Natural)
- getDevicePositionHistory_nextToken :: Lens' GetDevicePositionHistory (Maybe Text)
- getDevicePositionHistory_startTimeInclusive :: Lens' GetDevicePositionHistory (Maybe UTCTime)
- getDevicePositionHistory_deviceId :: Lens' GetDevicePositionHistory Text
- getDevicePositionHistory_trackerName :: Lens' GetDevicePositionHistory Text
- getDevicePositionHistoryResponse_nextToken :: Lens' GetDevicePositionHistoryResponse (Maybe Text)
- getDevicePositionHistoryResponse_httpStatus :: Lens' GetDevicePositionHistoryResponse Int
- getDevicePositionHistoryResponse_devicePositions :: Lens' GetDevicePositionHistoryResponse [DevicePosition]
- getGeofence_collectionName :: Lens' GetGeofence Text
- getGeofence_geofenceId :: Lens' GetGeofence Text
- getGeofenceResponse_httpStatus :: Lens' GetGeofenceResponse Int
- getGeofenceResponse_createTime :: Lens' GetGeofenceResponse UTCTime
- getGeofenceResponse_geofenceId :: Lens' GetGeofenceResponse Text
- getGeofenceResponse_geometry :: Lens' GetGeofenceResponse GeofenceGeometry
- getGeofenceResponse_status :: Lens' GetGeofenceResponse Text
- getGeofenceResponse_updateTime :: Lens' GetGeofenceResponse UTCTime
- getMapGlyphs_fontStack :: Lens' GetMapGlyphs Text
- getMapGlyphs_fontUnicodeRange :: Lens' GetMapGlyphs Text
- getMapGlyphs_mapName :: Lens' GetMapGlyphs Text
- getMapGlyphsResponse_blob :: Lens' GetMapGlyphsResponse (Maybe ByteString)
- getMapGlyphsResponse_contentType :: Lens' GetMapGlyphsResponse (Maybe Text)
- getMapGlyphsResponse_httpStatus :: Lens' GetMapGlyphsResponse Int
- getMapSprites_fileName :: Lens' GetMapSprites Text
- getMapSprites_mapName :: Lens' GetMapSprites Text
- getMapSpritesResponse_blob :: Lens' GetMapSpritesResponse (Maybe ByteString)
- getMapSpritesResponse_contentType :: Lens' GetMapSpritesResponse (Maybe Text)
- getMapSpritesResponse_httpStatus :: Lens' GetMapSpritesResponse Int
- getMapStyleDescriptor_mapName :: Lens' GetMapStyleDescriptor Text
- getMapStyleDescriptorResponse_blob :: Lens' GetMapStyleDescriptorResponse (Maybe ByteString)
- getMapStyleDescriptorResponse_contentType :: Lens' GetMapStyleDescriptorResponse (Maybe Text)
- getMapStyleDescriptorResponse_httpStatus :: Lens' GetMapStyleDescriptorResponse Int
- getMapTile_mapName :: Lens' GetMapTile Text
- getMapTile_x :: Lens' GetMapTile Text
- getMapTile_y :: Lens' GetMapTile Text
- getMapTile_z :: Lens' GetMapTile Text
- getMapTileResponse_blob :: Lens' GetMapTileResponse (Maybe ByteString)
- getMapTileResponse_contentType :: Lens' GetMapTileResponse (Maybe Text)
- getMapTileResponse_httpStatus :: Lens' GetMapTileResponse Int
- getPlace_language :: Lens' GetPlace (Maybe Text)
- getPlace_indexName :: Lens' GetPlace Text
- getPlace_placeId :: Lens' GetPlace Text
- getPlaceResponse_httpStatus :: Lens' GetPlaceResponse Int
- getPlaceResponse_place :: Lens' GetPlaceResponse Place
- listDevicePositions_maxResults :: Lens' ListDevicePositions (Maybe Natural)
- listDevicePositions_nextToken :: Lens' ListDevicePositions (Maybe Text)
- listDevicePositions_trackerName :: Lens' ListDevicePositions Text
- listDevicePositionsResponse_nextToken :: Lens' ListDevicePositionsResponse (Maybe Text)
- listDevicePositionsResponse_httpStatus :: Lens' ListDevicePositionsResponse Int
- listDevicePositionsResponse_entries :: Lens' ListDevicePositionsResponse [ListDevicePositionsResponseEntry]
- listGeofenceCollections_maxResults :: Lens' ListGeofenceCollections (Maybe Natural)
- listGeofenceCollections_nextToken :: Lens' ListGeofenceCollections (Maybe Text)
- listGeofenceCollectionsResponse_nextToken :: Lens' ListGeofenceCollectionsResponse (Maybe Text)
- listGeofenceCollectionsResponse_httpStatus :: Lens' ListGeofenceCollectionsResponse Int
- listGeofenceCollectionsResponse_entries :: Lens' ListGeofenceCollectionsResponse [ListGeofenceCollectionsResponseEntry]
- listGeofences_maxResults :: Lens' ListGeofences (Maybe Natural)
- listGeofences_nextToken :: Lens' ListGeofences (Maybe Text)
- listGeofences_collectionName :: Lens' ListGeofences Text
- listGeofencesResponse_nextToken :: Lens' ListGeofencesResponse (Maybe Text)
- listGeofencesResponse_httpStatus :: Lens' ListGeofencesResponse Int
- listGeofencesResponse_entries :: Lens' ListGeofencesResponse [ListGeofenceResponseEntry]
- listMaps_maxResults :: Lens' ListMaps (Maybe Natural)
- listMaps_nextToken :: Lens' ListMaps (Maybe Text)
- listMapsResponse_nextToken :: Lens' ListMapsResponse (Maybe Text)
- listMapsResponse_httpStatus :: Lens' ListMapsResponse Int
- listMapsResponse_entries :: Lens' ListMapsResponse [ListMapsResponseEntry]
- listPlaceIndexes_maxResults :: Lens' ListPlaceIndexes (Maybe Natural)
- listPlaceIndexes_nextToken :: Lens' ListPlaceIndexes (Maybe Text)
- listPlaceIndexesResponse_nextToken :: Lens' ListPlaceIndexesResponse (Maybe Text)
- listPlaceIndexesResponse_httpStatus :: Lens' ListPlaceIndexesResponse Int
- listPlaceIndexesResponse_entries :: Lens' ListPlaceIndexesResponse [ListPlaceIndexesResponseEntry]
- listRouteCalculators_maxResults :: Lens' ListRouteCalculators (Maybe Natural)
- listRouteCalculators_nextToken :: Lens' ListRouteCalculators (Maybe Text)
- listRouteCalculatorsResponse_nextToken :: Lens' ListRouteCalculatorsResponse (Maybe Text)
- listRouteCalculatorsResponse_httpStatus :: Lens' ListRouteCalculatorsResponse Int
- listRouteCalculatorsResponse_entries :: Lens' ListRouteCalculatorsResponse [ListRouteCalculatorsResponseEntry]
- listTagsForResource_resourceArn :: Lens' ListTagsForResource Text
- listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text))
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
- listTrackerConsumers_maxResults :: Lens' ListTrackerConsumers (Maybe Natural)
- listTrackerConsumers_nextToken :: Lens' ListTrackerConsumers (Maybe Text)
- listTrackerConsumers_trackerName :: Lens' ListTrackerConsumers Text
- listTrackerConsumersResponse_nextToken :: Lens' ListTrackerConsumersResponse (Maybe Text)
- listTrackerConsumersResponse_httpStatus :: Lens' ListTrackerConsumersResponse Int
- listTrackerConsumersResponse_consumerArns :: Lens' ListTrackerConsumersResponse [Text]
- listTrackers_maxResults :: Lens' ListTrackers (Maybe Natural)
- listTrackers_nextToken :: Lens' ListTrackers (Maybe Text)
- listTrackersResponse_nextToken :: Lens' ListTrackersResponse (Maybe Text)
- listTrackersResponse_httpStatus :: Lens' ListTrackersResponse Int
- listTrackersResponse_entries :: Lens' ListTrackersResponse [ListTrackersResponseEntry]
- putGeofence_collectionName :: Lens' PutGeofence Text
- putGeofence_geofenceId :: Lens' PutGeofence Text
- putGeofence_geometry :: Lens' PutGeofence GeofenceGeometry
- putGeofenceResponse_httpStatus :: Lens' PutGeofenceResponse Int
- putGeofenceResponse_createTime :: Lens' PutGeofenceResponse UTCTime
- putGeofenceResponse_geofenceId :: Lens' PutGeofenceResponse Text
- putGeofenceResponse_updateTime :: Lens' PutGeofenceResponse UTCTime
- searchPlaceIndexForPosition_language :: Lens' SearchPlaceIndexForPosition (Maybe Text)
- searchPlaceIndexForPosition_maxResults :: Lens' SearchPlaceIndexForPosition (Maybe Natural)
- searchPlaceIndexForPosition_indexName :: Lens' SearchPlaceIndexForPosition Text
- searchPlaceIndexForPosition_position :: Lens' SearchPlaceIndexForPosition (NonEmpty Double)
- searchPlaceIndexForPositionResponse_httpStatus :: Lens' SearchPlaceIndexForPositionResponse Int
- searchPlaceIndexForPositionResponse_results :: Lens' SearchPlaceIndexForPositionResponse [SearchForPositionResult]
- searchPlaceIndexForPositionResponse_summary :: Lens' SearchPlaceIndexForPositionResponse SearchPlaceIndexForPositionSummary
- searchPlaceIndexForSuggestions_biasPosition :: Lens' SearchPlaceIndexForSuggestions (Maybe (NonEmpty Double))
- searchPlaceIndexForSuggestions_filterBBox :: Lens' SearchPlaceIndexForSuggestions (Maybe (NonEmpty Double))
- searchPlaceIndexForSuggestions_filterCountries :: Lens' SearchPlaceIndexForSuggestions (Maybe (NonEmpty Text))
- searchPlaceIndexForSuggestions_language :: Lens' SearchPlaceIndexForSuggestions (Maybe Text)
- searchPlaceIndexForSuggestions_maxResults :: Lens' SearchPlaceIndexForSuggestions (Maybe Natural)
- searchPlaceIndexForSuggestions_indexName :: Lens' SearchPlaceIndexForSuggestions Text
- searchPlaceIndexForSuggestions_text :: Lens' SearchPlaceIndexForSuggestions Text
- searchPlaceIndexForSuggestionsResponse_httpStatus :: Lens' SearchPlaceIndexForSuggestionsResponse Int
- searchPlaceIndexForSuggestionsResponse_results :: Lens' SearchPlaceIndexForSuggestionsResponse [SearchForSuggestionsResult]
- searchPlaceIndexForSuggestionsResponse_summary :: Lens' SearchPlaceIndexForSuggestionsResponse SearchPlaceIndexForSuggestionsSummary
- searchPlaceIndexForText_biasPosition :: Lens' SearchPlaceIndexForText (Maybe (NonEmpty Double))
- searchPlaceIndexForText_filterBBox :: Lens' SearchPlaceIndexForText (Maybe (NonEmpty Double))
- searchPlaceIndexForText_filterCountries :: Lens' SearchPlaceIndexForText (Maybe (NonEmpty Text))
- searchPlaceIndexForText_language :: Lens' SearchPlaceIndexForText (Maybe Text)
- searchPlaceIndexForText_maxResults :: Lens' SearchPlaceIndexForText (Maybe Natural)
- searchPlaceIndexForText_indexName :: Lens' SearchPlaceIndexForText Text
- searchPlaceIndexForText_text :: Lens' SearchPlaceIndexForText Text
- searchPlaceIndexForTextResponse_httpStatus :: Lens' SearchPlaceIndexForTextResponse Int
- searchPlaceIndexForTextResponse_results :: Lens' SearchPlaceIndexForTextResponse [SearchForTextResult]
- searchPlaceIndexForTextResponse_summary :: Lens' SearchPlaceIndexForTextResponse SearchPlaceIndexForTextSummary
- tagResource_resourceArn :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource (HashMap Text Text)
- tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
- untagResource_resourceArn :: Lens' UntagResource Text
- untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text)
- untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
- updateGeofenceCollection_description :: Lens' UpdateGeofenceCollection (Maybe Text)
- updateGeofenceCollection_pricingPlan :: Lens' UpdateGeofenceCollection (Maybe PricingPlan)
- updateGeofenceCollection_pricingPlanDataSource :: Lens' UpdateGeofenceCollection (Maybe Text)
- updateGeofenceCollection_collectionName :: Lens' UpdateGeofenceCollection Text
- updateGeofenceCollectionResponse_httpStatus :: Lens' UpdateGeofenceCollectionResponse Int
- updateGeofenceCollectionResponse_collectionArn :: Lens' UpdateGeofenceCollectionResponse Text
- updateGeofenceCollectionResponse_collectionName :: Lens' UpdateGeofenceCollectionResponse Text
- updateGeofenceCollectionResponse_updateTime :: Lens' UpdateGeofenceCollectionResponse UTCTime
- updateMap_description :: Lens' UpdateMap (Maybe Text)
- updateMap_pricingPlan :: Lens' UpdateMap (Maybe PricingPlan)
- updateMap_mapName :: Lens' UpdateMap Text
- updateMapResponse_httpStatus :: Lens' UpdateMapResponse Int
- updateMapResponse_mapArn :: Lens' UpdateMapResponse Text
- updateMapResponse_mapName :: Lens' UpdateMapResponse Text
- updateMapResponse_updateTime :: Lens' UpdateMapResponse UTCTime
- updatePlaceIndex_dataSourceConfiguration :: Lens' UpdatePlaceIndex (Maybe DataSourceConfiguration)
- updatePlaceIndex_description :: Lens' UpdatePlaceIndex (Maybe Text)
- updatePlaceIndex_pricingPlan :: Lens' UpdatePlaceIndex (Maybe PricingPlan)
- updatePlaceIndex_indexName :: Lens' UpdatePlaceIndex Text
- updatePlaceIndexResponse_httpStatus :: Lens' UpdatePlaceIndexResponse Int
- updatePlaceIndexResponse_indexArn :: Lens' UpdatePlaceIndexResponse Text
- updatePlaceIndexResponse_indexName :: Lens' UpdatePlaceIndexResponse Text
- updatePlaceIndexResponse_updateTime :: Lens' UpdatePlaceIndexResponse UTCTime
- updateRouteCalculator_description :: Lens' UpdateRouteCalculator (Maybe Text)
- updateRouteCalculator_pricingPlan :: Lens' UpdateRouteCalculator (Maybe PricingPlan)
- updateRouteCalculator_calculatorName :: Lens' UpdateRouteCalculator Text
- updateRouteCalculatorResponse_httpStatus :: Lens' UpdateRouteCalculatorResponse Int
- updateRouteCalculatorResponse_calculatorArn :: Lens' UpdateRouteCalculatorResponse Text
- updateRouteCalculatorResponse_calculatorName :: Lens' UpdateRouteCalculatorResponse Text
- updateRouteCalculatorResponse_updateTime :: Lens' UpdateRouteCalculatorResponse UTCTime
- updateTracker_description :: Lens' UpdateTracker (Maybe Text)
- updateTracker_positionFiltering :: Lens' UpdateTracker (Maybe PositionFiltering)
- updateTracker_pricingPlan :: Lens' UpdateTracker (Maybe PricingPlan)
- updateTracker_pricingPlanDataSource :: Lens' UpdateTracker (Maybe Text)
- updateTracker_trackerName :: Lens' UpdateTracker Text
- updateTrackerResponse_httpStatus :: Lens' UpdateTrackerResponse Int
- updateTrackerResponse_trackerArn :: Lens' UpdateTrackerResponse Text
- updateTrackerResponse_trackerName :: Lens' UpdateTrackerResponse Text
- updateTrackerResponse_updateTime :: Lens' UpdateTrackerResponse UTCTime
- batchDeleteDevicePositionHistoryError_deviceId :: Lens' BatchDeleteDevicePositionHistoryError Text
- batchDeleteDevicePositionHistoryError_error :: Lens' BatchDeleteDevicePositionHistoryError BatchItemError
- batchDeleteGeofenceError_error :: Lens' BatchDeleteGeofenceError BatchItemError
- batchDeleteGeofenceError_geofenceId :: Lens' BatchDeleteGeofenceError Text
- batchEvaluateGeofencesError_deviceId :: Lens' BatchEvaluateGeofencesError Text
- batchEvaluateGeofencesError_error :: Lens' BatchEvaluateGeofencesError BatchItemError
- batchEvaluateGeofencesError_sampleTime :: Lens' BatchEvaluateGeofencesError UTCTime
- batchGetDevicePositionError_deviceId :: Lens' BatchGetDevicePositionError Text
- batchGetDevicePositionError_error :: Lens' BatchGetDevicePositionError BatchItemError
- batchItemError_code :: Lens' BatchItemError (Maybe BatchItemErrorCode)
- batchItemError_message :: Lens' BatchItemError (Maybe Text)
- batchPutGeofenceError_error :: Lens' BatchPutGeofenceError BatchItemError
- batchPutGeofenceError_geofenceId :: Lens' BatchPutGeofenceError Text
- batchPutGeofenceRequestEntry_geofenceId :: Lens' BatchPutGeofenceRequestEntry Text
- batchPutGeofenceRequestEntry_geometry :: Lens' BatchPutGeofenceRequestEntry GeofenceGeometry
- batchPutGeofenceSuccess_createTime :: Lens' BatchPutGeofenceSuccess UTCTime
- batchPutGeofenceSuccess_geofenceId :: Lens' BatchPutGeofenceSuccess Text
- batchPutGeofenceSuccess_updateTime :: Lens' BatchPutGeofenceSuccess UTCTime
- batchUpdateDevicePositionError_deviceId :: Lens' BatchUpdateDevicePositionError Text
- batchUpdateDevicePositionError_error :: Lens' BatchUpdateDevicePositionError BatchItemError
- batchUpdateDevicePositionError_sampleTime :: Lens' BatchUpdateDevicePositionError UTCTime
- calculateRouteCarModeOptions_avoidFerries :: Lens' CalculateRouteCarModeOptions (Maybe Bool)
- calculateRouteCarModeOptions_avoidTolls :: Lens' CalculateRouteCarModeOptions (Maybe Bool)
- calculateRouteMatrixSummary_dataSource :: Lens' CalculateRouteMatrixSummary Text
- calculateRouteMatrixSummary_distanceUnit :: Lens' CalculateRouteMatrixSummary DistanceUnit
- calculateRouteMatrixSummary_errorCount :: Lens' CalculateRouteMatrixSummary Natural
- calculateRouteMatrixSummary_routeCount :: Lens' CalculateRouteMatrixSummary Natural
- calculateRouteSummary_dataSource :: Lens' CalculateRouteSummary Text
- calculateRouteSummary_distance :: Lens' CalculateRouteSummary Double
- calculateRouteSummary_distanceUnit :: Lens' CalculateRouteSummary DistanceUnit
- calculateRouteSummary_durationSeconds :: Lens' CalculateRouteSummary Double
- calculateRouteSummary_routeBBox :: Lens' CalculateRouteSummary (NonEmpty Double)
- calculateRouteTruckModeOptions_avoidFerries :: Lens' CalculateRouteTruckModeOptions (Maybe Bool)
- calculateRouteTruckModeOptions_avoidTolls :: Lens' CalculateRouteTruckModeOptions (Maybe Bool)
- calculateRouteTruckModeOptions_dimensions :: Lens' CalculateRouteTruckModeOptions (Maybe TruckDimensions)
- calculateRouteTruckModeOptions_weight :: Lens' CalculateRouteTruckModeOptions (Maybe TruckWeight)
- circle_center :: Lens' Circle (NonEmpty Double)
- circle_radius :: Lens' Circle Double
- dataSourceConfiguration_intendedUse :: Lens' DataSourceConfiguration (Maybe IntendedUse)
- devicePosition_accuracy :: Lens' DevicePosition (Maybe PositionalAccuracy)
- devicePosition_deviceId :: Lens' DevicePosition (Maybe Text)
- devicePosition_positionProperties :: Lens' DevicePosition (Maybe (HashMap Text Text))
- devicePosition_position :: Lens' DevicePosition (NonEmpty Double)
- devicePosition_receivedTime :: Lens' DevicePosition UTCTime
- devicePosition_sampleTime :: Lens' DevicePosition UTCTime
- devicePositionUpdate_accuracy :: Lens' DevicePositionUpdate (Maybe PositionalAccuracy)
- devicePositionUpdate_positionProperties :: Lens' DevicePositionUpdate (Maybe (HashMap Text Text))
- devicePositionUpdate_deviceId :: Lens' DevicePositionUpdate Text
- devicePositionUpdate_position :: Lens' DevicePositionUpdate (NonEmpty Double)
- devicePositionUpdate_sampleTime :: Lens' DevicePositionUpdate UTCTime
- geofenceGeometry_circle :: Lens' GeofenceGeometry (Maybe Circle)
- geofenceGeometry_polygon :: Lens' GeofenceGeometry (Maybe (NonEmpty (NonEmpty (NonEmpty Double))))
- leg_geometry :: Lens' Leg (Maybe LegGeometry)
- leg_distance :: Lens' Leg Double
- leg_durationSeconds :: Lens' Leg Double
- leg_endPosition :: Lens' Leg (NonEmpty Double)
- leg_startPosition :: Lens' Leg (NonEmpty Double)
- leg_steps :: Lens' Leg [Step]
- legGeometry_lineString :: Lens' LegGeometry (Maybe (NonEmpty (NonEmpty Double)))
- listDevicePositionsResponseEntry_accuracy :: Lens' ListDevicePositionsResponseEntry (Maybe PositionalAccuracy)
- listDevicePositionsResponseEntry_positionProperties :: Lens' ListDevicePositionsResponseEntry (Maybe (HashMap Text Text))
- listDevicePositionsResponseEntry_deviceId :: Lens' ListDevicePositionsResponseEntry Text
- listDevicePositionsResponseEntry_position :: Lens' ListDevicePositionsResponseEntry (NonEmpty Double)
- listDevicePositionsResponseEntry_sampleTime :: Lens' ListDevicePositionsResponseEntry UTCTime
- listGeofenceCollectionsResponseEntry_pricingPlan :: Lens' ListGeofenceCollectionsResponseEntry (Maybe PricingPlan)
- listGeofenceCollectionsResponseEntry_pricingPlanDataSource :: Lens' ListGeofenceCollectionsResponseEntry (Maybe Text)
- listGeofenceCollectionsResponseEntry_collectionName :: Lens' ListGeofenceCollectionsResponseEntry Text
- listGeofenceCollectionsResponseEntry_createTime :: Lens' ListGeofenceCollectionsResponseEntry UTCTime
- listGeofenceCollectionsResponseEntry_description :: Lens' ListGeofenceCollectionsResponseEntry Text
- listGeofenceCollectionsResponseEntry_updateTime :: Lens' ListGeofenceCollectionsResponseEntry UTCTime
- listGeofenceResponseEntry_createTime :: Lens' ListGeofenceResponseEntry UTCTime
- listGeofenceResponseEntry_geofenceId :: Lens' ListGeofenceResponseEntry Text
- listGeofenceResponseEntry_geometry :: Lens' ListGeofenceResponseEntry GeofenceGeometry
- listGeofenceResponseEntry_status :: Lens' ListGeofenceResponseEntry Text
- listGeofenceResponseEntry_updateTime :: Lens' ListGeofenceResponseEntry UTCTime
- listMapsResponseEntry_pricingPlan :: Lens' ListMapsResponseEntry (Maybe PricingPlan)
- listMapsResponseEntry_createTime :: Lens' ListMapsResponseEntry UTCTime
- listMapsResponseEntry_dataSource :: Lens' ListMapsResponseEntry Text
- listMapsResponseEntry_description :: Lens' ListMapsResponseEntry Text
- listMapsResponseEntry_mapName :: Lens' ListMapsResponseEntry Text
- listMapsResponseEntry_updateTime :: Lens' ListMapsResponseEntry UTCTime
- listPlaceIndexesResponseEntry_pricingPlan :: Lens' ListPlaceIndexesResponseEntry (Maybe PricingPlan)
- listPlaceIndexesResponseEntry_createTime :: Lens' ListPlaceIndexesResponseEntry UTCTime
- listPlaceIndexesResponseEntry_dataSource :: Lens' ListPlaceIndexesResponseEntry Text
- listPlaceIndexesResponseEntry_description :: Lens' ListPlaceIndexesResponseEntry Text
- listPlaceIndexesResponseEntry_indexName :: Lens' ListPlaceIndexesResponseEntry Text
- listPlaceIndexesResponseEntry_updateTime :: Lens' ListPlaceIndexesResponseEntry UTCTime
- listRouteCalculatorsResponseEntry_pricingPlan :: Lens' ListRouteCalculatorsResponseEntry (Maybe PricingPlan)
- listRouteCalculatorsResponseEntry_calculatorName :: Lens' ListRouteCalculatorsResponseEntry Text
- listRouteCalculatorsResponseEntry_createTime :: Lens' ListRouteCalculatorsResponseEntry UTCTime
- listRouteCalculatorsResponseEntry_dataSource :: Lens' ListRouteCalculatorsResponseEntry Text
- listRouteCalculatorsResponseEntry_description :: Lens' ListRouteCalculatorsResponseEntry Text
- listRouteCalculatorsResponseEntry_updateTime :: Lens' ListRouteCalculatorsResponseEntry UTCTime
- listTrackersResponseEntry_pricingPlan :: Lens' ListTrackersResponseEntry (Maybe PricingPlan)
- listTrackersResponseEntry_pricingPlanDataSource :: Lens' ListTrackersResponseEntry (Maybe Text)
- listTrackersResponseEntry_createTime :: Lens' ListTrackersResponseEntry UTCTime
- listTrackersResponseEntry_description :: Lens' ListTrackersResponseEntry Text
- listTrackersResponseEntry_trackerName :: Lens' ListTrackersResponseEntry Text
- listTrackersResponseEntry_updateTime :: Lens' ListTrackersResponseEntry UTCTime
- mapConfiguration_style :: Lens' MapConfiguration Text
- place_addressNumber :: Lens' Place (Maybe Text)
- place_country :: Lens' Place (Maybe Text)
- place_interpolated :: Lens' Place (Maybe Bool)
- place_label :: Lens' Place (Maybe Text)
- place_municipality :: Lens' Place (Maybe Text)
- place_neighborhood :: Lens' Place (Maybe Text)
- place_postalCode :: Lens' Place (Maybe Text)
- place_region :: Lens' Place (Maybe Text)
- place_street :: Lens' Place (Maybe Text)
- place_subRegion :: Lens' Place (Maybe Text)
- place_timeZone :: Lens' Place (Maybe TimeZone)
- place_unitNumber :: Lens' Place (Maybe Text)
- place_unitType :: Lens' Place (Maybe Text)
- place_geometry :: Lens' Place PlaceGeometry
- placeGeometry_point :: Lens' PlaceGeometry (Maybe (NonEmpty Double))
- positionalAccuracy_horizontal :: Lens' PositionalAccuracy Double
- routeMatrixEntry_distance :: Lens' RouteMatrixEntry (Maybe Double)
- routeMatrixEntry_durationSeconds :: Lens' RouteMatrixEntry (Maybe Double)
- routeMatrixEntry_error :: Lens' RouteMatrixEntry (Maybe RouteMatrixEntryError)
- routeMatrixEntryError_message :: Lens' RouteMatrixEntryError (Maybe Text)
- routeMatrixEntryError_code :: Lens' RouteMatrixEntryError RouteMatrixErrorCode
- searchForPositionResult_placeId :: Lens' SearchForPositionResult (Maybe Text)
- searchForPositionResult_distance :: Lens' SearchForPositionResult Double
- searchForPositionResult_place :: Lens' SearchForPositionResult Place
- searchForSuggestionsResult_placeId :: Lens' SearchForSuggestionsResult (Maybe Text)
- searchForSuggestionsResult_text :: Lens' SearchForSuggestionsResult Text
- searchForTextResult_distance :: Lens' SearchForTextResult (Maybe Double)
- searchForTextResult_placeId :: Lens' SearchForTextResult (Maybe Text)
- searchForTextResult_relevance :: Lens' SearchForTextResult (Maybe Double)
- searchForTextResult_place :: Lens' SearchForTextResult Place
- searchPlaceIndexForPositionSummary_language :: Lens' SearchPlaceIndexForPositionSummary (Maybe Text)
- searchPlaceIndexForPositionSummary_maxResults :: Lens' SearchPlaceIndexForPositionSummary (Maybe Natural)
- searchPlaceIndexForPositionSummary_dataSource :: Lens' SearchPlaceIndexForPositionSummary Text
- searchPlaceIndexForPositionSummary_position :: Lens' SearchPlaceIndexForPositionSummary (NonEmpty Double)
- searchPlaceIndexForSuggestionsSummary_biasPosition :: Lens' SearchPlaceIndexForSuggestionsSummary (Maybe (NonEmpty Double))
- searchPlaceIndexForSuggestionsSummary_filterBBox :: Lens' SearchPlaceIndexForSuggestionsSummary (Maybe (NonEmpty Double))
- searchPlaceIndexForSuggestionsSummary_filterCountries :: Lens' SearchPlaceIndexForSuggestionsSummary (Maybe (NonEmpty Text))
- searchPlaceIndexForSuggestionsSummary_language :: Lens' SearchPlaceIndexForSuggestionsSummary (Maybe Text)
- searchPlaceIndexForSuggestionsSummary_maxResults :: Lens' SearchPlaceIndexForSuggestionsSummary (Maybe Int)
- searchPlaceIndexForSuggestionsSummary_dataSource :: Lens' SearchPlaceIndexForSuggestionsSummary Text
- searchPlaceIndexForSuggestionsSummary_text :: Lens' SearchPlaceIndexForSuggestionsSummary Text
- searchPlaceIndexForTextSummary_biasPosition :: Lens' SearchPlaceIndexForTextSummary (Maybe (NonEmpty Double))
- searchPlaceIndexForTextSummary_filterBBox :: Lens' SearchPlaceIndexForTextSummary (Maybe (NonEmpty Double))
- searchPlaceIndexForTextSummary_filterCountries :: Lens' SearchPlaceIndexForTextSummary (Maybe (NonEmpty Text))
- searchPlaceIndexForTextSummary_language :: Lens' SearchPlaceIndexForTextSummary (Maybe Text)
- searchPlaceIndexForTextSummary_maxResults :: Lens' SearchPlaceIndexForTextSummary (Maybe Natural)
- searchPlaceIndexForTextSummary_resultBBox :: Lens' SearchPlaceIndexForTextSummary (Maybe (NonEmpty Double))
- searchPlaceIndexForTextSummary_dataSource :: Lens' SearchPlaceIndexForTextSummary Text
- searchPlaceIndexForTextSummary_text :: Lens' SearchPlaceIndexForTextSummary Text
- step_geometryOffset :: Lens' Step (Maybe Natural)
- step_distance :: Lens' Step Double
- step_durationSeconds :: Lens' Step Double
- step_endPosition :: Lens' Step (NonEmpty Double)
- step_startPosition :: Lens' Step (NonEmpty Double)
- timeZone_offset :: Lens' TimeZone (Maybe Int)
- timeZone_name :: Lens' TimeZone Text
- truckDimensions_height :: Lens' TruckDimensions (Maybe Double)
- truckDimensions_length :: Lens' TruckDimensions (Maybe Double)
- truckDimensions_unit :: Lens' TruckDimensions (Maybe DimensionUnit)
- truckDimensions_width :: Lens' TruckDimensions (Maybe Double)
- truckWeight_total :: Lens' TruckWeight (Maybe Double)
- truckWeight_unit :: Lens' TruckWeight (Maybe VehicleWeightUnit)
Operations
AssociateTrackerConsumer
associateTrackerConsumer_consumerArn :: Lens' AssociateTrackerConsumer Text Source #
The Amazon Resource Name (ARN) for the geofence collection to be associated to tracker resource. Used when you need to specify a resource across all AWS.
- Format example:
arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer
associateTrackerConsumer_trackerName :: Lens' AssociateTrackerConsumer Text Source #
The name of the tracker resource to be associated with a geofence collection.
associateTrackerConsumerResponse_httpStatus :: Lens' AssociateTrackerConsumerResponse Int Source #
The response's http status code.
BatchDeleteDevicePositionHistory
batchDeleteDevicePositionHistory_deviceIds :: Lens' BatchDeleteDevicePositionHistory (NonEmpty Text) Source #
Devices whose position history you want to delete.
- For example, for two devices:
“DeviceIds” : [DeviceId1,DeviceId2]
batchDeleteDevicePositionHistory_trackerName :: Lens' BatchDeleteDevicePositionHistory Text Source #
The name of the tracker resource to delete the device position history from.
batchDeleteDevicePositionHistoryResponse_httpStatus :: Lens' BatchDeleteDevicePositionHistoryResponse Int Source #
The response's http status code.
batchDeleteDevicePositionHistoryResponse_errors :: Lens' BatchDeleteDevicePositionHistoryResponse [BatchDeleteDevicePositionHistoryError] Source #
Contains error details for each device history that failed to delete.
BatchDeleteGeofence
batchDeleteGeofence_collectionName :: Lens' BatchDeleteGeofence Text Source #
The geofence collection storing the geofences to be deleted.
batchDeleteGeofence_geofenceIds :: Lens' BatchDeleteGeofence (NonEmpty Text) Source #
The batch of geofences to be deleted.
batchDeleteGeofenceResponse_httpStatus :: Lens' BatchDeleteGeofenceResponse Int Source #
The response's http status code.
batchDeleteGeofenceResponse_errors :: Lens' BatchDeleteGeofenceResponse [BatchDeleteGeofenceError] Source #
Contains error details for each geofence that failed to delete.
BatchEvaluateGeofences
batchEvaluateGeofences_collectionName :: Lens' BatchEvaluateGeofences Text Source #
The geofence collection used in evaluating the position of devices against its geofences.
batchEvaluateGeofences_devicePositionUpdates :: Lens' BatchEvaluateGeofences (NonEmpty DevicePositionUpdate) Source #
Contains device details for each device to be evaluated against the given geofence collection.
batchEvaluateGeofencesResponse_httpStatus :: Lens' BatchEvaluateGeofencesResponse Int Source #
The response's http status code.
batchEvaluateGeofencesResponse_errors :: Lens' BatchEvaluateGeofencesResponse [BatchEvaluateGeofencesError] Source #
Contains error details for each device that failed to evaluate its position against the given geofence collection.
BatchGetDevicePosition
batchGetDevicePosition_deviceIds :: Lens' BatchGetDevicePosition (NonEmpty Text) Source #
Devices whose position you want to retrieve.
- For example, for two devices:
device-ids=DeviceId1&device-ids=DeviceId2
batchGetDevicePosition_trackerName :: Lens' BatchGetDevicePosition Text Source #
The tracker resource retrieving the device position.
batchGetDevicePositionResponse_httpStatus :: Lens' BatchGetDevicePositionResponse Int Source #
The response's http status code.
batchGetDevicePositionResponse_devicePositions :: Lens' BatchGetDevicePositionResponse [DevicePosition] Source #
Contains device position details such as the device ID, position, and timestamps for when the position was received and sampled.
batchGetDevicePositionResponse_errors :: Lens' BatchGetDevicePositionResponse [BatchGetDevicePositionError] Source #
Contains error details for each device that failed to send its position to the tracker resource.
BatchPutGeofence
batchPutGeofence_collectionName :: Lens' BatchPutGeofence Text Source #
The geofence collection storing the geofences.
batchPutGeofence_entries :: Lens' BatchPutGeofence (NonEmpty BatchPutGeofenceRequestEntry) Source #
The batch of geofences to be stored in a geofence collection.
batchPutGeofenceResponse_httpStatus :: Lens' BatchPutGeofenceResponse Int Source #
The response's http status code.
batchPutGeofenceResponse_errors :: Lens' BatchPutGeofenceResponse [BatchPutGeofenceError] Source #
Contains additional error details for each geofence that failed to be stored in a geofence collection.
batchPutGeofenceResponse_successes :: Lens' BatchPutGeofenceResponse [BatchPutGeofenceSuccess] Source #
Contains each geofence that was successfully stored in a geofence collection.
BatchUpdateDevicePosition
batchUpdateDevicePosition_trackerName :: Lens' BatchUpdateDevicePosition Text Source #
The name of the tracker resource to update.
batchUpdateDevicePosition_updates :: Lens' BatchUpdateDevicePosition (NonEmpty DevicePositionUpdate) Source #
Contains the position update details for each device.
batchUpdateDevicePositionResponse_httpStatus :: Lens' BatchUpdateDevicePositionResponse Int Source #
The response's http status code.
batchUpdateDevicePositionResponse_errors :: Lens' BatchUpdateDevicePositionResponse [BatchUpdateDevicePositionError] Source #
Contains error details for each device that failed to update its position.
CalculateRoute
calculateRoute_carModeOptions :: Lens' CalculateRoute (Maybe CalculateRouteCarModeOptions) Source #
Specifies route preferences when traveling by Car
, such as avoiding
routes that use ferries or tolls.
Requirements: TravelMode
must be specified as Car
.
calculateRoute_departNow :: Lens' CalculateRoute (Maybe Bool) Source #
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
calculateRoute_departureTime :: Lens' CalculateRoute (Maybe UTCTime) Source #
Specifies the desired time of departure. Uses the given time to calculate the route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.
Setting a departure time in the past returns a 400 ValidationException
error.
- In ISO 8601
format:
YYYY-MM-DDThh:mm:ss.sssZ
. For example,2020–07-2T12:15:20.000Z+01:00
calculateRoute_distanceUnit :: Lens' CalculateRoute (Maybe DistanceUnit) Source #
Set the unit system to specify the distance.
Default Value: Kilometers
calculateRoute_includeLegGeometry :: Lens' CalculateRoute (Maybe Bool) Source #
Set to include the geometry details in the result for each path between a pair of positions.
Default Value: false
Valid Values: false
| true
calculateRoute_travelMode :: Lens' CalculateRoute (Maybe TravelMode) Source #
Specifies the mode of transport when calculating a route. Used in
estimating the speed of travel and road compatibility. You can choose
Car
, Truck
, or Walking
as options for the TravelMode
.
The TravelMode
you specify also determines how you specify route
preferences:
- If traveling by
Car
use theCarModeOptions
parameter. - If traveling by
Truck
use theTruckModeOptions
parameter.
Default Value: Car
calculateRoute_truckModeOptions :: Lens' CalculateRoute (Maybe CalculateRouteTruckModeOptions) Source #
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
.
calculateRoute_waypointPositions :: Lens' CalculateRoute (Maybe [NonEmpty Double]) Source #
Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.
- For example, from the
DeparturePosition
[-123.115, 49.285]
, the route follows the order that the waypoint positions are given[[-122.757, 49.0021],[-122.349, 47.620]]
If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.
Specifying more than 23 waypoints returns a 400 ValidationException
error.
If Esri is the provider for your route calculator, specifying a route
that is longer than 400 km returns a 400 RoutesValidationException
error.
Valid Values: [-180 to 180,-90 to 90]
calculateRoute_calculatorName :: Lens' CalculateRoute Text Source #
The name of the route calculator resource that you want to use to calculate the route.
calculateRoute_departurePosition :: Lens' CalculateRoute (NonEmpty Double) Source #
The start position for the route. Defined in
World Geodetic System (WGS 84)
format: [longitude, latitude]
.
- For example,
[-123.115, 49.285]
If you specify a departure that's not located on a road, Amazon
Location
moves the position to the nearest road.
If Esri is the provider for your route calculator, specifying a route
that is longer than 400 km returns a 400 RoutesValidationException
error.
Valid Values: [-180 to 180,-90 to 90]
calculateRoute_destinationPosition :: Lens' CalculateRoute (NonEmpty Double) Source #
The finish position for the route. Defined in
World Geodetic System (WGS 84)
format: [longitude, latitude]
.
- For example,
[-122.339, 47.615]
If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.
Valid Values: [-180 to 180,-90 to 90]
calculateRouteResponse_httpStatus :: Lens' CalculateRouteResponse Int Source #
The response's http status code.
calculateRouteResponse_legs :: Lens' CalculateRouteResponse [Leg] Source #
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.
calculateRouteResponse_summary :: Lens' CalculateRouteResponse CalculateRouteSummary Source #
Contains information about the whole route, such as: RouteBBox
,
DataSource
, Distance
, DistanceUnit
, and DurationSeconds
.
CalculateRouteMatrix
calculateRouteMatrix_carModeOptions :: Lens' CalculateRouteMatrix (Maybe CalculateRouteCarModeOptions) Source #
Specifies route preferences when traveling by Car
, such as avoiding
routes that use ferries or tolls.
Requirements: TravelMode
must be specified as Car
.
calculateRouteMatrix_departNow :: Lens' CalculateRouteMatrix (Maybe Bool) Source #
Sets the time of departure as the current time. Uses the current time to
calculate the route matrix. You can't set both DepartureTime
and
DepartNow
. If neither is set, the best time of day to travel with the
best traffic conditions is used to calculate the route matrix.
Default Value: false
Valid Values: false
| true
calculateRouteMatrix_departureTime :: Lens' CalculateRouteMatrix (Maybe UTCTime) Source #
Specifies the desired time of departure. Uses the given time to
calculate the route matrix. You can't set both DepartureTime
and
DepartNow
. If neither is set, the best time of day to travel with the
best traffic conditions is used to calculate the route matrix.
Setting a departure time in the past returns a 400 ValidationException
error.
- In ISO 8601
format:
YYYY-MM-DDThh:mm:ss.sssZ
. For example,2020–07-2T12:15:20.000Z+01:00
calculateRouteMatrix_distanceUnit :: Lens' CalculateRouteMatrix (Maybe DistanceUnit) Source #
Set the unit system to specify the distance.
Default Value: Kilometers
calculateRouteMatrix_travelMode :: Lens' CalculateRouteMatrix (Maybe TravelMode) Source #
Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.
The TravelMode
you specify also determines how you specify route
preferences:
- If traveling by
Car
use theCarModeOptions
parameter. - If traveling by
Truck
use theTruckModeOptions
parameter.
Default Value: Car
calculateRouteMatrix_truckModeOptions :: Lens' CalculateRouteMatrix (Maybe CalculateRouteTruckModeOptions) Source #
Specifies route preferences when traveling by Truck
, such as avoiding
routes that use ferries or tolls, and truck specifications to consider
when choosing an optimal road.
Requirements: TravelMode
must be specified as Truck
.
calculateRouteMatrix_calculatorName :: Lens' CalculateRouteMatrix Text Source #
The name of the route calculator resource that you want to use to calculate the route matrix.
calculateRouteMatrix_departurePositions :: Lens' CalculateRouteMatrix (NonEmpty (NonEmpty Double)) Source #
The list of departure (origin) positions for the route matrix. An array
of points, each of which is itself a 2-value array defined in
WGS 84 format:
[longitude, latitude]
. For example, [-123.115, 49.285]
.
Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.
For route calculators that use Esri as the data provider, if you specify
a departure that's not located on a road, Amazon Location
moves the position to the nearest road.
The snapped value is available in the result in
SnappedDeparturePositions
.
Valid Values: [-180 to 180,-90 to 90]
calculateRouteMatrix_destinationPositions :: Lens' CalculateRouteMatrix (NonEmpty (NonEmpty Double)) Source #
The list of destination positions for the route matrix. An array of
points, each of which is itself a 2-value array defined in
WGS 84 format:
[longitude, latitude]
. For example, [-122.339, 47.615]
Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.
For route calculators that use Esri as the data provider, if you specify
a destination that's not located on a road, Amazon Location
moves the position to the nearest road.
The snapped value is available in the result in
SnappedDestinationPositions
.
Valid Values: [-180 to 180,-90 to 90]
calculateRouteMatrixResponse_snappedDeparturePositions :: Lens' CalculateRouteMatrixResponse (Maybe (NonEmpty (NonEmpty Double))) Source #
For routes calculated using an Esri route calculator resource, departure
positions are snapped to the closest road. For Esri route calculator
resources, this returns the list of departure/origin positions used for
calculation of the RouteMatrix
.
calculateRouteMatrixResponse_snappedDestinationPositions :: Lens' CalculateRouteMatrixResponse (Maybe (NonEmpty (NonEmpty Double))) Source #
The list of destination positions for the route matrix used for
calculation of the RouteMatrix
.
calculateRouteMatrixResponse_httpStatus :: Lens' CalculateRouteMatrixResponse Int Source #
The response's http status code.
calculateRouteMatrixResponse_routeMatrix :: Lens' CalculateRouteMatrixResponse [[RouteMatrixEntry]] Source #
The calculated route matrix containing the results for all pairs of
DeparturePositions
to DestinationPositions
. Each row corresponds to
one entry in DeparturePositions
. Each entry in the row corresponds to
the route from that entry in DeparturePositions
to an entry in
DestinationPositions
.
calculateRouteMatrixResponse_summary :: Lens' CalculateRouteMatrixResponse CalculateRouteMatrixSummary Source #
Contains information about the route matrix, DataSource
,
DistanceUnit
, RouteCount
and ErrorCount
.
CreateGeofenceCollection
createGeofenceCollection_description :: Lens' CreateGeofenceCollection (Maybe Text) Source #
An optional description for the geofence collection.
createGeofenceCollection_kmsKeyId :: Lens' CreateGeofenceCollection (Maybe Text) Source #
A key identifier for an AWS KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.
createGeofenceCollection_pricingPlan :: Lens' CreateGeofenceCollection (Maybe PricingPlan) Source #
No longer used. If included, the only allowed value is
RequestBasedUsage
.
createGeofenceCollection_pricingPlanDataSource :: Lens' CreateGeofenceCollection (Maybe Text) Source #
This parameter is no longer used.
createGeofenceCollection_tags :: Lens' CreateGeofenceCollection (Maybe (HashMap Text Text)) Source #
Applies one or more tags to the geofence collection. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.
Format: "key" : "value"
Restrictions:
- Maximum 50 tags per resource
- Each resource tag must be unique with a maximum of one value.
- Maximum key length: 128 Unicode characters in UTF-8
- Maximum value length: 256 Unicode characters in UTF-8
- Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
- Cannot use "aws:" as a prefix for a key.
createGeofenceCollection_collectionName :: Lens' CreateGeofenceCollection Text Source #
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
.
createGeofenceCollectionResponse_httpStatus :: Lens' CreateGeofenceCollectionResponse Int Source #
The response's http status code.
createGeofenceCollectionResponse_collectionArn :: Lens' CreateGeofenceCollectionResponse Text Source #
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
createGeofenceCollectionResponse_collectionName :: Lens' CreateGeofenceCollectionResponse Text Source #
The name for the geofence collection.
createGeofenceCollectionResponse_createTime :: Lens' CreateGeofenceCollectionResponse UTCTime Source #
The timestamp for when the geofence collection was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
CreateMap
createMap_description :: Lens' CreateMap (Maybe Text) Source #
An optional description for the map resource.
createMap_pricingPlan :: Lens' CreateMap (Maybe PricingPlan) Source #
No longer used. If included, the only allowed value is
RequestBasedUsage
.
createMap_tags :: Lens' CreateMap (Maybe (HashMap Text Text)) Source #
Applies one or more tags to the map resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.
Format: "key" : "value"
Restrictions:
- Maximum 50 tags per resource
- Each resource tag must be unique with a maximum of one value.
- Maximum key length: 128 Unicode characters in UTF-8
- Maximum value length: 256 Unicode characters in UTF-8
- Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
- Cannot use "aws:" as a prefix for a key.
createMap_configuration :: Lens' CreateMap MapConfiguration Source #
Specifies the MapConfiguration
, including the map style, for the map
resource that you create. The map style defines the look of maps and the
data provider for your map resource.
createMap_mapName :: Lens' CreateMap Text Source #
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
.
createMapResponse_httpStatus :: Lens' CreateMapResponse Int Source #
The response's http status code.
createMapResponse_createTime :: Lens' CreateMapResponse UTCTime Source #
The timestamp for when the map resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
createMapResponse_mapArn :: Lens' CreateMapResponse Text Source #
The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS.
- Format example:
arn:aws:geo:region:account-id:map/ExampleMap
createMapResponse_mapName :: Lens' CreateMapResponse Text Source #
The name of the map resource.
CreatePlaceIndex
createPlaceIndex_dataSourceConfiguration :: Lens' CreatePlaceIndex (Maybe DataSourceConfiguration) Source #
Specifies the data storage option requesting Places.
createPlaceIndex_description :: Lens' CreatePlaceIndex (Maybe Text) Source #
The optional description for the place index resource.
createPlaceIndex_pricingPlan :: Lens' CreatePlaceIndex (Maybe PricingPlan) Source #
No longer used. If included, the only allowed value is
RequestBasedUsage
.
createPlaceIndex_tags :: Lens' CreatePlaceIndex (Maybe (HashMap Text Text)) Source #
Applies one or more tags to the place index resource. A tag is a key-value pair that helps you manage, identify, search, and filter your resources.
Format: "key" : "value"
Restrictions:
- Maximum 50 tags per resource.
- Each tag key must be unique and must have exactly one associated value.
- Maximum key length: 128 Unicode characters in UTF-8.
- Maximum value length: 256 Unicode characters in UTF-8.
- Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @
- Cannot use "aws:" as a prefix for a key.
createPlaceIndex_dataSource :: Lens' CreatePlaceIndex Text Source #
Specifies the geospatial data provider for the new place index.
This field is case-sensitive. Enter the valid values as shown. For
example, entering HERE
returns an error.
Valid values include:
Esri
– For additional information about Esri's coverage in your region of interest, see Esri details on geocoding coverage.Here
– For additional information about HERE Technologies' coverage in your region of interest, see HERE details on goecoding coverage.If you specify HERE Technologies (
Here
) as the data provider, you may not store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.
For additional information , see Data providers on the Amazon Location Service Developer Guide.
createPlaceIndex_indexName :: Lens' CreatePlaceIndex Text Source #
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
.
createPlaceIndexResponse_httpStatus :: Lens' CreatePlaceIndexResponse Int Source #
The response's http status code.
createPlaceIndexResponse_createTime :: Lens' CreatePlaceIndexResponse UTCTime Source #
The timestamp for when the place index resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
createPlaceIndexResponse_indexArn :: Lens' CreatePlaceIndexResponse Text Source #
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
createPlaceIndexResponse_indexName :: Lens' CreatePlaceIndexResponse Text Source #
The name for the place index resource.
CreateRouteCalculator
createRouteCalculator_description :: Lens' CreateRouteCalculator (Maybe Text) Source #
The optional description for the route calculator resource.
createRouteCalculator_pricingPlan :: Lens' CreateRouteCalculator (Maybe PricingPlan) Source #
No longer used. If included, the only allowed value is
RequestBasedUsage
.
createRouteCalculator_tags :: Lens' CreateRouteCalculator (Maybe (HashMap Text Text)) Source #
Applies one or more tags to the route calculator resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.
- For example: {
"tag1" : "value1"
,"tag2" : "value2"
}
Format: "key" : "value"
Restrictions:
- Maximum 50 tags per resource
- Each resource tag must be unique with a maximum of one value.
- Maximum key length: 128 Unicode characters in UTF-8
- Maximum value length: 256 Unicode characters in UTF-8
- Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
- Cannot use "aws:" as a prefix for a key.
createRouteCalculator_calculatorName :: Lens' CreateRouteCalculator Text Source #
The name of the route calculator resource.
Requirements:
- Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.), and underscores (_).
- Must be a unique Route calculator resource name.
- No spaces allowed. For example,
ExampleRouteCalculator
.
createRouteCalculator_dataSource :: Lens' CreateRouteCalculator Text Source #
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.
createRouteCalculatorResponse_httpStatus :: Lens' CreateRouteCalculatorResponse Int Source #
The response's http status code.
createRouteCalculatorResponse_calculatorArn :: Lens' CreateRouteCalculatorResponse Text Source #
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
createRouteCalculatorResponse_calculatorName :: Lens' CreateRouteCalculatorResponse Text Source #
The name of the route calculator resource.
- For example,
ExampleRouteCalculator
.
createRouteCalculatorResponse_createTime :: Lens' CreateRouteCalculatorResponse UTCTime Source #
The timestamp when the route calculator resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
- For example,
2020–07-2T12:15:20.000Z+01:00
CreateTracker
createTracker_description :: Lens' CreateTracker (Maybe Text) Source #
An optional description for the tracker resource.
createTracker_kmsKeyId :: Lens' CreateTracker (Maybe Text) Source #
A key identifier for an AWS KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.
createTracker_positionFiltering :: Lens' CreateTracker (Maybe PositionFiltering) Source #
Specifies the position filtering for the tracker resource.
Valid values:
TimeBased
- Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID.DistanceBased
- If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this area are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.AccuracyBased
- If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This can reduce the effects of GPS noise when displaying device trajectories on a map, and can help control your costs by reducing the number of geofence evaluations.
This field is optional. If not specified, the default value is
TimeBased
.
createTracker_pricingPlan :: Lens' CreateTracker (Maybe PricingPlan) Source #
No longer used. If included, the only allowed value is
RequestBasedUsage
.
createTracker_pricingPlanDataSource :: Lens' CreateTracker (Maybe Text) Source #
This parameter is no longer used.
createTracker_tags :: Lens' CreateTracker (Maybe (HashMap Text Text)) Source #
Applies one or more tags to the tracker resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.
Format: "key" : "value"
Restrictions:
- Maximum 50 tags per resource
- Each resource tag must be unique with a maximum of one value.
- Maximum key length: 128 Unicode characters in UTF-8
- Maximum value length: 256 Unicode characters in UTF-8
- Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
- Cannot use "aws:" as a prefix for a key.
createTracker_trackerName :: Lens' CreateTracker Text Source #
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
.
createTrackerResponse_httpStatus :: Lens' CreateTrackerResponse Int Source #
The response's http status code.
createTrackerResponse_createTime :: Lens' CreateTrackerResponse UTCTime Source #
The timestamp for when the tracker resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
createTrackerResponse_trackerArn :: Lens' CreateTrackerResponse Text Source #
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
createTrackerResponse_trackerName :: Lens' CreateTrackerResponse Text Source #
The name of the tracker resource.
DeleteGeofenceCollection
deleteGeofenceCollection_collectionName :: Lens' DeleteGeofenceCollection Text Source #
The name of the geofence collection to be deleted.
deleteGeofenceCollectionResponse_httpStatus :: Lens' DeleteGeofenceCollectionResponse Int Source #
The response's http status code.
DeleteMap
deleteMapResponse_httpStatus :: Lens' DeleteMapResponse Int Source #
The response's http status code.
DeletePlaceIndex
deletePlaceIndex_indexName :: Lens' DeletePlaceIndex Text Source #
The name of the place index resource to be deleted.
deletePlaceIndexResponse_httpStatus :: Lens' DeletePlaceIndexResponse Int Source #
The response's http status code.
DeleteRouteCalculator
deleteRouteCalculator_calculatorName :: Lens' DeleteRouteCalculator Text Source #
The name of the route calculator resource to be deleted.
deleteRouteCalculatorResponse_httpStatus :: Lens' DeleteRouteCalculatorResponse Int Source #
The response's http status code.
DeleteTracker
deleteTracker_trackerName :: Lens' DeleteTracker Text Source #
The name of the tracker resource to be deleted.
deleteTrackerResponse_httpStatus :: Lens' DeleteTrackerResponse Int Source #
The response's http status code.
DescribeGeofenceCollection
describeGeofenceCollection_collectionName :: Lens' DescribeGeofenceCollection Text Source #
The name of the geofence collection.
describeGeofenceCollectionResponse_kmsKeyId :: Lens' DescribeGeofenceCollectionResponse (Maybe Text) Source #
A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource
describeGeofenceCollectionResponse_pricingPlan :: Lens' DescribeGeofenceCollectionResponse (Maybe PricingPlan) Source #
No longer used. Always returns RequestBasedUsage
.
describeGeofenceCollectionResponse_pricingPlanDataSource :: Lens' DescribeGeofenceCollectionResponse (Maybe Text) Source #
No longer used. Always returns an empty string.
describeGeofenceCollectionResponse_tags :: Lens' DescribeGeofenceCollectionResponse (Maybe (HashMap Text Text)) Source #
Displays the key, value pairs of tags associated with this resource.
describeGeofenceCollectionResponse_httpStatus :: Lens' DescribeGeofenceCollectionResponse Int Source #
The response's http status code.
describeGeofenceCollectionResponse_collectionArn :: Lens' DescribeGeofenceCollectionResponse Text Source #
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
describeGeofenceCollectionResponse_collectionName :: Lens' DescribeGeofenceCollectionResponse Text Source #
The name of the geofence collection.
describeGeofenceCollectionResponse_createTime :: Lens' DescribeGeofenceCollectionResponse UTCTime Source #
The timestamp for when the geofence resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
describeGeofenceCollectionResponse_description :: Lens' DescribeGeofenceCollectionResponse Text Source #
The optional description for the geofence collection.
describeGeofenceCollectionResponse_updateTime :: Lens' DescribeGeofenceCollectionResponse UTCTime Source #
The timestamp for when the geofence collection was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
DescribeMap
describeMap_mapName :: Lens' DescribeMap Text Source #
The name of the map resource.
describeMapResponse_pricingPlan :: Lens' DescribeMapResponse (Maybe PricingPlan) Source #
No longer used. Always returns RequestBasedUsage
.
describeMapResponse_tags :: Lens' DescribeMapResponse (Maybe (HashMap Text Text)) Source #
Tags associated with the map resource.
describeMapResponse_httpStatus :: Lens' DescribeMapResponse Int Source #
The response's http status code.
describeMapResponse_configuration :: Lens' DescribeMapResponse MapConfiguration Source #
Specifies the map tile style selected from a partner data provider.
describeMapResponse_createTime :: Lens' DescribeMapResponse UTCTime Source #
The timestamp for when the map resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
describeMapResponse_dataSource :: Lens' DescribeMapResponse Text Source #
Specifies the data provider for the associated map tiles.
describeMapResponse_description :: Lens' DescribeMapResponse Text Source #
The optional description for the map resource.
describeMapResponse_mapArn :: Lens' DescribeMapResponse Text Source #
The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS.
- Format example:
arn:aws:geo:region:account-id:map/ExampleMap
describeMapResponse_mapName :: Lens' DescribeMapResponse Text Source #
The map style selected from an available provider.
describeMapResponse_updateTime :: Lens' DescribeMapResponse UTCTime Source #
The timestamp for when the map resource was last update in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
DescribePlaceIndex
describePlaceIndex_indexName :: Lens' DescribePlaceIndex Text Source #
The name of the place index resource.
describePlaceIndexResponse_pricingPlan :: Lens' DescribePlaceIndexResponse (Maybe PricingPlan) Source #
No longer used. Always returns RequestBasedUsage
.
describePlaceIndexResponse_tags :: Lens' DescribePlaceIndexResponse (Maybe (HashMap Text Text)) Source #
Tags associated with place index resource.
describePlaceIndexResponse_httpStatus :: Lens' DescribePlaceIndexResponse Int Source #
The response's http status code.
describePlaceIndexResponse_createTime :: Lens' DescribePlaceIndexResponse UTCTime Source #
The timestamp for when the place index resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
describePlaceIndexResponse_dataSource :: Lens' DescribePlaceIndexResponse Text Source #
The data provider of geospatial data. Values can be one of the following:
Esri
Here
For more information about data providers, see Amazon Location Service data providers.
describePlaceIndexResponse_dataSourceConfiguration :: Lens' DescribePlaceIndexResponse DataSourceConfiguration Source #
The specified data storage option for requesting Places.
describePlaceIndexResponse_description :: Lens' DescribePlaceIndexResponse Text Source #
The optional description for the place index resource.
describePlaceIndexResponse_indexArn :: Lens' DescribePlaceIndexResponse Text Source #
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
describePlaceIndexResponse_indexName :: Lens' DescribePlaceIndexResponse Text Source #
The name of the place index resource being described.
describePlaceIndexResponse_updateTime :: Lens' DescribePlaceIndexResponse UTCTime Source #
The timestamp for when the place index resource was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
DescribeRouteCalculator
describeRouteCalculator_calculatorName :: Lens' DescribeRouteCalculator Text Source #
The name of the route calculator resource.
describeRouteCalculatorResponse_pricingPlan :: Lens' DescribeRouteCalculatorResponse (Maybe PricingPlan) Source #
Always returns RequestBasedUsage
.
describeRouteCalculatorResponse_tags :: Lens' DescribeRouteCalculatorResponse (Maybe (HashMap Text Text)) Source #
Tags associated with route calculator resource.
describeRouteCalculatorResponse_httpStatus :: Lens' DescribeRouteCalculatorResponse Int Source #
The response's http status code.
describeRouteCalculatorResponse_calculatorArn :: Lens' DescribeRouteCalculatorResponse Text Source #
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
describeRouteCalculatorResponse_calculatorName :: Lens' DescribeRouteCalculatorResponse Text Source #
The name of the route calculator resource being described.
describeRouteCalculatorResponse_createTime :: Lens' DescribeRouteCalculatorResponse UTCTime Source #
The timestamp when the route calculator resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
- For example,
2020–07-2T12:15:20.000Z+01:00
describeRouteCalculatorResponse_dataSource :: Lens' DescribeRouteCalculatorResponse Text Source #
The data provider of traffic and road network data. Indicates one of the available providers:
Esri
Here
For more information about data providers, see Amazon Location Service data providers.
describeRouteCalculatorResponse_description :: Lens' DescribeRouteCalculatorResponse Text Source #
The optional description of the route calculator resource.
describeRouteCalculatorResponse_updateTime :: Lens' DescribeRouteCalculatorResponse UTCTime Source #
The timestamp when the route calculator resource was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
- For example,
2020–07-2T12:15:20.000Z+01:00
DescribeTracker
describeTracker_trackerName :: Lens' DescribeTracker Text Source #
The name of the tracker resource.
describeTrackerResponse_kmsKeyId :: Lens' DescribeTrackerResponse (Maybe Text) Source #
A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource.
describeTrackerResponse_positionFiltering :: Lens' DescribeTrackerResponse (Maybe PositionFiltering) Source #
The position filtering method of the tracker resource.
describeTrackerResponse_pricingPlan :: Lens' DescribeTrackerResponse (Maybe PricingPlan) Source #
Always returns RequestBasedUsage
.
describeTrackerResponse_pricingPlanDataSource :: Lens' DescribeTrackerResponse (Maybe Text) Source #
No longer used. Always returns an empty string.
describeTrackerResponse_tags :: Lens' DescribeTrackerResponse (Maybe (HashMap Text Text)) Source #
The tags associated with the tracker resource.
describeTrackerResponse_httpStatus :: Lens' DescribeTrackerResponse Int Source #
The response's http status code.
describeTrackerResponse_createTime :: Lens' DescribeTrackerResponse UTCTime Source #
The timestamp for when the tracker resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
describeTrackerResponse_description :: Lens' DescribeTrackerResponse Text Source #
The optional description for the tracker resource.
describeTrackerResponse_trackerArn :: Lens' DescribeTrackerResponse Text Source #
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
describeTrackerResponse_trackerName :: Lens' DescribeTrackerResponse Text Source #
The name of the tracker resource.
describeTrackerResponse_updateTime :: Lens' DescribeTrackerResponse UTCTime Source #
The timestamp for when the tracker resource was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
DisassociateTrackerConsumer
disassociateTrackerConsumer_consumerArn :: Lens' DisassociateTrackerConsumer Text Source #
The Amazon Resource Name (ARN) for the geofence collection to be disassociated from the tracker resource. Used when you need to specify a resource across all AWS.
- Format example:
arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer
disassociateTrackerConsumer_trackerName :: Lens' DisassociateTrackerConsumer Text Source #
The name of the tracker resource to be dissociated from the consumer.
disassociateTrackerConsumerResponse_httpStatus :: Lens' DisassociateTrackerConsumerResponse Int Source #
The response's http status code.
GetDevicePosition
getDevicePosition_deviceId :: Lens' GetDevicePosition Text Source #
The device whose position you want to retrieve.
getDevicePosition_trackerName :: Lens' GetDevicePosition Text Source #
The tracker resource receiving the position update.
getDevicePositionResponse_accuracy :: Lens' GetDevicePositionResponse (Maybe PositionalAccuracy) Source #
The accuracy of the device position.
getDevicePositionResponse_deviceId :: Lens' GetDevicePositionResponse (Maybe Text) Source #
The device whose position you retrieved.
getDevicePositionResponse_positionProperties :: Lens' GetDevicePositionResponse (Maybe (HashMap Text Text)) Source #
The properties associated with the position.
getDevicePositionResponse_httpStatus :: Lens' GetDevicePositionResponse Int Source #
The response's http status code.
getDevicePositionResponse_position :: Lens' GetDevicePositionResponse (NonEmpty Double) Source #
The last known device position.
getDevicePositionResponse_receivedTime :: Lens' GetDevicePositionResponse UTCTime Source #
The timestamp for when the tracker resource received the device position
in ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
getDevicePositionResponse_sampleTime :: Lens' GetDevicePositionResponse UTCTime Source #
The timestamp at which the device's position was determined. Uses
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
GetDevicePositionHistory
getDevicePositionHistory_endTimeExclusive :: Lens' GetDevicePositionHistory (Maybe UTCTime) Source #
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
.
getDevicePositionHistory_maxResults :: Lens' GetDevicePositionHistory (Maybe Natural) Source #
An optional limit for the number of device positions returned in a single call.
Default value: 100
getDevicePositionHistory_nextToken :: Lens' GetDevicePositionHistory (Maybe Text) Source #
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
getDevicePositionHistory_startTimeInclusive :: Lens' GetDevicePositionHistory (Maybe UTCTime) Source #
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
.
getDevicePositionHistory_deviceId :: Lens' GetDevicePositionHistory Text Source #
The device whose position history you want to retrieve.
getDevicePositionHistory_trackerName :: Lens' GetDevicePositionHistory Text Source #
The tracker resource receiving the request for the device position history.
getDevicePositionHistoryResponse_nextToken :: Lens' GetDevicePositionHistoryResponse (Maybe Text) Source #
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.
getDevicePositionHistoryResponse_httpStatus :: Lens' GetDevicePositionHistoryResponse Int Source #
The response's http status code.
getDevicePositionHistoryResponse_devicePositions :: Lens' GetDevicePositionHistoryResponse [DevicePosition] Source #
Contains the position history details for the requested device.
GetGeofence
getGeofence_collectionName :: Lens' GetGeofence Text Source #
The geofence collection storing the target geofence.
getGeofence_geofenceId :: Lens' GetGeofence Text Source #
The geofence you're retrieving details for.
getGeofenceResponse_httpStatus :: Lens' GetGeofenceResponse Int Source #
The response's http status code.
getGeofenceResponse_createTime :: Lens' GetGeofenceResponse UTCTime Source #
The timestamp for when the geofence collection was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
getGeofenceResponse_geofenceId :: Lens' GetGeofenceResponse Text Source #
The geofence identifier.
getGeofenceResponse_geometry :: Lens' GetGeofenceResponse GeofenceGeometry Source #
Contains the geofence geometry details describing a polygon or a circle.
getGeofenceResponse_status :: Lens' GetGeofenceResponse Text Source #
Identifies the state of the geofence. A geofence will hold one of the following states:
ACTIVE
— The geofence has been indexed by the system.PENDING
— The geofence is being processed by the system.FAILED
— The geofence failed to be indexed by the system.DELETED
— The geofence has been deleted from the system index.DELETING
— The geofence is being deleted from the system index.
getGeofenceResponse_updateTime :: Lens' GetGeofenceResponse UTCTime Source #
The timestamp for when the geofence collection was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
GetMapGlyphs
getMapGlyphs_fontStack :: Lens' GetMapGlyphs Text Source #
A comma-separated list of fonts to load glyphs from in order of
preference. For example, Noto Sans Regular, Arial Unicode
.
Valid fonts stacks for Esri styles:
- VectorEsriDarkGrayCanvas –
Ubuntu Medium Italic
|Ubuntu Medium
|Ubuntu Italic
|Ubuntu Regular
|Ubuntu Bold
- VectorEsriLightGrayCanvas –
Ubuntu Italic
|Ubuntu Regular
|Ubuntu Light
|Ubuntu Bold
- VectorEsriTopographic –
Noto Sans Italic
|Noto Sans Regular
|Noto Sans Bold
|Noto Serif Regular
|Roboto Condensed Light Italic
- VectorEsriStreets –
Arial Regular
|Arial Italic
|Arial Bold
- VectorEsriNavigation –
Arial Regular
|Arial Italic
|Arial Bold
Valid font stacks for HERE Technologies styles:
- VectorHereContrast –
Fira GO Regular
|Fira GO Bold
- VectorHereExplore, VectorHereExploreTruck,
HybridHereExploreSatellite –
Fira GO Italic
|Fira GO Map
|Fira GO Map Bold
|Noto Sans CJK JP Bold
|Noto Sans CJK JP Light
|Noto Sans CJK JP Regular
Valid font stacks for Open Data (Preview) styles:
- VectorOpenDataStandardLight –
Amazon Ember Regular,Noto Sans Regular
|Amazon Ember Bold,Noto Sans Bold
|Amazon Ember Medium,Noto Sans Medium
|Amazon Ember Regular Italic,Noto Sans Italic
|Amazon Ember Condensed RC Regular,Noto Sans Regular
|Amazon Ember Condensed RC Bold,Noto Sans Bold
The fonts used by VectorOpenDataStandardLight
are combined fonts that
use Amazon Ember
for most glyphs but Noto Sans
for glyphs
unsupported by Amazon Ember
.
getMapGlyphs_fontUnicodeRange :: Lens' GetMapGlyphs Text Source #
A Unicode range of characters to download glyphs for. Each response will
contain 256 characters. For example, 0–255 includes all characters from
range U+0000
to 00FF
. Must be aligned to multiples of 256.
getMapGlyphs_mapName :: Lens' GetMapGlyphs Text Source #
The map resource associated with the glyph file.
getMapGlyphsResponse_blob :: Lens' GetMapGlyphsResponse (Maybe ByteString) Source #
The blob's content type.
getMapGlyphsResponse_contentType :: Lens' GetMapGlyphsResponse (Maybe Text) Source #
The map glyph content type. For example, application/octet-stream
.
getMapGlyphsResponse_httpStatus :: Lens' GetMapGlyphsResponse Int Source #
The response's http status code.
GetMapSprites
getMapSprites_fileName :: Lens' GetMapSprites Text Source #
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 containing image offsets. Use the following file names:
sprites.json
sprites@2x.json
for high pixel density displays
getMapSprites_mapName :: Lens' GetMapSprites Text Source #
The map resource associated with the sprite file.
getMapSpritesResponse_blob :: Lens' GetMapSpritesResponse (Maybe ByteString) Source #
Contains the body of the sprite sheet or JSON offset file.
getMapSpritesResponse_contentType :: Lens' GetMapSpritesResponse (Maybe Text) Source #
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
.
getMapSpritesResponse_httpStatus :: Lens' GetMapSpritesResponse Int Source #
The response's http status code.
GetMapStyleDescriptor
getMapStyleDescriptor_mapName :: Lens' GetMapStyleDescriptor Text Source #
The map resource to retrieve the style descriptor from.
getMapStyleDescriptorResponse_blob :: Lens' GetMapStyleDescriptorResponse (Maybe ByteString) Source #
Contains the body of the style descriptor.
getMapStyleDescriptorResponse_contentType :: Lens' GetMapStyleDescriptorResponse (Maybe Text) Source #
The style descriptor's content type. For example, application/json
.
getMapStyleDescriptorResponse_httpStatus :: Lens' GetMapStyleDescriptorResponse Int Source #
The response's http status code.
GetMapTile
getMapTile_mapName :: Lens' GetMapTile Text Source #
The map resource to retrieve the map tiles from.
getMapTile_x :: Lens' GetMapTile Text Source #
The X axis value for the map tile.
getMapTile_y :: Lens' GetMapTile Text Source #
The Y axis value for the map tile.
getMapTile_z :: Lens' GetMapTile Text Source #
The zoom value for the map tile.
getMapTileResponse_blob :: Lens' GetMapTileResponse (Maybe ByteString) Source #
Contains Mapbox Vector Tile (MVT) data.
getMapTileResponse_contentType :: Lens' GetMapTileResponse (Maybe Text) Source #
The map tile's content type. For example,
application/vnd.mapbox-vector-tile
.
getMapTileResponse_httpStatus :: Lens' GetMapTileResponse Int Source #
The response's http status code.
GetPlace
getPlace_language :: Lens' GetPlace (Maybe Text) Source #
The preferred language used to return results. The value must be a valid
BCP 47 language tag, for example,
en
for English.
This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.
For an example, we'll use the Greek language. You search for a location
around Athens, Greece, with the language
parameter set to en
. The
city
in the results will most likely be returned as Athens
.
If you set the language
parameter to el
, for Greek, then the city
in the results will more likely be returned as Αθήνα
.
If the data provider does not have a value for Greek, the result will be in a language that the provider does support.
getPlace_indexName :: Lens' GetPlace Text Source #
The name of the place index resource that you want to use for the search.
getPlaceResponse_httpStatus :: Lens' GetPlaceResponse Int Source #
The response's http status code.
getPlaceResponse_place :: Lens' GetPlaceResponse Place Source #
Details about the result, such as its address and position.
ListDevicePositions
listDevicePositions_maxResults :: Lens' ListDevicePositions (Maybe Natural) Source #
An optional limit for the number of entries returned in a single call.
Default value: 100
listDevicePositions_nextToken :: Lens' ListDevicePositions (Maybe Text) Source #
The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.
Default value: null
listDevicePositions_trackerName :: Lens' ListDevicePositions Text Source #
The tracker resource containing the requested devices.
listDevicePositionsResponse_nextToken :: Lens' ListDevicePositionsResponse (Maybe Text) Source #
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.
listDevicePositionsResponse_httpStatus :: Lens' ListDevicePositionsResponse Int Source #
The response's http status code.
listDevicePositionsResponse_entries :: Lens' ListDevicePositionsResponse [ListDevicePositionsResponseEntry] Source #
Contains details about each device's last known position. These details includes the device ID, the time when the position was sampled on the device, the time that the service received the update, and the most recent coordinates.
ListGeofenceCollections
listGeofenceCollections_maxResults :: Lens' ListGeofenceCollections (Maybe Natural) Source #
An optional limit for the number of resources returned in a single call.
Default value: 100
listGeofenceCollections_nextToken :: Lens' ListGeofenceCollections (Maybe Text) Source #
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
listGeofenceCollectionsResponse_nextToken :: Lens' ListGeofenceCollectionsResponse (Maybe Text) Source #
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.
listGeofenceCollectionsResponse_httpStatus :: Lens' ListGeofenceCollectionsResponse Int Source #
The response's http status code.
listGeofenceCollectionsResponse_entries :: Lens' ListGeofenceCollectionsResponse [ListGeofenceCollectionsResponseEntry] Source #
Lists the geofence collections that exist in your AWS account.
ListGeofences
listGeofences_maxResults :: Lens' ListGeofences (Maybe Natural) Source #
An optional limit for the number of geofences returned in a single call.
Default value: 100
listGeofences_nextToken :: Lens' ListGeofences (Maybe Text) Source #
The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.
Default value: null
listGeofences_collectionName :: Lens' ListGeofences Text Source #
The name of the geofence collection storing the list of geofences.
listGeofencesResponse_nextToken :: Lens' ListGeofencesResponse (Maybe Text) Source #
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.
listGeofencesResponse_httpStatus :: Lens' ListGeofencesResponse Int Source #
The response's http status code.
listGeofencesResponse_entries :: Lens' ListGeofencesResponse [ListGeofenceResponseEntry] Source #
Contains a list of geofences stored in the geofence collection.
ListMaps
listMaps_maxResults :: Lens' ListMaps (Maybe Natural) Source #
An optional limit for the number of resources returned in a single call.
Default value: 100
listMaps_nextToken :: Lens' ListMaps (Maybe Text) Source #
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
listMapsResponse_nextToken :: Lens' ListMapsResponse (Maybe Text) Source #
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.
listMapsResponse_httpStatus :: Lens' ListMapsResponse Int Source #
The response's http status code.
listMapsResponse_entries :: Lens' ListMapsResponse [ListMapsResponseEntry] Source #
Contains a list of maps in your AWS account
ListPlaceIndexes
listPlaceIndexes_maxResults :: Lens' ListPlaceIndexes (Maybe Natural) Source #
An optional limit for the maximum number of results returned in a single call.
Default value: 100
listPlaceIndexes_nextToken :: Lens' ListPlaceIndexes (Maybe Text) Source #
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
listPlaceIndexesResponse_nextToken :: Lens' ListPlaceIndexesResponse (Maybe Text) Source #
A pagination token indicating that there are additional pages available. You can use the token in a new request to fetch the next page of results.
listPlaceIndexesResponse_httpStatus :: Lens' ListPlaceIndexesResponse Int Source #
The response's http status code.
listPlaceIndexesResponse_entries :: Lens' ListPlaceIndexesResponse [ListPlaceIndexesResponseEntry] Source #
Lists the place index resources that exist in your AWS account
ListRouteCalculators
listRouteCalculators_maxResults :: Lens' ListRouteCalculators (Maybe Natural) Source #
An optional maximum number of results returned in a single call.
Default Value: 100
listRouteCalculators_nextToken :: Lens' ListRouteCalculators (Maybe Text) Source #
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
listRouteCalculatorsResponse_nextToken :: Lens' ListRouteCalculatorsResponse (Maybe Text) Source #
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.
listRouteCalculatorsResponse_httpStatus :: Lens' ListRouteCalculatorsResponse Int Source #
The response's http status code.
listRouteCalculatorsResponse_entries :: Lens' ListRouteCalculatorsResponse [ListRouteCalculatorsResponseEntry] Source #
Lists the route calculator resources that exist in your AWS account
ListTagsForResource
listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #
The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.
- Format example:
arn:aws:geo:region:account-id:resourcetype/ExampleResource
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #
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"}
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.
ListTrackerConsumers
listTrackerConsumers_maxResults :: Lens' ListTrackerConsumers (Maybe Natural) Source #
An optional limit for the number of resources returned in a single call.
Default value: 100
listTrackerConsumers_nextToken :: Lens' ListTrackerConsumers (Maybe Text) Source #
The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.
Default value: null
listTrackerConsumers_trackerName :: Lens' ListTrackerConsumers Text Source #
The tracker resource whose associated geofence collections you want to list.
listTrackerConsumersResponse_nextToken :: Lens' ListTrackerConsumersResponse (Maybe Text) Source #
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.
listTrackerConsumersResponse_httpStatus :: Lens' ListTrackerConsumersResponse Int Source #
The response's http status code.
listTrackerConsumersResponse_consumerArns :: Lens' ListTrackerConsumersResponse [Text] Source #
Contains the list of geofence collection ARNs associated to the tracker resource.
ListTrackers
listTrackers_maxResults :: Lens' ListTrackers (Maybe Natural) Source #
An optional limit for the number of resources returned in a single call.
Default value: 100
listTrackers_nextToken :: Lens' ListTrackers (Maybe Text) Source #
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
listTrackersResponse_nextToken :: Lens' ListTrackersResponse (Maybe Text) Source #
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.
listTrackersResponse_httpStatus :: Lens' ListTrackersResponse Int Source #
The response's http status code.
listTrackersResponse_entries :: Lens' ListTrackersResponse [ListTrackersResponseEntry] Source #
Contains tracker resources in your AWS account. Details include tracker name, description and timestamps for when the tracker was created and last updated.
PutGeofence
putGeofence_collectionName :: Lens' PutGeofence Text Source #
The geofence collection to store the geofence in.
putGeofence_geofenceId :: Lens' PutGeofence Text Source #
An identifier for the geofence. For example, ExampleGeofence-1
.
putGeofence_geometry :: Lens' PutGeofence GeofenceGeometry Source #
Contains the details to specify the position of the geofence. Can be either a polygon or a circle. Including both will return a validation error.
Each geofence polygon can have a maximum of 1,000 vertices.
putGeofenceResponse_httpStatus :: Lens' PutGeofenceResponse Int Source #
The response's http status code.
putGeofenceResponse_createTime :: Lens' PutGeofenceResponse UTCTime Source #
The timestamp for when the geofence was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
putGeofenceResponse_geofenceId :: Lens' PutGeofenceResponse Text Source #
The geofence identifier entered in the request.
putGeofenceResponse_updateTime :: Lens' PutGeofenceResponse UTCTime Source #
The timestamp for when the geofence was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
SearchPlaceIndexForPosition
searchPlaceIndexForPosition_language :: Lens' SearchPlaceIndexForPosition (Maybe Text) Source #
The preferred language used to return results. The value must be a valid
BCP 47 language tag, for example,
en
for English.
This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.
For an example, we'll use the Greek language. You search for a location
around Athens, Greece, with the language
parameter set to en
. The
city
in the results will most likely be returned as Athens
.
If you set the language
parameter to el
, for Greek, then the city
in the results will more likely be returned as Αθήνα
.
If the data provider does not have a value for Greek, the result will be in a language that the provider does support.
searchPlaceIndexForPosition_maxResults :: Lens' SearchPlaceIndexForPosition (Maybe Natural) Source #
An optional parameter. The maximum number of results returned per request.
Default value: 50
searchPlaceIndexForPosition_indexName :: Lens' SearchPlaceIndexForPosition Text Source #
The name of the place index resource you want to use for the search.
searchPlaceIndexForPosition_position :: Lens' SearchPlaceIndexForPosition (NonEmpty Double) Source #
Specifies the longitude and latitude of the position to query.
This parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.
For example, [-123.1174, 49.2847]
represents a position with longitude
-123.1174
and latitude 49.2847
.
searchPlaceIndexForPositionResponse_httpStatus :: Lens' SearchPlaceIndexForPositionResponse Int Source #
The response's http status code.
searchPlaceIndexForPositionResponse_results :: Lens' SearchPlaceIndexForPositionResponse [SearchForPositionResult] Source #
Returns a list of Places closest to the specified position. Each result contains additional information about the Places returned.
searchPlaceIndexForPositionResponse_summary :: Lens' SearchPlaceIndexForPositionResponse SearchPlaceIndexForPositionSummary Source #
Contains a summary of the request. Echoes the input values for
Position
, Language
, MaxResults
, and the DataSource
of the place
index.
SearchPlaceIndexForSuggestions
searchPlaceIndexForSuggestions_biasPosition :: Lens' SearchPlaceIndexForSuggestions (Maybe (NonEmpty Double)) Source #
An optional parameter that indicates a preference for place suggestions that are closer to a specified position.
If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.
For example, [-123.1174, 49.2847]
represents the position with
longitude -123.1174
and latitude 49.2847
.
BiasPosition
and FilterBBox
are mutually exclusive. Specifying both
options results in an error.
searchPlaceIndexForSuggestions_filterBBox :: Lens' SearchPlaceIndexForSuggestions (Maybe (NonEmpty Double)) Source #
An optional parameter that limits the search results by returning only suggestions within a specified bounding box.
If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.
For example, [-12.7935, -37.4835, -12.0684, -36.9542]
represents a
bounding box where the southwest corner has longitude -12.7935
and
latitude -37.4835
, and the northeast corner has longitude -12.0684
and latitude -36.9542
.
FilterBBox
and BiasPosition
are mutually exclusive. Specifying both
options results in an error.
searchPlaceIndexForSuggestions_filterCountries :: Lens' SearchPlaceIndexForSuggestions (Maybe (NonEmpty Text)) Source #
An optional parameter that limits the search results by returning only suggestions within the provided list of countries.
- Use the ISO 3166
3-digit country code. For example, Australia uses three upper-case
characters:
AUS
.
searchPlaceIndexForSuggestions_language :: Lens' SearchPlaceIndexForSuggestions (Maybe Text) Source #
The preferred language used to return results. The value must be a valid
BCP 47 language tag, for example,
en
for English.
This setting affects the languages used in the results. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.
For an example, we'll use the Greek language. You search for
Athens, Gr
to get suggestions with the language
parameter set to
en
. The results found will most likely be returned as
Athens, Greece
.
If you set the language
parameter to el
, for Greek, then the result
found will more likely be returned as Αθήνα, Ελλάδα
.
If the data provider does not have a value for Greek, the result will be in a language that the provider does support.
searchPlaceIndexForSuggestions_maxResults :: Lens' SearchPlaceIndexForSuggestions (Maybe Natural) Source #
An optional parameter. The maximum number of results returned per request.
The default: 5
searchPlaceIndexForSuggestions_indexName :: Lens' SearchPlaceIndexForSuggestions Text Source #
The name of the place index resource you want to use for the search.
searchPlaceIndexForSuggestions_text :: Lens' SearchPlaceIndexForSuggestions Text Source #
The free-form partial text to use to generate place suggestions. For
example, eiffel tow
.
searchPlaceIndexForSuggestionsResponse_httpStatus :: Lens' SearchPlaceIndexForSuggestionsResponse Int Source #
The response's http status code.
searchPlaceIndexForSuggestionsResponse_results :: Lens' SearchPlaceIndexForSuggestionsResponse [SearchForSuggestionsResult] Source #
A list of place suggestions that best match the search text.
searchPlaceIndexForSuggestionsResponse_summary :: Lens' SearchPlaceIndexForSuggestionsResponse SearchPlaceIndexForSuggestionsSummary Source #
Contains a summary of the request. Echoes the input values for
BiasPosition
, FilterBBox
, FilterCountries
, Language
,
MaxResults
, and Text
. Also includes the DataSource
of the place
index.
SearchPlaceIndexForText
searchPlaceIndexForText_biasPosition :: Lens' SearchPlaceIndexForText (Maybe (NonEmpty Double)) Source #
An optional parameter that indicates a preference for places that are closer to a specified position.
If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.
For example, [-123.1174, 49.2847]
represents the position with
longitude -123.1174
and latitude 49.2847
.
BiasPosition
and FilterBBox
are mutually exclusive. Specifying both
options results in an error.
searchPlaceIndexForText_filterBBox :: Lens' SearchPlaceIndexForText (Maybe (NonEmpty Double)) Source #
An optional parameter that limits the search results by returning only places that are within the provided bounding box.
If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.
For example, [-12.7935, -37.4835, -12.0684, -36.9542]
represents a
bounding box where the southwest corner has longitude -12.7935
and
latitude -37.4835
, and the northeast corner has longitude -12.0684
and latitude -36.9542
.
FilterBBox
and BiasPosition
are mutually exclusive. Specifying both
options results in an error.
searchPlaceIndexForText_filterCountries :: Lens' SearchPlaceIndexForText (Maybe (NonEmpty Text)) Source #
An optional parameter that limits the search results by returning only places that are in a specified list of countries.
- Valid values include
ISO 3166 3-digit
country codes. For example, Australia uses three upper-case
characters:
AUS
.
searchPlaceIndexForText_language :: Lens' SearchPlaceIndexForText (Maybe Text) Source #
The preferred language used to return results. The value must be a valid
BCP 47 language tag, for example,
en
for English.
This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.
For an example, we'll use the Greek language. You search for
Athens, Greece
, with the language
parameter set to en
. The result
found will most likely be returned as Athens
.
If you set the language
parameter to el
, for Greek, then the result
found will more likely be returned as Αθήνα
.
If the data provider does not have a value for Greek, the result will be in a language that the provider does support.
searchPlaceIndexForText_maxResults :: Lens' SearchPlaceIndexForText (Maybe Natural) Source #
An optional parameter. The maximum number of results returned per request.
The default: 50
searchPlaceIndexForText_indexName :: Lens' SearchPlaceIndexForText Text Source #
The name of the place index resource you want to use for the search.
searchPlaceIndexForText_text :: Lens' SearchPlaceIndexForText Text Source #
The address, name, city, or region to be used in the search in free-form
text format. For example, 123 Any Street
.
searchPlaceIndexForTextResponse_httpStatus :: Lens' SearchPlaceIndexForTextResponse Int Source #
The response's http status code.
searchPlaceIndexForTextResponse_results :: Lens' SearchPlaceIndexForTextResponse [SearchForTextResult] Source #
A list of Places matching the input text. Each result contains additional information about the specific point of interest.
Not all response properties are included with all responses. Some properties may only be returned by specific data partners.
searchPlaceIndexForTextResponse_summary :: Lens' SearchPlaceIndexForTextResponse SearchPlaceIndexForTextSummary Source #
Contains a summary of the request. Echoes the input values for
BiasPosition
, FilterBBox
, FilterCountries
, Language
,
MaxResults
, and Text
. Also includes the DataSource
of the place
index and the bounding box, ResultBBox
, which surrounds the search
results.
TagResource
tagResource_resourceArn :: Lens' TagResource Text Source #
The Amazon Resource Name (ARN) of the resource whose tags you want to update.
- Format example:
arn:aws:geo:region:account-id:resourcetype/ExampleResource
tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #
Applies one or more tags to specific resource. A tag is a key-value pair that helps you manage, identify, search, and filter your resources.
Format: "key" : "value"
Restrictions:
- Maximum 50 tags per resource.
- Each tag key must be unique and must have exactly one associated value.
- Maximum key length: 128 Unicode characters in UTF-8.
- Maximum value length: 256 Unicode characters in UTF-8.
- Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @
- Cannot use "aws:" as a prefix for a key.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #
The response's http status code.
UntagResource
untagResource_resourceArn :: Lens' UntagResource Text Source #
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
untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #
The list of tag keys to remove from the specified resource.
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #
The response's http status code.
UpdateGeofenceCollection
updateGeofenceCollection_description :: Lens' UpdateGeofenceCollection (Maybe Text) Source #
Updates the description for the geofence collection.
updateGeofenceCollection_pricingPlan :: Lens' UpdateGeofenceCollection (Maybe PricingPlan) Source #
No longer used. If included, the only allowed value is
RequestBasedUsage
.
updateGeofenceCollection_pricingPlanDataSource :: Lens' UpdateGeofenceCollection (Maybe Text) Source #
This parameter is no longer used.
updateGeofenceCollection_collectionName :: Lens' UpdateGeofenceCollection Text Source #
The name of the geofence collection to update.
updateGeofenceCollectionResponse_httpStatus :: Lens' UpdateGeofenceCollectionResponse Int Source #
The response's http status code.
updateGeofenceCollectionResponse_collectionArn :: Lens' UpdateGeofenceCollectionResponse Text Source #
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
updateGeofenceCollectionResponse_collectionName :: Lens' UpdateGeofenceCollectionResponse Text Source #
The name of the updated geofence collection.
updateGeofenceCollectionResponse_updateTime :: Lens' UpdateGeofenceCollectionResponse UTCTime Source #
The time when the geofence collection was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
UpdateMap
updateMap_description :: Lens' UpdateMap (Maybe Text) Source #
Updates the description for the map resource.
updateMap_pricingPlan :: Lens' UpdateMap (Maybe PricingPlan) Source #
No longer used. If included, the only allowed value is
RequestBasedUsage
.
updateMapResponse_httpStatus :: Lens' UpdateMapResponse Int Source #
The response's http status code.
updateMapResponse_mapArn :: Lens' UpdateMapResponse Text Source #
The Amazon Resource Name (ARN) of the updated map resource. Used to specify a resource across AWS.
- Format example:
arn:aws:geo:region:account-id:map/ExampleMap
updateMapResponse_mapName :: Lens' UpdateMapResponse Text Source #
The name of the updated map resource.
updateMapResponse_updateTime :: Lens' UpdateMapResponse UTCTime Source #
The timestamp for when the map resource was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
UpdatePlaceIndex
updatePlaceIndex_dataSourceConfiguration :: Lens' UpdatePlaceIndex (Maybe DataSourceConfiguration) Source #
Updates the data storage option for the place index resource.
updatePlaceIndex_description :: Lens' UpdatePlaceIndex (Maybe Text) Source #
Updates the description for the place index resource.
updatePlaceIndex_pricingPlan :: Lens' UpdatePlaceIndex (Maybe PricingPlan) Source #
No longer used. If included, the only allowed value is
RequestBasedUsage
.
updatePlaceIndex_indexName :: Lens' UpdatePlaceIndex Text Source #
The name of the place index resource to update.
updatePlaceIndexResponse_httpStatus :: Lens' UpdatePlaceIndexResponse Int Source #
The response's http status code.
updatePlaceIndexResponse_indexArn :: Lens' UpdatePlaceIndexResponse Text Source #
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
updatePlaceIndexResponse_indexName :: Lens' UpdatePlaceIndexResponse Text Source #
The name of the updated place index resource.
updatePlaceIndexResponse_updateTime :: Lens' UpdatePlaceIndexResponse UTCTime Source #
The timestamp for when the place index resource was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
UpdateRouteCalculator
updateRouteCalculator_description :: Lens' UpdateRouteCalculator (Maybe Text) Source #
Updates the description for the route calculator resource.
updateRouteCalculator_pricingPlan :: Lens' UpdateRouteCalculator (Maybe PricingPlan) Source #
No longer used. If included, the only allowed value is
RequestBasedUsage
.
updateRouteCalculator_calculatorName :: Lens' UpdateRouteCalculator Text Source #
The name of the route calculator resource to update.
updateRouteCalculatorResponse_httpStatus :: Lens' UpdateRouteCalculatorResponse Int Source #
The response's http status code.
updateRouteCalculatorResponse_calculatorArn :: Lens' UpdateRouteCalculatorResponse Text Source #
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
updateRouteCalculatorResponse_calculatorName :: Lens' UpdateRouteCalculatorResponse Text Source #
The name of the updated route calculator resource.
updateRouteCalculatorResponse_updateTime :: Lens' UpdateRouteCalculatorResponse UTCTime Source #
The timestamp for when the route calculator was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
UpdateTracker
updateTracker_description :: Lens' UpdateTracker (Maybe Text) Source #
Updates the description for the tracker resource.
updateTracker_positionFiltering :: Lens' UpdateTracker (Maybe PositionFiltering) Source #
Updates the position filtering for the tracker resource.
Valid values:
TimeBased
- Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID.DistanceBased
- If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.AccuracyBased
- If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This helps educe the effects of GPS noise when displaying device trajectories on a map, and can help control costs by reducing the number of geofence evaluations.
updateTracker_pricingPlan :: Lens' UpdateTracker (Maybe PricingPlan) Source #
No longer used. If included, the only allowed value is
RequestBasedUsage
.
updateTracker_pricingPlanDataSource :: Lens' UpdateTracker (Maybe Text) Source #
This parameter is no longer used.
updateTracker_trackerName :: Lens' UpdateTracker Text Source #
The name of the tracker resource to update.
updateTrackerResponse_httpStatus :: Lens' UpdateTrackerResponse Int Source #
The response's http status code.
updateTrackerResponse_trackerArn :: Lens' UpdateTrackerResponse Text Source #
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
updateTrackerResponse_trackerName :: Lens' UpdateTrackerResponse Text Source #
The name of the updated tracker resource.
updateTrackerResponse_updateTime :: Lens' UpdateTrackerResponse UTCTime Source #
The timestamp for when the tracker resource was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
Types
BatchDeleteDevicePositionHistoryError
batchDeleteDevicePositionHistoryError_deviceId :: Lens' BatchDeleteDevicePositionHistoryError Text Source #
The ID of the device for this position.
batchDeleteDevicePositionHistoryError_error :: Lens' BatchDeleteDevicePositionHistoryError BatchItemError Source #
Undocumented member.
BatchDeleteGeofenceError
batchDeleteGeofenceError_error :: Lens' BatchDeleteGeofenceError BatchItemError Source #
Contains details associated to the batch error.
batchDeleteGeofenceError_geofenceId :: Lens' BatchDeleteGeofenceError Text Source #
The geofence associated with the error message.
BatchEvaluateGeofencesError
batchEvaluateGeofencesError_deviceId :: Lens' BatchEvaluateGeofencesError Text Source #
The device associated with the position evaluation error.
batchEvaluateGeofencesError_error :: Lens' BatchEvaluateGeofencesError BatchItemError Source #
Contains details associated to the batch error.
batchEvaluateGeofencesError_sampleTime :: Lens' BatchEvaluateGeofencesError UTCTime Source #
Specifies a timestamp for when the error occurred in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
BatchGetDevicePositionError
batchGetDevicePositionError_deviceId :: Lens' BatchGetDevicePositionError Text Source #
The ID of the device that didn't return a position.
batchGetDevicePositionError_error :: Lens' BatchGetDevicePositionError BatchItemError Source #
Contains details related to the error code.
BatchItemError
batchItemError_code :: Lens' BatchItemError (Maybe BatchItemErrorCode) Source #
The error code associated with the batch request error.
batchItemError_message :: Lens' BatchItemError (Maybe Text) Source #
A message with the reason for the batch request error.
BatchPutGeofenceError
batchPutGeofenceError_error :: Lens' BatchPutGeofenceError BatchItemError Source #
Contains details associated to the batch error.
batchPutGeofenceError_geofenceId :: Lens' BatchPutGeofenceError Text Source #
The geofence associated with the error message.
BatchPutGeofenceRequestEntry
batchPutGeofenceRequestEntry_geofenceId :: Lens' BatchPutGeofenceRequestEntry Text Source #
The identifier for the geofence to be stored in a given geofence collection.
batchPutGeofenceRequestEntry_geometry :: Lens' BatchPutGeofenceRequestEntry GeofenceGeometry Source #
Contains the details of the position of the geofence. Can be either a polygon or a circle. Including both will return a validation error.
Each geofence polygon can have a maximum of 1,000 vertices.
BatchPutGeofenceSuccess
batchPutGeofenceSuccess_createTime :: Lens' BatchPutGeofenceSuccess UTCTime Source #
The timestamp for when the geofence was stored in a geofence collection
in ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
batchPutGeofenceSuccess_geofenceId :: Lens' BatchPutGeofenceSuccess Text Source #
The geofence successfully stored in a geofence collection.
batchPutGeofenceSuccess_updateTime :: Lens' BatchPutGeofenceSuccess UTCTime Source #
The timestamp for when the geofence was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
BatchUpdateDevicePositionError
batchUpdateDevicePositionError_deviceId :: Lens' BatchUpdateDevicePositionError Text Source #
The device associated with the failed location update.
batchUpdateDevicePositionError_error :: Lens' BatchUpdateDevicePositionError BatchItemError Source #
Contains details related to the error code such as the error code and error message.
batchUpdateDevicePositionError_sampleTime :: Lens' BatchUpdateDevicePositionError UTCTime Source #
The timestamp at which the device position was determined. Uses
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
CalculateRouteCarModeOptions
calculateRouteCarModeOptions_avoidFerries :: Lens' CalculateRouteCarModeOptions (Maybe Bool) Source #
Avoids ferries when calculating routes.
Default Value: false
Valid Values: false
| true
calculateRouteCarModeOptions_avoidTolls :: Lens' CalculateRouteCarModeOptions (Maybe Bool) Source #
Avoids tolls when calculating routes.
Default Value: false
Valid Values: false
| true
CalculateRouteMatrixSummary
calculateRouteMatrixSummary_dataSource :: Lens' CalculateRouteMatrixSummary Text Source #
The data provider of traffic and road network data used to calculate the routes. Indicates one of the available providers:
Esri
Here
For more information about data providers, see Amazon Location Service data providers.
calculateRouteMatrixSummary_distanceUnit :: Lens' CalculateRouteMatrixSummary DistanceUnit Source #
The unit of measurement for route distances.
calculateRouteMatrixSummary_errorCount :: Lens' CalculateRouteMatrixSummary Natural Source #
The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.
calculateRouteMatrixSummary_routeCount :: Lens' CalculateRouteMatrixSummary Natural Source #
The count of cells in the route matrix. Equal to the number of
DeparturePositions
multiplied by the number of DestinationPositions
.
CalculateRouteSummary
calculateRouteSummary_dataSource :: Lens' CalculateRouteSummary Text Source #
The data provider of traffic and road network data used to calculate the route. Indicates one of the available providers:
Esri
Here
For more information about data providers, see Amazon Location Service data providers.
calculateRouteSummary_distance :: Lens' CalculateRouteSummary Double Source #
The total distance covered by the route. The sum of the distance travelled between every stop on the route.
If Esri is the data source for the route calculator, the route distance
can’t be greater than 400 km. If the route exceeds 400 km, the response
is a 400 RoutesValidationException
error.
calculateRouteSummary_distanceUnit :: Lens' CalculateRouteSummary DistanceUnit Source #
The unit of measurement for route distances.
calculateRouteSummary_durationSeconds :: Lens' CalculateRouteSummary Double Source #
The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.
calculateRouteSummary_routeBBox :: Lens' CalculateRouteSummary (NonEmpty Double) Source #
Specifies a geographical box surrounding a route. Used to zoom into a
route when displaying it in a map. For example,
[min x, min y, max x, max y]
.
The first 2 bbox
parameters describe the lower southwest corner:
- The first
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
calculateRouteTruckModeOptions_avoidFerries :: Lens' CalculateRouteTruckModeOptions (Maybe Bool) Source #
Avoids ferries when calculating routes.
Default Value: false
Valid Values: false
| true
calculateRouteTruckModeOptions_avoidTolls :: Lens' CalculateRouteTruckModeOptions (Maybe Bool) Source #
Avoids tolls when calculating routes.
Default Value: false
Valid Values: false
| true
calculateRouteTruckModeOptions_dimensions :: Lens' CalculateRouteTruckModeOptions (Maybe TruckDimensions) Source #
Specifies the truck's dimension specifications including length, height, width, and unit of measurement. Used to avoid roads that can't support the truck's dimensions.
calculateRouteTruckModeOptions_weight :: Lens' CalculateRouteTruckModeOptions (Maybe TruckWeight) Source #
Specifies the truck's weight specifications including total weight and unit of measurement. Used to avoid roads that can't support the truck's weight.
Circle
circle_center :: Lens' Circle (NonEmpty Double) Source #
A single point geometry, specifying the center of the circle, using
WGS 84
coordinates, in the form [longitude, latitude]
.
circle_radius :: Lens' Circle Double Source #
The radius of the circle in meters. Must be greater than zero and no larger than 100,000 (100 kilometers).
DataSourceConfiguration
dataSourceConfiguration_intendedUse :: Lens' DataSourceConfiguration (Maybe IntendedUse) Source #
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
devicePosition_accuracy :: Lens' DevicePosition (Maybe PositionalAccuracy) Source #
The accuracy of the device position.
devicePosition_deviceId :: Lens' DevicePosition (Maybe Text) Source #
The device whose position you retrieved.
devicePosition_positionProperties :: Lens' DevicePosition (Maybe (HashMap Text Text)) Source #
The properties associated with the position.
devicePosition_position :: Lens' DevicePosition (NonEmpty Double) Source #
The last known device position.
devicePosition_receivedTime :: Lens' DevicePosition UTCTime Source #
The timestamp for when the tracker resource received the device position
in ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
devicePosition_sampleTime :: Lens' DevicePosition UTCTime Source #
The timestamp at which the device's position was determined. Uses
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
DevicePositionUpdate
devicePositionUpdate_accuracy :: Lens' DevicePositionUpdate (Maybe PositionalAccuracy) Source #
The accuracy of the device position.
devicePositionUpdate_positionProperties :: Lens' DevicePositionUpdate (Maybe (HashMap Text Text)) Source #
Associates one of more properties with the position update. A property is a key-value pair stored with the position update and added to any geofence event the update may trigger.
Format: "key" : "value"
devicePositionUpdate_deviceId :: Lens' DevicePositionUpdate Text Source #
The device associated to the position update.
devicePositionUpdate_position :: Lens' DevicePositionUpdate (NonEmpty Double) Source #
The latest device position defined in
WGS 84
format: [X or longitude, Y or latitude]
.
devicePositionUpdate_sampleTime :: Lens' DevicePositionUpdate UTCTime Source #
The timestamp at which the device's position was determined. Uses
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
GeofenceGeometry
geofenceGeometry_circle :: Lens' GeofenceGeometry (Maybe Circle) Source #
A circle on the earth, as defined by a center point and a radius.
geofenceGeometry_polygon :: Lens' GeofenceGeometry (Maybe (NonEmpty (NonEmpty (NonEmpty Double)))) Source #
A polygon is a list of linear rings which are each made up of a list of vertices.
Each vertex is a 2-dimensional point of the form:
[longitude, latitude]
. This is represented as an array of doubles of
length 2 (so [double, double]
).
An array of 4 or more vertices, where the first and last vertex are the
same (to form a closed boundary), is called a linear ring. The linear
ring vertices must be listed in counter-clockwise order around the
ring’s interior. The linear ring is represented as an array of vertices,
or an array of arrays of doubles ([[double, double], ...]
).
A geofence consists of a single linear ring. To allow for future
expansion, the Polygon parameter takes an array of linear rings, which
is represented as an array of arrays of arrays of doubles
([[[double, double], ...], ...]
).
A linear ring for use in geofences can consist of between 4 and 1,000 vertices.
Leg
leg_geometry :: Lens' Leg (Maybe LegGeometry) Source #
Contains the calculated route's path as a linestring geometry.
leg_distance :: Lens' Leg Double Source #
The distance between the leg's StartPosition
and EndPosition
along
a calculated route.
- The default measurement is
Kilometers
unless the request specifies aDistanceUnit
ofMiles
.
leg_durationSeconds :: Lens' Leg Double Source #
The estimated travel time between the leg's StartPosition
and
EndPosition
. The travel mode and departure time that you specify in
the request determines the calculated time.
leg_endPosition :: Lens' Leg (NonEmpty Double) Source #
The terminating position of the leg. Follows the format
[longitude,latitude]
.
If the EndPosition
isn't located on a road, it's
snapped to a nearby road.
leg_startPosition :: Lens' Leg (NonEmpty Double) Source #
The starting position of the leg. Follows the format
[longitude,latitude]
.
If the StartPosition
isn't located on a road, it's
snapped to a nearby road.
leg_steps :: Lens' Leg [Step] Source #
Contains a list of steps, which represent subsections of a leg. Each step provides instructions for how to move to the next step in the leg such as the step's start position, end position, travel distance, travel duration, and geometry offset.
LegGeometry
legGeometry_lineString :: Lens' LegGeometry (Maybe (NonEmpty (NonEmpty Double))) Source #
An ordered list of positions used to plot a route on a map.
The first position is closest to the start position for the leg, and the last position is the closest to the end position for the leg.
- For example,
[[-123.117, 49.284],[-123.115, 49.285],[-123.115, 49.285]]
ListDevicePositionsResponseEntry
listDevicePositionsResponseEntry_accuracy :: Lens' ListDevicePositionsResponseEntry (Maybe PositionalAccuracy) Source #
The accuracy of the device position.
listDevicePositionsResponseEntry_positionProperties :: Lens' ListDevicePositionsResponseEntry (Maybe (HashMap Text Text)) Source #
The properties associated with the position.
listDevicePositionsResponseEntry_deviceId :: Lens' ListDevicePositionsResponseEntry Text Source #
The ID of the device for this position.
listDevicePositionsResponseEntry_position :: Lens' ListDevicePositionsResponseEntry (NonEmpty Double) Source #
The last known device position. Empty if no positions currently stored.
listDevicePositionsResponseEntry_sampleTime :: Lens' ListDevicePositionsResponseEntry UTCTime Source #
The timestamp at which the device position was determined. Uses
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
ListGeofenceCollectionsResponseEntry
listGeofenceCollectionsResponseEntry_pricingPlan :: Lens' ListGeofenceCollectionsResponseEntry (Maybe PricingPlan) Source #
No longer used. Always returns RequestBasedUsage
.
listGeofenceCollectionsResponseEntry_pricingPlanDataSource :: Lens' ListGeofenceCollectionsResponseEntry (Maybe Text) Source #
No longer used. Always returns an empty string.
listGeofenceCollectionsResponseEntry_collectionName :: Lens' ListGeofenceCollectionsResponseEntry Text Source #
The name of the geofence collection.
listGeofenceCollectionsResponseEntry_createTime :: Lens' ListGeofenceCollectionsResponseEntry UTCTime Source #
The timestamp for when the geofence collection was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
listGeofenceCollectionsResponseEntry_description :: Lens' ListGeofenceCollectionsResponseEntry Text Source #
The description for the geofence collection
listGeofenceCollectionsResponseEntry_updateTime :: Lens' ListGeofenceCollectionsResponseEntry UTCTime Source #
Specifies a timestamp for when the resource was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
ListGeofenceResponseEntry
listGeofenceResponseEntry_createTime :: Lens' ListGeofenceResponseEntry UTCTime Source #
The timestamp for when the geofence was stored in a geofence collection
in ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
listGeofenceResponseEntry_geofenceId :: Lens' ListGeofenceResponseEntry Text Source #
The geofence identifier.
listGeofenceResponseEntry_geometry :: Lens' ListGeofenceResponseEntry GeofenceGeometry Source #
Contains the geofence geometry details describing a polygon or a circle.
listGeofenceResponseEntry_status :: Lens' ListGeofenceResponseEntry Text Source #
Identifies the state of the geofence. A geofence will hold one of the following states:
ACTIVE
— The geofence has been indexed by the system.PENDING
— The geofence is being processed by the system.FAILED
— The geofence failed to be indexed by the system.DELETED
— The geofence has been deleted from the system index.DELETING
— The geofence is being deleted from the system index.
listGeofenceResponseEntry_updateTime :: Lens' ListGeofenceResponseEntry UTCTime Source #
The timestamp for when the geofence was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
ListMapsResponseEntry
listMapsResponseEntry_pricingPlan :: Lens' ListMapsResponseEntry (Maybe PricingPlan) Source #
No longer used. Always returns RequestBasedUsage
.
listMapsResponseEntry_createTime :: Lens' ListMapsResponseEntry UTCTime Source #
The timestamp for when the map resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
listMapsResponseEntry_dataSource :: Lens' ListMapsResponseEntry Text Source #
Specifies the data provider for the associated map tiles.
listMapsResponseEntry_description :: Lens' ListMapsResponseEntry Text Source #
The description for the map resource.
listMapsResponseEntry_mapName :: Lens' ListMapsResponseEntry Text Source #
The name of the associated map resource.
listMapsResponseEntry_updateTime :: Lens' ListMapsResponseEntry UTCTime Source #
The timestamp for when the map resource was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
ListPlaceIndexesResponseEntry
listPlaceIndexesResponseEntry_pricingPlan :: Lens' ListPlaceIndexesResponseEntry (Maybe PricingPlan) Source #
No longer used. Always returns RequestBasedUsage
.
listPlaceIndexesResponseEntry_createTime :: Lens' ListPlaceIndexesResponseEntry UTCTime Source #
The timestamp for when the place index resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
listPlaceIndexesResponseEntry_dataSource :: Lens' ListPlaceIndexesResponseEntry Text Source #
The data provider of geospatial data. Values can be one of the following:
Esri
Here
For more information about data providers, see Amazon Location Service data providers.
listPlaceIndexesResponseEntry_description :: Lens' ListPlaceIndexesResponseEntry Text Source #
The optional description for the place index resource.
listPlaceIndexesResponseEntry_indexName :: Lens' ListPlaceIndexesResponseEntry Text Source #
The name of the place index resource.
listPlaceIndexesResponseEntry_updateTime :: Lens' ListPlaceIndexesResponseEntry UTCTime Source #
The timestamp for when the place index resource was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
ListRouteCalculatorsResponseEntry
listRouteCalculatorsResponseEntry_pricingPlan :: Lens' ListRouteCalculatorsResponseEntry (Maybe PricingPlan) Source #
Always returns RequestBasedUsage
.
listRouteCalculatorsResponseEntry_calculatorName :: Lens' ListRouteCalculatorsResponseEntry Text Source #
The name of the route calculator resource.
listRouteCalculatorsResponseEntry_createTime :: Lens' ListRouteCalculatorsResponseEntry UTCTime Source #
The timestamp when the route calculator resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
- For example,
2020–07-2T12:15:20.000Z+01:00
listRouteCalculatorsResponseEntry_dataSource :: Lens' ListRouteCalculatorsResponseEntry Text Source #
The data provider of traffic and road network data. Indicates one of the available providers:
Esri
Here
For more information about data providers, see Amazon Location Service data providers.
listRouteCalculatorsResponseEntry_description :: Lens' ListRouteCalculatorsResponseEntry Text Source #
The optional description of the route calculator resource.
listRouteCalculatorsResponseEntry_updateTime :: Lens' ListRouteCalculatorsResponseEntry UTCTime Source #
The timestamp when the route calculator resource was last updated in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
- For example,
2020–07-2T12:15:20.000Z+01:00
ListTrackersResponseEntry
listTrackersResponseEntry_pricingPlan :: Lens' ListTrackersResponseEntry (Maybe PricingPlan) Source #
Always returns RequestBasedUsage
.
listTrackersResponseEntry_pricingPlanDataSource :: Lens' ListTrackersResponseEntry (Maybe Text) Source #
No longer used. Always returns an empty string.
listTrackersResponseEntry_createTime :: Lens' ListTrackersResponseEntry UTCTime Source #
The timestamp for when the tracker resource was created in
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
listTrackersResponseEntry_description :: Lens' ListTrackersResponseEntry Text Source #
The description for the tracker resource.
listTrackersResponseEntry_trackerName :: Lens' ListTrackersResponseEntry Text Source #
The name of the tracker resource.
listTrackersResponseEntry_updateTime :: Lens' ListTrackersResponseEntry UTCTime Source #
The timestamp at which the device's position was determined. Uses
ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssZ
.
MapConfiguration
mapConfiguration_style :: Lens' MapConfiguration Text Source #
Specifies the map style selected from an available data provider.
Valid Esri map styles:
VectorEsriDarkGrayCanvas
– The Esri Dark Gray Canvas map style. A vector basemap with a dark gray, neutral background with minimal colors, labels, and features that's designed to draw attention to your thematic content.RasterEsriImagery
– The Esri Imagery map style. A raster basemap that provides one meter or better satellite and aerial imagery in many parts of the world and lower resolution satellite imagery worldwide.VectorEsriLightGrayCanvas
– The Esri Light Gray Canvas map style, which provides a detailed vector basemap with a light gray, neutral background style with minimal colors, labels, and features that's designed to draw attention to your thematic content.VectorEsriTopographic
– The Esri Light map style, which provides a detailed vector basemap with a classic Esri map style.VectorEsriStreets
– The Esri World Streets map style, which provides a detailed vector basemap for the world symbolized with a classic Esri street map style. The vector tile layer is similar in content and style to the World Street Map raster map.VectorEsriNavigation
– The Esri World Navigation map style, which provides a detailed basemap for the world symbolized with a custom navigation map style that's designed for use during the day in mobile devices.
Valid HERE Technologies map styles:
VectorHereContrast
– The HERE Contrast (Berlin) map style is a high contrast detailed base map of the world that blends 3D and 2D rendering.The
VectorHereContrast
style has been renamed fromVectorHereBerlin
.VectorHereBerlin
has been deprecated, but will continue to work in applications that use it.VectorHereExplore
– A default HERE map style containing a neutral, global map and its features including roads, buildings, landmarks, and water features. It also now includes a fully designed map of Japan.VectorHereExploreTruck
– A global map containing truck restrictions and attributes (e.g. width / height / HAZMAT) symbolized with highlighted segments and icons on top of HERE Explore to support use cases within transport and logistics.RasterHereExploreSatellite
– A global map containing high resolution satellite imagery.HybridHereExploreSatellite
– A global map displaying the road network, street names, and city labels over satellite imagery. This style will automatically retrieve both raster and vector tiles, and your charges will be based on total tiles retrieved.Hybrid styles use both vector and raster tiles when rendering the map that you see. This means that more tiles are retrieved than when using either vector or raster tiles alone. Your charges will include all tiles retrieved.
Valid Open Data (Preview) map styles:
VectorOpenDataStandardLight
– The Open Data Standard Light (preview) map style provides a detailed basemap for the world suitable for website and mobile application use. The map includes highways major roads, minor roads, railways, water features, cities, parks, landmarks, building footprints, and administrative boundaries.Open Data maps is in preview. We may add, change, or remove features before announcing general availability. For more information, see Open Data is in preview release.
Place
place_addressNumber :: Lens' Place (Maybe Text) Source #
The numerical portion of an address, such as a building number.
place_country :: Lens' Place (Maybe Text) Source #
A country/region specified using
ISO 3166 3-digit
country/region code. For example, CAN
.
place_interpolated :: Lens' Place (Maybe Bool) Source #
True
if the result is interpolated from other known places.
False
if the Place is a known place.
Not returned when the partner does not provide the information.
For example, returns False
for an address location that is found in
the partner data, but returns True
if an address does not exist in the
partner data and its location is calculated by interpolating between
other known addresses.
place_label :: Lens' Place (Maybe Text) Source #
The full name and address of the point of interest such as a city,
region, or country. For example, 123 Any Street, Any Town, USA
.
place_municipality :: Lens' Place (Maybe Text) Source #
A name for a local area, such as a city or town name. For example,
Toronto
.
place_neighborhood :: Lens' Place (Maybe Text) Source #
The name of a community district. For example, Downtown
.
place_postalCode :: Lens' Place (Maybe Text) Source #
A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.
place_region :: Lens' Place (Maybe Text) Source #
A name for an area or geographical division, such as a province or state
name. For example, British Columbia
.
place_street :: Lens' Place (Maybe Text) Source #
The name for a street or a road to identify a location. For example,
Main Street
.
place_subRegion :: Lens' Place (Maybe Text) Source #
A country, or an area that's part of a larger region. For example,
Metro Vancouver
.
place_timeZone :: Lens' Place (Maybe TimeZone) Source #
The time zone in which the Place
is located. Returned only when using
HERE as the selected partner.
place_unitNumber :: Lens' Place (Maybe Text) Source #
For addresses with multiple units, the unit identifier. Can include
numbers and letters, for example 3B
or Unit 123
.
Returned only for a place index that uses Esri as a data provider. Is
not returned for SearchPlaceIndexForPosition
.
place_unitType :: Lens' Place (Maybe Text) Source #
For addresses with a UnitNumber
, the type of unit. For example,
Apartment
.
place_geometry :: Lens' Place PlaceGeometry Source #
Undocumented member.
PlaceGeometry
placeGeometry_point :: Lens' PlaceGeometry (Maybe (NonEmpty Double)) Source #
A single point geometry specifies a location for a Place using WGS 84 coordinates:
- x — Specifies the x coordinate or longitude.
- y — Specifies the y coordinate or latitude.
PositionalAccuracy
positionalAccuracy_horizontal :: Lens' PositionalAccuracy Double Source #
Estimated maximum distance, in meters, between the measured position and the true position of a device, along the Earth's surface.
RouteMatrixEntry
routeMatrixEntry_distance :: Lens' RouteMatrixEntry (Maybe Double) Source #
The total distance of travel for the route.
routeMatrixEntry_durationSeconds :: Lens' RouteMatrixEntry (Maybe Double) Source #
The expected duration of travel for the route.
routeMatrixEntry_error :: Lens' RouteMatrixEntry (Maybe RouteMatrixEntryError) Source #
An error corresponding to the calculation of a route between the
DeparturePosition
and DestinationPosition
.
RouteMatrixEntryError
routeMatrixEntryError_message :: Lens' RouteMatrixEntryError (Maybe Text) Source #
A message about the error that occurred for the route calculation.
routeMatrixEntryError_code :: Lens' RouteMatrixEntryError RouteMatrixErrorCode Source #
The type of error which occurred for the route calculation.
SearchForPositionResult
searchForPositionResult_placeId :: Lens' SearchForPositionResult (Maybe Text) Source #
The unique identifier of the place. You can use this with the GetPlace
operation to find the place again later.
For SearchPlaceIndexForPosition
operations, the PlaceId
is returned
only by place indexes that use HERE as a data provider.
searchForPositionResult_distance :: Lens' SearchForPositionResult Double Source #
The distance in meters of a great-circle arc between the query position and the result.
A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance between two locations.
searchForPositionResult_place :: Lens' SearchForPositionResult Place Source #
Details about the search result, such as its address and position.
SearchForSuggestionsResult
searchForSuggestionsResult_placeId :: Lens' SearchForSuggestionsResult (Maybe Text) Source #
The unique identifier of the place. You can use this with the GetPlace
operation to find the place again later.
For SearchPlaceIndexForSuggestions
operations, the PlaceId
is
returned by place indexes that use HERE or Esri as data providers.
searchForSuggestionsResult_text :: Lens' SearchForSuggestionsResult Text Source #
The text of the place suggestion, typically formatted as an address string.
SearchForTextResult
searchForTextResult_distance :: Lens' SearchForTextResult (Maybe Double) Source #
The distance in meters of a great-circle arc between the bias position
specified and the result. Distance
will be returned only if a bias
position was specified in the query.
A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance between two locations.
searchForTextResult_placeId :: Lens' SearchForTextResult (Maybe Text) Source #
The unique identifier of the place. You can use this with the GetPlace
operation to find the place again later.
For SearchPlaceIndexForText
operations, the PlaceId
is returned only
by place indexes that use HERE as a data provider.
searchForTextResult_relevance :: Lens' SearchForTextResult (Maybe Double) Source #
The relative confidence in the match for a result among the results returned. For example, if more fields for an address match (including house number, street, city, country/region, and postal code), the relevance score is closer to 1.
Returned only when the partner selected is Esri.
searchForTextResult_place :: Lens' SearchForTextResult Place Source #
Details about the search result, such as its address and position.
SearchPlaceIndexForPositionSummary
searchPlaceIndexForPositionSummary_language :: Lens' SearchPlaceIndexForPositionSummary (Maybe Text) Source #
The preferred language used to return results. Matches the language in
the request. The value is a valid
BCP 47 language tag, for example,
en
for English.
searchPlaceIndexForPositionSummary_maxResults :: Lens' SearchPlaceIndexForPositionSummary (Maybe Natural) Source #
Contains the optional result count limit that is specified in the request.
Default value: 50
searchPlaceIndexForPositionSummary_dataSource :: Lens' SearchPlaceIndexForPositionSummary Text Source #
The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:
- Esri
- Here
For more information about data providers, see Amazon Location Service data providers.
searchPlaceIndexForPositionSummary_position :: Lens' SearchPlaceIndexForPositionSummary (NonEmpty Double) Source #
The position specified in the request.
SearchPlaceIndexForSuggestionsSummary
searchPlaceIndexForSuggestionsSummary_biasPosition :: Lens' SearchPlaceIndexForSuggestionsSummary (Maybe (NonEmpty Double)) Source #
Contains the coordinates for the optional bias position specified in the request.
This parameter contains a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.
For example, [-123.1174, 49.2847]
represents the position with
longitude -123.1174
and latitude 49.2847
.
searchPlaceIndexForSuggestionsSummary_filterBBox :: Lens' SearchPlaceIndexForSuggestionsSummary (Maybe (NonEmpty Double)) Source #
Contains the coordinates for the optional bounding box specified in the request.
searchPlaceIndexForSuggestionsSummary_filterCountries :: Lens' SearchPlaceIndexForSuggestionsSummary (Maybe (NonEmpty Text)) Source #
Contains the optional country filter specified in the request.
searchPlaceIndexForSuggestionsSummary_language :: Lens' SearchPlaceIndexForSuggestionsSummary (Maybe Text) Source #
The preferred language used to return results. Matches the language in
the request. The value is a valid
BCP 47 language tag, for example,
en
for English.
searchPlaceIndexForSuggestionsSummary_maxResults :: Lens' SearchPlaceIndexForSuggestionsSummary (Maybe Int) Source #
Contains the optional result count limit specified in the request.
searchPlaceIndexForSuggestionsSummary_dataSource :: Lens' SearchPlaceIndexForSuggestionsSummary Text Source #
The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:
- Esri
- Here
For more information about data providers, see Amazon Location Service data providers.
searchPlaceIndexForSuggestionsSummary_text :: Lens' SearchPlaceIndexForSuggestionsSummary Text Source #
The free-form partial text input specified in the request.
SearchPlaceIndexForTextSummary
searchPlaceIndexForTextSummary_biasPosition :: Lens' SearchPlaceIndexForTextSummary (Maybe (NonEmpty Double)) Source #
Contains the coordinates for the optional bias position specified in the request.
This parameter contains a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.
For example, [-123.1174, 49.2847]
represents the position with
longitude -123.1174
and latitude 49.2847
.
searchPlaceIndexForTextSummary_filterBBox :: Lens' SearchPlaceIndexForTextSummary (Maybe (NonEmpty Double)) Source #
Contains the coordinates for the optional bounding box specified in the request.
searchPlaceIndexForTextSummary_filterCountries :: Lens' SearchPlaceIndexForTextSummary (Maybe (NonEmpty Text)) Source #
Contains the optional country filter specified in the request.
searchPlaceIndexForTextSummary_language :: Lens' SearchPlaceIndexForTextSummary (Maybe Text) Source #
The preferred language used to return results. Matches the language in
the request. The value is a valid
BCP 47 language tag, for example,
en
for English.
searchPlaceIndexForTextSummary_maxResults :: Lens' SearchPlaceIndexForTextSummary (Maybe Natural) Source #
Contains the optional result count limit specified in the request.
searchPlaceIndexForTextSummary_resultBBox :: Lens' SearchPlaceIndexForTextSummary (Maybe (NonEmpty Double)) Source #
The bounding box that fully contains all search results.
If you specified the optional FilterBBox
parameter in the request,
ResultBBox
is contained within FilterBBox
.
searchPlaceIndexForTextSummary_dataSource :: Lens' SearchPlaceIndexForTextSummary Text Source #
The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:
- Esri
- Here
For more information about data providers, see Amazon Location Service data providers.
searchPlaceIndexForTextSummary_text :: Lens' SearchPlaceIndexForTextSummary Text Source #
The search text specified in the request.
Step
step_geometryOffset :: Lens' Step (Maybe Natural) Source #
Represents the start position, or index, in a sequence of steps within
the leg's line string geometry. For example, the index of the first
step in a leg geometry is 0
.
Included in the response for queries that set IncludeLegGeometry
to
True
.
step_distance :: Lens' Step Double Source #
The travel distance between the step's StartPosition
and
EndPosition
.
step_durationSeconds :: Lens' Step Double Source #
The estimated travel time, in seconds, from the step's StartPosition
to the EndPosition
. . The travel mode and departure time that you
specify in the request determines the calculated time.
step_endPosition :: Lens' Step (NonEmpty Double) Source #
The end position of a step. If the position the last step in the leg, this position is the same as the end position of the leg.
step_startPosition :: Lens' Step (NonEmpty Double) Source #
The starting position of a step. If the position is the first step in the leg, this position is the same as the start position of the leg.
TimeZone
timeZone_name :: Lens' TimeZone Text Source #
The name of the time zone, following the
IANA time zone standard. For example,
America/Los_Angeles
.
TruckDimensions
truckDimensions_height :: Lens' TruckDimensions (Maybe Double) Source #
The height of the truck.
- For example,
4.5
.
For routes calculated with a HERE resource, this value must be between 0 and 50 meters.
truckDimensions_length :: Lens' TruckDimensions (Maybe Double) Source #
The length of the truck.
- For example,
15.5
.
For routes calculated with a HERE resource, this value must be between 0 and 300 meters.
truckDimensions_unit :: Lens' TruckDimensions (Maybe DimensionUnit) Source #
Specifies the unit of measurement for the truck dimensions.
Default Value: Meters
truckDimensions_width :: Lens' TruckDimensions (Maybe Double) Source #
The width of the truck.
- For example,
4.5
.
For routes calculated with a HERE resource, this value must be between 0 and 50 meters.
TruckWeight
truckWeight_total :: Lens' TruckWeight (Maybe Double) Source #
The total weight of the truck.
- For example,
3500
.
truckWeight_unit :: Lens' TruckWeight (Maybe VehicleWeightUnit) Source #
The unit of measurement to use for the truck weight.
Default Value: Kilograms