libZSservicesZSamazonka-locationZSamazonka-location
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Location.Lens

Contents

Description

 
Synopsis

Operations

BatchUpdateDevicePosition

batchUpdateDevicePositionResponse_errors :: Lens' BatchUpdateDevicePositionResponse [BatchUpdateDevicePositionError] Source #

Contains error details for each device that failed to update its position.

DeleteRouteCalculator

deleteRouteCalculator_calculatorName :: Lens' DeleteRouteCalculator Text Source #

The name of the route calculator resource to be deleted.

UpdateRouteCalculator

updateRouteCalculator_pricingPlan :: Lens' UpdateRouteCalculator (Maybe PricingPlan) Source #

Updates the pricing plan for the route calculator resource.

For more information about each pricing plan option restrictions, see Amazon Location Service pricing.

updateRouteCalculator_description :: Lens' UpdateRouteCalculator (Maybe Text) Source #

Updates the description for the route calculator resource.

updateRouteCalculator_calculatorName :: Lens' UpdateRouteCalculator Text Source #

The name of the route calculator resource to update.

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_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.

CreateGeofenceCollection

createGeofenceCollection_pricingPlanDataSource :: Lens' CreateGeofenceCollection (Maybe Text) Source #

Specifies the data provider for the geofence collection.

  • Required value for the following pricing plans: MobileAssetTracking | MobileAssetManagement

For more information about Data Providers, and Pricing plans, see the Amazon Location Service product page.

Amazon Location Service only uses PricingPlanDataSource to calculate billing for your geofence collection. Your data won't be shared with the data provider, and will remain in your AWS account or Region unless you move it.

Valid Values: Esri | Here

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_description :: Lens' CreateGeofenceCollection (Maybe Text) Source #

An optional description for the geofence collection.

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: + - = . _ : / @.

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.

createGeofenceCollection_pricingPlan :: Lens' CreateGeofenceCollection PricingPlan Source #

Specifies the pricing plan for the geofence collection.

For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.

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_createTime :: Lens' CreateGeofenceCollectionResponse UTCTime Source #

The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

ListRouteCalculators

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

listRouteCalculators_maxResults :: Lens' ListRouteCalculators (Maybe Natural) Source #

An optional maximum number of results returned in a single call.

Default Value: 100

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_entries :: Lens' ListRouteCalculatorsResponse [ListRouteCalculatorsResponseEntry] Source #

Lists the route calculator resources that exist in your AWS account

CreateTracker

createTracker_pricingPlanDataSource :: Lens' CreateTracker (Maybe Text) Source #

Specifies the data provider for the tracker resource.

  • Required value for the following pricing plans: MobileAssetTracking | MobileAssetManagement

For more information about Data Providers, and Pricing plans, see the Amazon Location Service product page.

Amazon Location Service only uses PricingPlanDataSource to calculate billing for your tracker resource. Your data will not be shared with the data provider, and will remain in your AWS account or Region unless you move it.

Valid values: Esri | Here

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_description :: Lens' CreateTracker (Maybe Text) Source #

An optional description for the tracker resource.

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: + - = . _ : / @.

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 distance are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and device positions to retrieve. Distance-based filtering can also reduce the jitter effect when displaying device trajectory on a map.

This field is optional. If not specified, the default value is TimeBased.

createTracker_pricingPlan :: Lens' CreateTracker PricingPlan Source #

Specifies the pricing plan for the tracker resource.

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

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_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

ListTrackerConsumers

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_maxResults :: Lens' ListTrackerConsumers (Maybe Natural) Source #

An optional limit for the number of resources returned in a single call.

Default value: 100

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_consumerArns :: Lens' ListTrackerConsumersResponse [Text] Source #

Contains the list of geofence collection ARNs associated to the tracker resource.

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_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.

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"}

SearchPlaceIndexForText

searchPlaceIndexForText_filterBBox :: Lens' SearchPlaceIndexForText (Maybe (NonEmpty Double)) Source #

Filters the results by returning only Places within the provided bounding box. An optional parameter.

The first 2 bbox parameters describe the lower southwest corner:

  • The first bbox position is the X coordinate or longitude of the lower southwest corner.
  • The second bbox position is the Y coordinate or latitude of the lower southwest corner.

For example, bbox=xLongitudeSW&bbox=yLatitudeSW.

The next bbox parameters describe the upper northeast corner:

  • The third bbox position is the X coordinate, or longitude of the upper northeast corner.
  • The fourth bbox position is the Y coordinate, or longitude of the upper northeast corner.

For example, bbox=xLongitudeNE&bbox=yLatitudeNE

searchPlaceIndexForText_biasPosition :: Lens' SearchPlaceIndexForText (Maybe (NonEmpty Double)) Source #

Searches for results closest to the given position. An optional parameter defined by longitude, and latitude.

  • The first bias position is the X coordinate, or longitude.
  • The second bias position is the Y coordinate, or latitude.

For example, bias=xLongitude&bias=yLatitude.

searchPlaceIndexForText_filterCountries :: Lens' SearchPlaceIndexForText (Maybe (NonEmpty Text)) Source #

Limits the search to the given a list of countries/regions. An optional parameter.

  • Use the ISO 3166 3-digit country code. For example, Australia uses three upper-case characters: AUS.

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_results :: Lens' SearchPlaceIndexForTextResponse [SearchForTextResult] Source #

A list of Places closest to the specified position. Each result contains additional information about the specific point of interest.

searchPlaceIndexForTextResponse_summary :: Lens' SearchPlaceIndexForTextResponse SearchPlaceIndexForTextSummary Source #

Contains a summary of the request. Contains the BiasPosition, DataSource, FilterBBox, FilterCountries, MaxResults, ResultBBox, and Text.

DescribeGeofenceCollection

describeGeofenceCollectionResponse_tags :: Lens' DescribeGeofenceCollectionResponse (Maybe (HashMap Text Text)) Source #

Displays the key, value pairs of tags associated with this resource.

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_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_pricingPlan :: Lens' DescribeGeofenceCollectionResponse PricingPlan Source #

The pricing plan selected for the specified geofence collection.

For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.

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

ListMaps

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

listMaps_maxResults :: Lens' ListMaps (Maybe Natural) Source #

An optional limit for the number of resources returned in a single call.

Default value: 100

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

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 contain 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.

CreateMap

createMap_description :: Lens' CreateMap (Maybe Text) Source #

An optional description for the map resource.

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: + - = . _ : / @.

createMap_configuration :: Lens' CreateMap MapConfiguration Source #

Specifies the map style selected from an available data provider.

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.

createMap_pricingPlan :: Lens' CreateMap PricingPlan Source #

Specifies the pricing plan for your map resource.

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

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:maps/ExampleMap

DescribeRouteCalculator

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_pricingPlan :: Lens' DescribeRouteCalculatorResponse PricingPlan Source #

The pricing plan selected for the specified route calculator resource.

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

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

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_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.

GetMapStyleDescriptor

getMapStyleDescriptor_mapName :: Lens' GetMapStyleDescriptor Text Source #

The map resource to retrieve the style descriptor from.

getMapStyleDescriptorResponse_contentType :: Lens' GetMapStyleDescriptorResponse (Maybe Text) Source #

The style descriptor's content type. For example, application/json.

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.

ListGeofenceCollections

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

listGeofenceCollections_maxResults :: Lens' ListGeofenceCollections (Maybe Natural) Source #

An optional limit for the number of resources returned in a single call.

Default value: 100

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.

DeleteGeofenceCollection

deleteGeofenceCollection_collectionName :: Lens' DeleteGeofenceCollection Text Source #

The name of the geofence collection to be deleted.

UpdateGeofenceCollection

updateGeofenceCollection_pricingPlan :: Lens' UpdateGeofenceCollection (Maybe PricingPlan) Source #

Updates the pricing plan for the geofence collection.

For more information about each pricing plan option restrictions, see Amazon Location Service pricing.

updateGeofenceCollection_pricingPlanDataSource :: Lens' UpdateGeofenceCollection (Maybe Text) Source #

Updates the data provider for the geofence collection.

A required value for the following pricing plans: MobileAssetTracking| MobileAssetManagement

For more information about data providers and pricing plans, see the Amazon Location Service product page.

This can only be updated when updating the PricingPlan in the same request.

Amazon Location Service uses PricingPlanDataSource to calculate billing for your geofence collection. Your data won't be shared with the data provider, and will remain in your AWS account and Region unless you move it.

updateGeofenceCollection_description :: Lens' UpdateGeofenceCollection (Maybe Text) Source #

Updates the description for the geofence collection.

updateGeofenceCollection_collectionName :: Lens' UpdateGeofenceCollection Text Source #

The name of the geofence collection to update.

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_updateTime :: Lens' UpdateGeofenceCollectionResponse UTCTime Source #

The time when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

ListTrackers

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

listTrackers_maxResults :: Lens' ListTrackers (Maybe Natural) Source #

An optional limit for the number of resources returned in a single call.

Default value: 100

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_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.

DeletePlaceIndex

deletePlaceIndex_indexName :: Lens' DeletePlaceIndex Text Source #

The name of the place index resource to be deleted.

UpdatePlaceIndex

updatePlaceIndex_pricingPlan :: Lens' UpdatePlaceIndex (Maybe PricingPlan) Source #

Updates the pricing plan for the place index resource.

For more information about each pricing plan option restrictions, see Amazon Location Service pricing.

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_indexName :: Lens' UpdatePlaceIndex Text Source #

The name of the place index resource to update.

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.

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.

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 polygon details to specify the position of the geofence.

Each geofence polygon can have a maximum of 1,000 vertices.

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

ListGeofences

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_entries :: Lens' ListGeofencesResponse [ListGeofenceResponseEntry] Source #

Contains a list of geofences stored in the geofence collection.

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.

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_errors :: Lens' BatchEvaluateGeofencesResponse [BatchEvaluateGeofencesError] Source #

Contains error details for each device that failed to evaluate its position against the given geofence collection.

CalculateRoute

calculateRoute_distanceUnit :: Lens' CalculateRoute (Maybe DistanceUnit) Source #

Set the unit system to specify the distance.

Default Value: Kilometers

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_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_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_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.

The TravelMode you specify determines how you specify route preferences:

  • If traveling by Car use the CarModeOptions parameter.
  • If traveling by Truck use the TruckModeOptions parameter.

Default Value: Car

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_departureTime :: Lens' CalculateRoute (Maybe UTCTime) Source #

Specifies the desired time of departure. Uses the given time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Setting a departure time in the past returns a 400 ValidationException error.

  • In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00

calculateRoute_calculatorName :: Lens' CalculateRoute Text Source #

The name of the route calculator resource that you want to use to calculate a route.

calculateRoute_departurePosition :: Lens' CalculateRoute (NonEmpty Double) Source #

The start position for the route. Defined in WGS 84 format: [longitude, latitude].

  • For example, [-123.115, 49.285]

If you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

Valid Values: [-180 to 180,-90 to 90]

calculateRoute_destinationPosition :: Lens' CalculateRoute (NonEmpty Double) Source #

The finish position for the route. Defined in WGS 84 format: [longitude, latitude].

  • For example, [-122.339, 47.615]

If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.

Valid Values: [-180 to 180,-90 to 90]

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 . The EndPosition is the waypoint positon.
  • Leg 2: The StartPosition is the waypoint position. The EndPosition is the destination position.

calculateRouteResponse_summary :: Lens' CalculateRouteResponse CalculateRouteSummary Source #

Contains information about the whole route, such as: RouteBBox, DataSource, Distance, DistanceUnit, and DurationSeconds.

DeleteMap

deleteMap_mapName :: Lens' DeleteMap Text Source #

The name of the map resource to be deleted.

deleteMapResponse_httpStatus :: Lens' DeleteMapResponse Int Source #

The response's http status code.

UpdateMap

updateMap_pricingPlan :: Lens' UpdateMap (Maybe PricingPlan) Source #

Updates the pricing plan for the map resource.

For more information about each pricing plan option restrictions, see Amazon Location Service pricing.

updateMap_description :: Lens' UpdateMap (Maybe Text) Source #

Updates the description for the map resource.

updateMap_mapName :: Lens' UpdateMap Text Source #

The name of the map resource to update.

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:maps/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.

GetDevicePositionHistory

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_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 for StartTimeInclusive.

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 before EndTimeExclusive.

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_devicePositions :: Lens' GetDevicePositionHistoryResponse [DevicePosition] Source #

Contains the position history details for the requested device.

DescribeTracker

describeTracker_trackerName :: Lens' DescribeTracker Text Source #

The name of the tracker resource.

describeTrackerResponse_pricingPlanDataSource :: Lens' DescribeTrackerResponse (Maybe Text) Source #

The specified data provider for 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_tags :: Lens' DescribeTrackerResponse (Maybe (HashMap Text Text)) Source #

The tags associated with the tracker resource.

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_pricingPlan :: Lens' DescribeTrackerResponse PricingPlan Source #

The pricing plan selected for the specified tracker resource.

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

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_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.

DescribePlaceIndex

describePlaceIndex_indexName :: Lens' DescribePlaceIndex Text Source #

The name of the place index resource.

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. Indicates one of the available providers:

  • Esri
  • Here

For additional details on data providers, see Amazon Location Service data providers.

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_pricingPlan :: Lens' DescribePlaceIndexResponse PricingPlan Source #

The pricing plan selected for the specified place index resource.

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

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.

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_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_geometry :: Lens' GetGeofenceResponse GeofenceGeometry Source #

Contains the geofence geometry details describing a polygon.

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

ListDevicePositions

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_maxResults :: Lens' ListDevicePositions (Maybe Natural) Source #

An optional limit for the number of entries returned in a single call.

Default value: 100

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_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.

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 #

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"}

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:

  • VectorHereBerlin – Fira GO Regular | Fira GO Bold

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_contentType :: Lens' GetMapGlyphsResponse (Maybe Text) Source #

The map glyph content type. For example, application/octet-stream.

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_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.

BatchDeleteGeofence

batchDeleteGeofence_collectionName :: Lens' BatchDeleteGeofence Text Source #

The geofence collection storing the geofences to be deleted.

batchDeleteGeofenceResponse_errors :: Lens' BatchDeleteGeofenceResponse [BatchDeleteGeofenceError] Source #

Contains error details for each geofence that failed to delete.

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.

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.

ListPlaceIndexes

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

listPlaceIndexes_maxResults :: Lens' ListPlaceIndexes (Maybe Natural) Source #

An optional limit for the maximum number of results returned in a single call.

Default value: 100

listPlaceIndexesResponse_nextToken :: Lens' ListPlaceIndexesResponse (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.

listPlaceIndexesResponse_entries :: Lens' ListPlaceIndexesResponse [ListPlaceIndexesResponseEntry] Source #

Lists the place index resources that exist in your AWS account

SearchPlaceIndexForPosition

searchPlaceIndexForPosition_maxResults :: Lens' SearchPlaceIndexForPosition (Maybe Natural) Source #

An optional paramer. 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 a coordinate for the query defined by a longitude, and latitude.

  • The first position is the X coordinate, or longitude.
  • The second position is the Y coordinate, or latitude.

For example, position=xLongitude&position=yLatitude .

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.

DeleteTracker

deleteTracker_trackerName :: Lens' DeleteTracker Text Source #

The name of the tracker resource to be deleted.

CreatePlaceIndex

createPlaceIndex_description :: Lens' CreatePlaceIndex (Maybe Text) Source #

The optional description for the place index resource.

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 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: + - = . _ : / @.

createPlaceIndex_dataSource :: Lens' CreatePlaceIndex Text Source #

Specifies the data provider of geospatial data.

This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

Valid values include:

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.

createPlaceIndex_pricingPlan :: Lens' CreatePlaceIndex PricingPlan Source #

Specifies the pricing plan for your place index resource.

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

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

UpdateTracker

updateTracker_pricingPlan :: Lens' UpdateTracker (Maybe PricingPlan) Source #

Updates the pricing plan for the tracker resource.

For more information about each pricing plan option restrictions, see Amazon Location Service pricing.

updateTracker_pricingPlanDataSource :: Lens' UpdateTracker (Maybe Text) Source #

Updates the data provider for the tracker resource.

A required value for the following pricing plans: MobileAssetTracking| MobileAssetManagement

For more information about data providers and pricing plans, see the Amazon Location Service product page

This can only be updated when updating the PricingPlan in the same request.

Amazon Location Service uses PricingPlanDataSource to calculate billing for your tracker resource. Your data won't be shared with the data provider, and will remain in your AWS account and Region unless you move it.

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 device positions to retrieve. Distance-based filtering can also reduce the jitter effect when displaying device trajectory on a map.

updateTracker_trackerName :: Lens' UpdateTracker Text Source #

The name of the tracker resource to update.

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.

CreateRouteCalculator

createRouteCalculator_description :: Lens' CreateRouteCalculator (Maybe Text) Source #

The optional description for the route calculator resource.

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: + - = . _ : / @.

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:

For additional information , see Data providers on the Amazon Location Service Developer Guide.

createRouteCalculator_pricingPlan :: Lens' CreateRouteCalculator PricingPlan Source #

Specifies the pricing plan for your route calculator resource.

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

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

DescribeMap

describeMap_mapName :: Lens' DescribeMap Text Source #

The name of the map resource.

describeMapResponse_tags :: Lens' DescribeMapResponse (Maybe (HashMap Text Text)) Source #

Tags associated with the map resource.

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:maps/ExampleMap

describeMapResponse_mapName :: Lens' DescribeMapResponse Text Source #

The map style selected from an available provider.

describeMapResponse_pricingPlan :: Lens' DescribeMapResponse PricingPlan Source #

The pricing plan selected for the specified map resource.

 <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>

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.

Types

BatchDeleteDevicePositionHistoryError

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_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.

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 polygon details to specify the position of the geofence.

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_avoidTolls :: Lens' CalculateRouteCarModeOptions (Maybe Bool) Source #

Avoids tolls when calculating routes.

Default Value: false

Valid Values: false | true

calculateRouteCarModeOptions_avoidFerries :: Lens' CalculateRouteCarModeOptions (Maybe Bool) Source #

Avoids ferries when calculating routes.

Default Value: false

Valid Values: false | true

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_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_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.

calculateRouteTruckModeOptions_avoidTolls :: Lens' CalculateRouteTruckModeOptions (Maybe Bool) Source #

Avoids ferries 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_avoidFerries :: Lens' CalculateRouteTruckModeOptions (Maybe Bool) Source #

Avoids ferries when calculating routes.

Default Value: false

Valid Values: false | true

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_deviceId :: Lens' DevicePosition (Maybe Text) Source #

The device whose position you retrieved.

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_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_polygon :: Lens' GeofenceGeometry (Maybe (NonEmpty (NonEmpty (NonEmpty Double)))) Source #

An array of 1 or more linear rings. A linear ring is an array of 4 or more vertices, where the first and last vertex are the same to form a closed boundary. Each vertex is a 2-dimensional point of the form: [longitude, latitude].

The first linear ring is an outer ring, describing the polygon's boundary. Subsequent linear rings may be inner or outer rings to describe holes and islands. Outer rings must list their vertices in counter-clockwise order around the ring's center, where the left side is the polygon's exterior. Inner rings must list their vertices in clockwise order, where the left side is the polygon's interior.

Leg

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 a DistanceUnit of Miles.

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_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_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_pricingPlan :: Lens' ListGeofenceCollectionsResponseEntry PricingPlan Source #

The pricing plan for the specified geofence collection.

For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.

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_geometry :: Lens' ListGeofenceResponseEntry GeofenceGeometry Source #

Contains the geofence geometry details describing a polygon.

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_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_mapName :: Lens' ListMapsResponseEntry Text Source #

The name of the associated map resource.

listMapsResponseEntry_pricingPlan :: Lens' ListMapsResponseEntry PricingPlan Source #

The pricing plan for the specified map resource.

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

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_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. Indicates one of the available providers:

  • Esri
  • Here

For additional details on data providers, see Amazon Location Service data providers.

listPlaceIndexesResponseEntry_description :: Lens' ListPlaceIndexesResponseEntry Text Source #

The optional description for the place index resource.

listPlaceIndexesResponseEntry_pricingPlan :: Lens' ListPlaceIndexesResponseEntry PricingPlan Source #

The pricing plan for the specified place index resource.

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

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_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_pricingPlan :: Lens' ListRouteCalculatorsResponseEntry PricingPlan Source #

The pricing plan for the specified route calculator resource.

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

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_pricingPlanDataSource :: Lens' ListTrackersResponseEntry (Maybe Text) Source #

The specified data provider for the tracker resource.

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_pricingPlan :: Lens' ListTrackersResponseEntry PricingPlan Source #

The pricing plan for the specified tracker resource.

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

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:

  • VectorHereBerlin – The HERE Berlin map style is a high contrast detailed base map of the world that blends 3D and 2D rendering.

    When using HERE as your data provider, and selecting the Style VectorHereBerlin, you may not use HERE Technologies maps for Asset Management. See the AWS Service Terms for Amazon Location Service.

Place

place_municipality :: Lens' Place (Maybe Text) Source #

A name for a local area, such as a city or town name. For example, Toronto.

place_addressNumber :: Lens' Place (Maybe Text) Source #

The numerical portion of an address, such as a building number.

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_country :: Lens' Place (Maybe Text) Source #

A country/region specified using ISO 3166 3-digit country/region code. For example, CAN.

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_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_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_neighborhood :: Lens' Place (Maybe Text) Source #

The name of a community district. For example, Downtown.

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.

SearchForPositionResult

searchForPositionResult_place :: Lens' SearchForPositionResult Place Source #

Contains details about the relevant point of interest.

SearchForTextResult

searchForTextResult_place :: Lens' SearchForTextResult Place Source #

Contains details about the relevant point of interest.

SearchPlaceIndexForPositionSummary

searchPlaceIndexForPositionSummary_maxResults :: Lens' SearchPlaceIndexForPositionSummary (Maybe Natural) Source #

An optional parameter. The maximum number of results returned per request.

Default value: 50

searchPlaceIndexForPositionSummary_dataSource :: Lens' SearchPlaceIndexForPositionSummary Text Source #

The data provider of geospatial data. Indicates one of the available providers:

  • Esri
  • HERE

For additional details on data providers, see Amazon Location Service data providers.

SearchPlaceIndexForTextSummary

searchPlaceIndexForTextSummary_filterBBox :: Lens' SearchPlaceIndexForTextSummary (Maybe (NonEmpty Double)) Source #

Contains the coordinates for the optional bounding box coordinated entered in the geocoding request.

searchPlaceIndexForTextSummary_resultBBox :: Lens' SearchPlaceIndexForTextSummary (Maybe (NonEmpty Double)) Source #

A bounding box that contains the search results within the specified area indicated by FilterBBox. A subset of bounding box specified using FilterBBox.

searchPlaceIndexForTextSummary_biasPosition :: Lens' SearchPlaceIndexForTextSummary (Maybe (NonEmpty Double)) Source #

Contains the coordinates for the bias position entered in the geocoding request.

searchPlaceIndexForTextSummary_filterCountries :: Lens' SearchPlaceIndexForTextSummary (Maybe (NonEmpty Text)) Source #

Contains the country filter entered in the geocoding request.

searchPlaceIndexForTextSummary_maxResults :: Lens' SearchPlaceIndexForTextSummary (Maybe Natural) Source #

Contains the maximum number of results indicated for the request.

searchPlaceIndexForTextSummary_dataSource :: Lens' SearchPlaceIndexForTextSummary Text Source #

The data provider of geospatial data. Indicates one of the available providers:

  • Esri
  • HERE

For additional details on data providers, see Amazon Location Service data providers.

searchPlaceIndexForTextSummary_text :: Lens' SearchPlaceIndexForTextSummary Text Source #

The address, name, city or region to be used in the geocoding request. In free-form text format. For example, Vancouver.

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.

TruckDimensions

truckDimensions_length :: Lens' TruckDimensions (Maybe Double) Source #

The length of the truck.

  • For example, 15.5.

truckDimensions_height :: Lens' TruckDimensions (Maybe Double) Source #

The height of the truck.

  • For example, 4.5.

truckDimensions_width :: Lens' TruckDimensions (Maybe Double) Source #

The width of the truck.

  • For example, 4.5.

truckDimensions_unit :: Lens' TruckDimensions (Maybe DimensionUnit) Source #

Specifies the unit of measurement for the truck dimensions.

Default Value: 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