# Actions The following actions are supported by Amazon Location Service Routes V2: + [CalculateIsolines](API_CalculateIsolines.md) + [CalculateRouteMatrix](API_CalculateRouteMatrix.md) + [CalculateRoutes](API_CalculateRoutes.md) + [OptimizeWaypoints](API_OptimizeWaypoints.md) + [SnapToRoads](API_SnapToRoads.md) The following actions are supported by Amazon Location Service Maps V2: + [GetGlyphs](API_geomaps_GetGlyphs.md) + [GetSprites](API_geomaps_GetSprites.md) + [GetStaticMap](API_geomaps_GetStaticMap.md) + [GetStyleDescriptor](API_geomaps_GetStyleDescriptor.md) + [GetTile](API_geomaps_GetTile.md) The following actions are supported by Amazon Location Service Places V2: + [Autocomplete](API_geoplaces_Autocomplete.md) + [Geocode](API_geoplaces_Geocode.md) + [GetPlace](API_geoplaces_GetPlace.md) + [ReverseGeocode](API_geoplaces_ReverseGeocode.md) + [SearchNearby](API_geoplaces_SearchNearby.md) + [SearchText](API_geoplaces_SearchText.md) + [Suggest](API_geoplaces_Suggest.md) The following actions are supported by Amazon Location Service Tagging: + [CreateKey](API_geotags_CreateKey.md) + [DeleteKey](API_geotags_DeleteKey.md) + [DescribeKey](API_geotags_DescribeKey.md) + [ListKeys](API_geotags_ListKeys.md) + [ListTagsForResource](API_geotags_ListTagsForResource.md) + [TagResource](API_geotags_TagResource.md) + [UntagResource](API_geotags_UntagResource.md) + [UpdateKey](API_geotags_UpdateKey.md) The following actions are supported by Amazon Location Service Geofences: + [BatchDeleteGeofence](API_WaypointGeofencing_BatchDeleteGeofence.md) + [BatchEvaluateGeofences](API_WaypointGeofencing_BatchEvaluateGeofences.md) + [BatchPutGeofence](API_WaypointGeofencing_BatchPutGeofence.md) + [CreateGeofenceCollection](API_WaypointGeofencing_CreateGeofenceCollection.md) + [DeleteGeofenceCollection](API_WaypointGeofencing_DeleteGeofenceCollection.md) + [DescribeGeofenceCollection](API_WaypointGeofencing_DescribeGeofenceCollection.md) + [ForecastGeofenceEvents](API_WaypointGeofencing_ForecastGeofenceEvents.md) + [GetGeofence](API_WaypointGeofencing_GetGeofence.md) + [ListGeofenceCollections](API_WaypointGeofencing_ListGeofenceCollections.md) + [ListGeofences](API_WaypointGeofencing_ListGeofences.md) + [PutGeofence](API_WaypointGeofencing_PutGeofence.md) + [UpdateGeofenceCollection](API_WaypointGeofencing_UpdateGeofenceCollection.md) The following actions are supported by Amazon Location Service Trackers: + [AssociateTrackerConsumer](API_WaypointTracking_AssociateTrackerConsumer.md) + [BatchDeleteDevicePositionHistory](API_WaypointTracking_BatchDeleteDevicePositionHistory.md) + [BatchGetDevicePosition](API_WaypointTracking_BatchGetDevicePosition.md) + [BatchUpdateDevicePosition](API_WaypointTracking_BatchUpdateDevicePosition.md) + [CreateTracker](API_WaypointTracking_CreateTracker.md) + [DeleteTracker](API_WaypointTracking_DeleteTracker.md) + [DescribeTracker](API_WaypointTracking_DescribeTracker.md) + [DisassociateTrackerConsumer](API_WaypointTracking_DisassociateTrackerConsumer.md) + [GetDevicePosition](API_WaypointTracking_GetDevicePosition.md) + [GetDevicePositionHistory](API_WaypointTracking_GetDevicePositionHistory.md) + [ListDevicePositions](API_WaypointTracking_ListDevicePositions.md) + [ListTrackerConsumers](API_WaypointTracking_ListTrackerConsumers.md) + [ListTrackers](API_WaypointTracking_ListTrackers.md) + [UpdateTracker](API_WaypointTracking_UpdateTracker.md) + [VerifyDevicePosition](API_WaypointTracking_VerifyDevicePosition.md) # Amazon Location Service Routes V2 The following actions are supported by Amazon Location Service Routes V2: + [CalculateIsolines](API_CalculateIsolines.md) + [CalculateRouteMatrix](API_CalculateRouteMatrix.md) + [CalculateRoutes](API_CalculateRoutes.md) + [OptimizeWaypoints](API_OptimizeWaypoints.md) + [SnapToRoads](API_SnapToRoads.md) # CalculateIsolines Calculates areas that can be reached within specified time or distance thresholds from a given point. For example, you can use this operation to determine the area within a 30-minute drive of a store location, find neighborhoods within walking distance of a school, or identify delivery zones based on drive time. Isolines (also known as isochrones for time-based calculations) are useful for various applications including: + Service area visualization - Show customers the area you can serve within promised delivery times + Site selection - Analyze potential business locations based on population within travel distance + Site selection - Determine areas that can be reached within specified response times **Note** Route preferences such as avoiding toll roads or ferries are treated as preferences rather than absolute restrictions. If a viable route cannot be calculated while honoring all preferences, some may be ignored. For more information, see [Calculate isolines](https://docs.aws.amazon.com/location/latest/developerguide/calculate-isolines.html) in the *Amazon Location Service Developer Guide*. ## Request Syntax ``` POST /isolines?key=Key HTTP/1.1 Content-type: application/json { "Allow": { "Hot": boolean, "Hov": boolean }, "ArrivalTime": "string", "Avoid": { "Areas": [ { "Except": [ { "BoundingBox": [ number ], "Corridor": { "LineString": [ [ number ] ], "Radius": number }, "Polygon": [ [ [ number ] ] ], "PolylineCorridor": { "Polyline": "string", "Radius": number }, "PolylinePolygon": [ "string" ] } ], "Geometry": { "BoundingBox": [ number ], "Corridor": { "LineString": [ [ number ] ], "Radius": number }, "Polygon": [ [ [ number ] ] ], "PolylineCorridor": { "Polyline": "string", "Radius": number }, "PolylinePolygon": [ "string" ] } } ], "CarShuttleTrains": boolean, "ControlledAccessHighways": boolean, "DirtRoads": boolean, "Ferries": boolean, "SeasonalClosure": boolean, "TollRoads": boolean, "TollTransponders": boolean, "TruckRoadTypes": [ "string" ], "Tunnels": boolean, "UTurns": boolean, "ZoneCategories": [ { "Category": "string" } ] }, "DepartNow": boolean, "DepartureTime": "string", "Destination": [ number ], "DestinationOptions": { "AvoidActionsForDistance": number, "Heading": number, "Matching": { "NameHint": "string", "OnRoadThreshold": number, "Radius": number, "Strategy": "string" }, "SideOfStreet": { "Position": [ number ], "UseWith": "string" } }, "IsolineGeometryFormat": "string", "IsolineGranularity": { "MaxPoints": number, "MaxResolution": number }, "OptimizeIsolineFor": "string", "OptimizeRoutingFor": "string", "Origin": [ number ], "OriginOptions": { "AvoidActionsForDistance": number, "Heading": number, "Matching": { "NameHint": "string", "OnRoadThreshold": number, "Radius": number, "Strategy": "string" }, "SideOfStreet": { "Position": [ number ], "UseWith": "string" } }, "Thresholds": { "Distance": [ number ], "Time": [ number ] }, "Traffic": { "FlowEventThresholdOverride": number, "Usage": "string" }, "TravelMode": "string", "TravelModeOptions": { "Car": { "EngineType": "string", "LicensePlate": { "LastCharacter": "string" }, "MaxSpeed": number, "Occupancy": number }, "Scooter": { "EngineType": "string", "LicensePlate": { "LastCharacter": "string" }, "MaxSpeed": number, "Occupancy": number }, "Truck": { "AxleCount": number, "EngineType": "string", "GrossWeight": number, "HazardousCargos": [ "string" ], "Height": number, "HeightAboveFirstAxle": number, "KpraLength": number, "Length": number, "LicensePlate": { "LastCharacter": "string" }, "MaxSpeed": number, "Occupancy": number, "PayloadCapacity": number, "TireCount": number, "Trailer": { "AxleCount": number, "TrailerCount": number }, "TruckType": "string", "TunnelRestrictionCode": "string", "WeightPerAxle": number, "WeightPerAxleGroup": { "Quad": number, "Quint": number, "Single": number, "Tandem": number, "Triple": number }, "Width": number } } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [Key](#API_CalculateIsolines_RequestSyntax) ** An Amazon Location Service API Key with access to this action. If omitted, the request must be signed using Signature Version 4. Length Constraints: Minimum length of 0. Maximum length of 1000. ## Request Body The request accepts the following data in JSON format. ** [Allow](#API_CalculateIsolines_RequestSyntax) ** Enables special road types or features that should be considered for routing even if they might be restricted by default for the selected travel mode. These include high-occupancy vehicle and toll lanes. Type: [IsolineAllowOptions](API_IsolineAllowOptions.md) object Required: No ** [ArrivalTime](#API_CalculateIsolines_RequestSyntax) ** Determine areas from which `Destination` can be reached by this time, taking into account predicted traffic conditions and working backward to account for congestion patterns. This attribute cannot be used together with `DepartureTime` or `DepartNow`. Specified as an ISO-8601 timestamp with timezone offset. Time format: `YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm` Examples: `2020-04-22T17:57:24Z` `2020-04-22T17:57:24+02:00` Type: String Pattern: `([1-2][0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)(\.[0-9]{0,9})?(Z|[+-]([01][0-9]|2[0-3]):[0-5][0-9])` Required: No ** [Avoid](#API_CalculateIsolines_RequestSyntax) ** Specifies road types, features, or areas to avoid (if possible) when calculating reachable areas. These are treated as preferences rather than strict constraints—if a route cannot be calculated without using an avoided feature, that avoidance preference may be ignored. Type: [IsolineAvoidanceOptions](API_IsolineAvoidanceOptions.md) object Required: No ** [DepartNow](#API_CalculateIsolines_RequestSyntax) ** When true, uses the current time as the departure time and takes current traffic conditions into account. This attribute cannot be used together with `DepartureTime` or `ArrivalTime`. Type: Boolean Required: No ** [DepartureTime](#API_CalculateIsolines_RequestSyntax) ** Determine areas that can be reached when departing at this time, taking into account predicted traffic conditions. This attribute cannot be used together with `ArrivalTime` or `DepartNow`. Specified as an ISO-8601 timestamp with timezone offset. Time format:`YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm` Examples: `2020-04-22T17:57:24Z` `2020-04-22T17:57:24+02:00` Type: String Pattern: `([1-2][0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)(\.[0-9]{0,9})?(Z|[+-]([01][0-9]|2[0-3]):[0-5][0-9])` Required: No ** [Destination](#API_CalculateIsolines_RequestSyntax) ** An optional destination point, specified as `[longitude, latitude]` coordinates. When provided, the service calculates areas from which this destination can be reached within the specified thresholds. This reverses the usual isoline calculation to show areas that could reach your location, rather than areas you could reach from your location. Either `Origin` or `Destination` must be provided. Type: Array of doubles Array Members: Fixed number of 2 items. Required: No ** [DestinationOptions](#API_CalculateIsolines_RequestSyntax) ** Options that control how the destination point is matched to the road network and how routes can approach it. These options help improve travel time accuracy by accounting for real-world access to the destination. Type: [IsolineDestinationOptions](API_IsolineDestinationOptions.md) object Required: No ** [IsolineGeometryFormat](#API_CalculateIsolines_RequestSyntax) ** The format of the returned IsolineGeometry. Default value:`FlexiblePolyline` Type: String Valid Values: `FlexiblePolyline | Simple` Required: No ** [IsolineGranularity](#API_CalculateIsolines_RequestSyntax) ** Controls the detail level of the generated isolines. Higher granularity produces smoother shapes but requires more processing time and results in larger responses. Type: [IsolineGranularityOptions](API_IsolineGranularityOptions.md) object Required: No ** [OptimizeIsolineFor](#API_CalculateIsolines_RequestSyntax) ** Controls the trade-off between calculation speed and isoline precision. Choose ` FastCalculation` for quicker results with less detail, `AccurateCalculation` for more precise results, or `BalancedCalculation` for a middle ground. Default value: `BalancedCalculation` Type: String Valid Values: `AccurateCalculation | BalancedCalculation | FastCalculation` Required: No ** [OptimizeRoutingFor](#API_CalculateIsolines_RequestSyntax) ** Determines whether routes prioritize shortest travel time (`FastestRoute`) or shortest physical distance (`ShortestRoute`) when calculating reachable areas. Default value: `FastestRoute` Type: String Valid Values: `FastestRoute | ShortestRoute` Required: No ** [Origin](#API_CalculateIsolines_RequestSyntax) ** The starting point for isoline calculations, specified as `[longitude, latitude]` coordinates. For example, this could be a store location, service center, or any point from which you want to calculate reachable areas. Either `Origin` or `Destination` must be provided. Type: Array of doubles Array Members: Fixed number of 2 items. Required: No ** [OriginOptions](#API_CalculateIsolines_RequestSyntax) ** Options that control how the origin point is matched to the road network and how routes can depart from it. These options help improve travel time accuracy by accounting for real-world access from the origin. Type: [IsolineOriginOptions](API_IsolineOriginOptions.md) object Required: No ** [Thresholds](#API_CalculateIsolines_RequestSyntax) ** The distance or time thresholds used to determine reachable areas. You can specify up to five thresholds (which all must be the same type) to calculate multiple isolines in a single request. For example, to determine the areas that are reachable within 10 and 20 minutes of the origin, specify time thresholds of 600 and 1200 seconds. You incur a calculation charge for each threshold. Using a large number of thresholds in a request can lead to unexpected charges. For more information, see [Routes pricing](https://docs.aws.amazon.com/location/latest/developerguide/routes-pricing.html) in the *Amazon Location Service Developer Guide*. Type: [IsolineThresholds](API_IsolineThresholds.md) object Required: Yes ** [Traffic](#API_CalculateIsolines_RequestSyntax) ** Configures how real-time and historical traffic data affects isoline calculations. Traffic patterns can significantly impact reachable areas, especially during peak hours. Type: [IsolineTrafficOptions](API_IsolineTrafficOptions.md) object Required: No ** [TravelMode](#API_CalculateIsolines_RequestSyntax) ** The mode of transportation to use for calculations. This affects which road types or features can be used, estimated speed, and the traffic levels that are applied. + `Car`—Standard passenger vehicle routing using roads accessible to cars + `Pedestrian`—Walking routes using pedestrian paths, sidewalks, and crossings + `Scooter`—Light two-wheeled vehicle routing using roads and paths accessible to scooters + `Truck`—Commercial truck routing considering vehicle dimensions, weight restrictions, and hazardous material regulations The mode `Scooter` also applies to motorcycles; set this to `Scooter` when calculating isolines for motorcycles. Default value: `Car` Type: String Valid Values: `Car | Pedestrian | Scooter | Truck` Required: No ** [TravelModeOptions](#API_CalculateIsolines_RequestSyntax) ** Additional attributes that refine how reachable areas are calculated based on specific vehicle characteristics. These options help produce more accurate results by accounting for real-world constraints and capabilities. For example: + For trucks (`Truck`), specify dimensions, weight limits, and hazardous cargo restrictions to ensure isolines only include roads that can physically and legally accommodate the vehicle + For cars (`Car`), set maximum speed capabilities or indicate high-occupancy vehicle eligibility to better estimate reachable areas + For scooters (`Scooter`), specify engine type and speed limitations to more accurately model their travel capabilities Without these options, calculations use default assumptions that may not match your specific use case. Type: [IsolineTravelModeOptions](API_IsolineTravelModeOptions.md) object Required: No ## Response Syntax ``` HTTP/1.1 200 x-amz-geo-pricing-bucket: PricingBucket Content-type: application/json { "ArrivalTime": "string", "DepartureTime": "string", "IsolineGeometryFormat": "string", "Isolines": [ { "Connections": [ { "FromPolygonIndex": number, "Geometry": { "LineString": [ [ number ] ], "Polyline": "string" }, "ToPolygonIndex": number } ], "DistanceThreshold": number, "Geometries": [ { "Polygon": [ [ [ number ] ] ], "PolylinePolygon": [ "string" ] } ], "TimeThreshold": number } ], "SnappedDestination": [ number ], "SnappedOrigin": [ number ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The response returns the following HTTP headers. ** [PricingBucket](#API_CalculateIsolines_ResponseSyntax) ** The pricing bucket applied to this calculation. Different buckets apply based on the travel mode and thresholds used. The following data is returned in JSON format by the service. ** [ArrivalTime](#API_CalculateIsolines_ResponseSyntax) ** Time of arrival at the destination, used for traffic calculations. This attribute is returned only if the `Destination` and `ArrivalTime` attributes were provided in the request. Time format: `YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm` Examples: `2020-04-22T17:57:24Z` `2020-04-22T17:57:24+02:00` Type: String Pattern: `([1-2][0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)(\.[0-9]{0,9})?(Z|[+-]([01][0-9]|2[0-3]):[0-5][0-9])` ** [DepartureTime](#API_CalculateIsolines_ResponseSyntax) ** Time of departure from the origin, used for traffic calculations. This attribute is returned when `Origin` was provided in the request and either a specific departure time was requested (`DepartureTime`) or `DepartNow` was set to true. Time format: `YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm` Examples: `2020-04-22T17:57:24Z` `2020-04-22T17:57:24+02:00` Type: String Pattern: `([1-2][0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)(\.[0-9]{0,9})?(Z|[+-]([01][0-9]|2[0-3]):[0-5][0-9])` ** [IsolineGeometryFormat](#API_CalculateIsolines_ResponseSyntax) ** The format of the returned geometries, matching the format specified in the request. Either ` FlexiblePolyline` for compact encoding or `Simple` for GeoJSON-compatible coordinates. Default value:`FlexiblePolyline` Type: String Valid Values: `FlexiblePolyline | Simple` ** [Isolines](#API_CalculateIsolines_ResponseSyntax) ** Reachable areas, or isolines, for each threshold specified in the request. Type: Array of [Isoline](API_Isoline.md) objects Array Members: Minimum number of 1 item. Maximum number of 5 items. ** [SnappedDestination](#API_CalculateIsolines_ResponseSyntax) ** The actual point on the road network used for calculations, which may differ from the requested destination if `Destination` was not directly on a road. Type: Array of doubles Array Members: Fixed number of 2 items. ** [SnappedOrigin](#API_CalculateIsolines_ResponseSyntax) ** The actual point on the road network used for calculations, which may differ from the requested origin if `Origin` was not directly on a road. Type: Array of doubles Array Members: Fixed number of 2 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You don't have sufficient access to perform this action. HTTP Status Code: 403 ** InternalServerException ** The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ** ThrottlingException ** The request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the constraints specified by an AWS service. ** FieldList ** The field where the invalid entry was detected. ** Reason ** A message with the reason for the validation exception error. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/geo-routes-2020-11-19/CalculateIsolines) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/geo-routes-2020-11-19/CalculateIsolines) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/geo-routes-2020-11-19/CalculateIsolines) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/geo-routes-2020-11-19/CalculateIsolines) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/geo-routes-2020-11-19/CalculateIsolines) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/geo-routes-2020-11-19/CalculateIsolines) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/geo-routes-2020-11-19/CalculateIsolines) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/geo-routes-2020-11-19/CalculateIsolines) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/geo-routes-2020-11-19/CalculateIsolines) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/geo-routes-2020-11-19/CalculateIsolines) # CalculateRouteMatrix Use `CalculateRouteMatrix` to compute results for all pairs of Origins to Destinations. Each row corresponds to one entry in Origins. Each entry in the row corresponds to the route from that entry in Origins to an entry in Destinations positions. For more information, see [Calculate route matrix](https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html) in the *Amazon Location Service Developer Guide*. ## Request Syntax ``` POST /route-matrix?key=Key HTTP/1.1 Content-type: application/json { "Allow": { "Hot": boolean, "Hov": boolean }, "Avoid": { "Areas": [ { "Geometry": { "BoundingBox": [ number ], "Polygon": [ [ [ number ] ] ], "PolylinePolygon": [ "string" ] } } ], "CarShuttleTrains": boolean, "ControlledAccessHighways": boolean, "DirtRoads": boolean, "Ferries": boolean, "TollRoads": boolean, "TollTransponders": boolean, "TruckRoadTypes": [ "string" ], "Tunnels": boolean, "UTurns": boolean, "ZoneCategories": [ { "Category": "string" } ] }, "DepartNow": boolean, "DepartureTime": "string", "Destinations": [ { "Options": { "AvoidActionsForDistance": number, "Heading": number, "Matching": { "NameHint": "string", "OnRoadThreshold": number, "Radius": number, "Strategy": "string" }, "SideOfStreet": { "Position": [ number ], "UseWith": "string" } }, "Position": [ number ] } ], "Exclude": { "Countries": [ "string" ] }, "OptimizeRoutingFor": "string", "Origins": [ { "Options": { "AvoidActionsForDistance": number, "Heading": number, "Matching": { "NameHint": "string", "OnRoadThreshold": number, "Radius": number, "Strategy": "string" }, "SideOfStreet": { "Position": [ number ], "UseWith": "string" } }, "Position": [ number ] } ], "RoutingBoundary": { "Geometry": { "AutoCircle": { "Margin": number, "MaxRadius": number }, "BoundingBox": [ number ], "Circle": { "Center": [ number ], "Radius": number }, "Polygon": [ [ [ number ] ] ] }, "Unbounded": boolean }, "Traffic": { "FlowEventThresholdOverride": number, "Usage": "string" }, "TravelMode": "string", "TravelModeOptions": { "Car": { "LicensePlate": { "LastCharacter": "string" }, "MaxSpeed": number, "Occupancy": number }, "Scooter": { "LicensePlate": { "LastCharacter": "string" }, "MaxSpeed": number, "Occupancy": number }, "Truck": { "AxleCount": number, "GrossWeight": number, "HazardousCargos": [ "string" ], "Height": number, "KpraLength": number, "Length": number, "LicensePlate": { "LastCharacter": "string" }, "MaxSpeed": number, "Occupancy": number, "PayloadCapacity": number, "Trailer": { "TrailerCount": number }, "TruckType": "string", "TunnelRestrictionCode": "string", "WeightPerAxle": number, "WeightPerAxleGroup": { "Quad": number, "Quint": number, "Single": number, "Tandem": number, "Triple": number }, "Width": number } } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [Key](#API_CalculateRouteMatrix_RequestSyntax) ** Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request. Length Constraints: Minimum length of 0. Maximum length of 1000. ## Request Body The request accepts the following data in JSON format. ** [Allow](#API_CalculateRouteMatrix_RequestSyntax) ** Features that are allowed while calculating a route. Type: [RouteMatrixAllowOptions](API_RouteMatrixAllowOptions.md) object Required: No ** [Avoid](#API_CalculateRouteMatrix_RequestSyntax) ** Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation. For [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers, `ap-southeast-1` and `ap-southeast-5` regions support only `TollRoads`, `Ferries`, and `ControlledAccessHighways`. Type: [RouteMatrixAvoidanceOptions](API_RouteMatrixAvoidanceOptions.md) object Required: No ** [DepartNow](#API_CalculateRouteMatrix_RequestSyntax) ** Uses the current time as the time of departure. Type: Boolean Required: No ** [DepartureTime](#API_CalculateRouteMatrix_RequestSyntax) ** Time of departure from the origin. Time format:`YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm` Examples: `2020-04-22T17:57:24Z` `2020-04-22T17:57:24+02:00` Type: String Pattern: `([1-2][0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)(\.[0-9]{0,9})?(Z|[+-]([01][0-9]|2[0-3]):[0-5][0-9])` Required: No ** [Destinations](#API_CalculateRouteMatrix_RequestSyntax) ** List of destinations for the route. Route calculations are billed for each origin and destination pair. If you use a large matrix of origins and destinations, your costs will increase accordingly. For more information, see [Routes pricing](https://docs.aws.amazon.com/location/latest/developerguide/routes-pricing.html) in the *Amazon Location Service Developer Guide*. Type: Array of [RouteMatrixDestination](API_RouteMatrixDestination.md) objects Array Members: Minimum number of 1 item. Required: Yes ** [Exclude](#API_CalculateRouteMatrix_RequestSyntax) ** Features to be strictly excluded while calculating the route. Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. Type: [RouteMatrixExclusionOptions](API_RouteMatrixExclusionOptions.md) object Required: No ** [OptimizeRoutingFor](#API_CalculateRouteMatrix_RequestSyntax) ** Controls the trade-off between finding the shortest travel time (`FastestRoute`) and the shortest distance (`ShortestRoute`) when calculating reachable areas. Default value: `FastestRoute` Type: String Valid Values: `FastestRoute | ShortestRoute` Required: No ** [Origins](#API_CalculateRouteMatrix_RequestSyntax) ** The position for the origin in World Geodetic System (WGS 84) format: [longitude, latitude]. Route calculations are billed for each origin and destination pair. Using a large amount of Origins in a request can lead you to incur unexpected charges. For more information, see [Routes pricing](https://docs.aws.amazon.com/location/latest/developerguide/routes-pricing.html) in the *Amazon Location Service Developer Guide*. Type: Array of [RouteMatrixOrigin](API_RouteMatrixOrigin.md) objects Array Members: Minimum number of 1 item. Required: Yes ** [RoutingBoundary](#API_CalculateRouteMatrix_RequestSyntax) ** Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid. For [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers, `ap-southeast-1` and `ap-southeast-5` regions support only `Unbounded` set to `true`. Default value: `Unbounded set to true` When request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings. Type: [RouteMatrixBoundary](API_RouteMatrixBoundary.md) object Required: No ** [Traffic](#API_CalculateRouteMatrix_RequestSyntax) ** Traffic related options. Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. Type: [RouteMatrixTrafficOptions](API_RouteMatrixTrafficOptions.md) object Required: No ** [TravelMode](#API_CalculateRouteMatrix_RequestSyntax) ** Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. For [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers, `ap-southeast-1` and `ap-southeast-5` regions support only `Car`, `Pedestrian`, and `Scooter`. Default value: `Car` Type: String Valid Values: `Car | Pedestrian | Scooter | Truck` Required: No ** [TravelModeOptions](#API_CalculateRouteMatrix_RequestSyntax) ** Travel mode related options for the provided travel mode. Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. Type: [RouteMatrixTravelModeOptions](API_RouteMatrixTravelModeOptions.md) object Required: No ## Response Syntax ``` HTTP/1.1 200 x-amz-geo-pricing-bucket: PricingBucket Content-type: application/json { "ErrorCount": number, "RouteMatrix": [ [ { "Distance": number, "Duration": number, "Error": "string" } ] ], "RoutingBoundary": { "Geometry": { "AutoCircle": { "Margin": number, "MaxRadius": number }, "BoundingBox": [ number ], "Circle": { "Center": [ number ], "Radius": number }, "Polygon": [ [ [ number ] ] ] }, "Unbounded": boolean } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The response returns the following HTTP headers. ** [PricingBucket](#API_CalculateRouteMatrix_ResponseSyntax) ** The pricing bucket for which the query is charged at. The following data is returned in JSON format by the service. ** [ErrorCount](#API_CalculateRouteMatrix_ResponseSyntax) ** The count of error results in the route matrix. If this number is 0, all routes were calculated successfully. Type: Integer Valid Range: Minimum value of 0. ** [RouteMatrix](#API_CalculateRouteMatrix_ResponseSyntax) ** The calculated route matrix containing the results for all pairs of Origins to Destination positions. Each row corresponds to one entry in Origins. Each entry in the row corresponds to the route from that entry in Origins to an entry in Destination positions. Type: Array of arrays of [RouteMatrixEntry](API_RouteMatrixEntry.md) objects ** [RoutingBoundary](#API_CalculateRouteMatrix_ResponseSyntax) ** Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid. When request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings. Type: [RouteMatrixBoundary](API_RouteMatrixBoundary.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You don't have sufficient access to perform this action. HTTP Status Code: 403 ** InternalServerException ** The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ** ThrottlingException ** The request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the constraints specified by an AWS service. ** FieldList ** The field where the invalid entry was detected. ** Reason ** A message with the reason for the validation exception error. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/geo-routes-2020-11-19/CalculateRouteMatrix) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/geo-routes-2020-11-19/CalculateRouteMatrix) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/geo-routes-2020-11-19/CalculateRouteMatrix) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/geo-routes-2020-11-19/CalculateRouteMatrix) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/geo-routes-2020-11-19/CalculateRouteMatrix) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/geo-routes-2020-11-19/CalculateRouteMatrix) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/geo-routes-2020-11-19/CalculateRouteMatrix) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/geo-routes-2020-11-19/CalculateRouteMatrix) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/geo-routes-2020-11-19/CalculateRouteMatrix) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/geo-routes-2020-11-19/CalculateRouteMatrix) # CalculateRoutes `CalculateRoutes` computes routes given the following required parameters: `Origin` and `Destination`. For more information, see [Calculate routes](https://docs.aws.amazon.com/location/latest/developerguide/calculate-routes.html) in the *Amazon Location Service Developer Guide*. ## Request Syntax ``` POST /routes?key=Key HTTP/1.1 Content-type: application/json { "Allow": { "Hot": boolean, "Hov": boolean }, "ArrivalTime": "string", "Avoid": { "Areas": [ { "Except": [ { "BoundingBox": [ number ], "Corridor": { "LineString": [ [ number ] ], "Radius": number }, "Polygon": [ [ [ number ] ] ], "PolylineCorridor": { "Polyline": "string", "Radius": number }, "PolylinePolygon": [ "string" ] } ], "Geometry": { "BoundingBox": [ number ], "Corridor": { "LineString": [ [ number ] ], "Radius": number }, "Polygon": [ [ [ number ] ] ], "PolylineCorridor": { "Polyline": "string", "Radius": number }, "PolylinePolygon": [ "string" ] } } ], "CarShuttleTrains": boolean, "ControlledAccessHighways": boolean, "DirtRoads": boolean, "Ferries": boolean, "SeasonalClosure": boolean, "TollRoads": boolean, "TollTransponders": boolean, "TruckRoadTypes": [ "string" ], "Tunnels": boolean, "UTurns": boolean, "ZoneCategories": [ { "Category": "string" } ] }, "DepartNow": boolean, "DepartureTime": "string", "Destination": [ number ], "DestinationOptions": { "AvoidActionsForDistance": number, "AvoidUTurns": boolean, "Heading": number, "Matching": { "NameHint": "string", "OnRoadThreshold": number, "Radius": number, "Strategy": "string" }, "SideOfStreet": { "Position": [ number ], "UseWith": "string" }, "StopDuration": number }, "Driver": { "Schedule": [ { "DriveDuration": number, "RestDuration": number } ] }, "Exclude": { "Countries": [ "string" ] }, "InstructionsMeasurementSystem": "string", "Languages": [ "string" ], "LegAdditionalFeatures": [ "string" ], "LegGeometryFormat": "string", "MaxAlternatives": number, "OptimizeRoutingFor": "string", "Origin": [ number ], "OriginOptions": { "AvoidActionsForDistance": number, "AvoidUTurns": boolean, "Heading": number, "Matching": { "NameHint": "string", "OnRoadThreshold": number, "Radius": number, "Strategy": "string" }, "SideOfStreet": { "Position": [ number ], "UseWith": "string" } }, "SpanAdditionalFeatures": [ "string" ], "Tolls": { "AllTransponders": boolean, "AllVignettes": boolean, "Currency": "string", "EmissionType": { "Co2EmissionClass": "string", "Type": "string" }, "VehicleCategory": "string" }, "Traffic": { "FlowEventThresholdOverride": number, "Usage": "string" }, "TravelModeOptions": { "Car": { "EngineType": "string", "LicensePlate": { "LastCharacter": "string" }, "MaxSpeed": number, "Occupancy": number }, "Pedestrian": { "Speed": number }, "Scooter": { "EngineType": "string", "LicensePlate": { "LastCharacter": "string" }, "MaxSpeed": number, "Occupancy": number }, "Truck": { "AxleCount": number, "EngineType": "string", "GrossWeight": number, "HazardousCargos": [ "string" ], "Height": number, "HeightAboveFirstAxle": number, "KpraLength": number, "Length": number, "LicensePlate": { "LastCharacter": "string" }, "MaxSpeed": number, "Occupancy": number, "PayloadCapacity": number, "TireCount": number, "Trailer": { "AxleCount": number, "TrailerCount": number }, "TruckType": "string", "TunnelRestrictionCode": "string", "WeightPerAxle": number, "WeightPerAxleGroup": { "Quad": number, "Quint": number, "Single": number, "Tandem": number, "Triple": number }, "Width": number } }, "TravelStepType": "string", "Waypoints": [ { "AvoidActionsForDistance": number, "AvoidUTurns": boolean, "Heading": number, "Matching": { "NameHint": "string", "OnRoadThreshold": number, "Radius": number, "Strategy": "string" }, "PassThrough": boolean, "Position": [ number ], "SideOfStreet": { "Position": [ number ], "UseWith": "string" }, "StopDuration": number } ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [Key](#API_CalculateRoutes_RequestSyntax) ** Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request. Length Constraints: Minimum length of 0. Maximum length of 1000. ## Request Body The request accepts the following data in JSON format. ** [Allow](#API_CalculateRoutes_RequestSyntax) ** Features that are allowed while calculating a route. Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. Type: [RouteAllowOptions](API_RouteAllowOptions.md) object Required: No ** [ArrivalTime](#API_CalculateRoutes_RequestSyntax) ** Time of arrival at the destination. Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. Time format:`YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm` Examples: `2020-04-22T17:57:24Z` `2020-04-22T17:57:24+02:00` Type: String Pattern: `([1-2][0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)(\.[0-9]{0,9})?(Z|[+-]([01][0-9]|2[0-3]):[0-5][0-9])` Required: No ** [Avoid](#API_CalculateRoutes_RequestSyntax) ** Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation. For [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers, `ap-southeast-1` and `ap-southeast-5` regions support only `ControlledAccessHighways`, `Ferries`, and `TollRoads` Type: [RouteAvoidanceOptions](API_RouteAvoidanceOptions.md) object Required: No ** [DepartNow](#API_CalculateRoutes_RequestSyntax) ** Uses the current time as the time of departure. Type: Boolean Required: No ** [DepartureTime](#API_CalculateRoutes_RequestSyntax) ** Time of departure from the origin. Time format:`YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm` Examples: `2020-04-22T17:57:24Z` `2020-04-22T17:57:24+02:00` Type: String Pattern: `([1-2][0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)(\.[0-9]{0,9})?(Z|[+-]([01][0-9]|2[0-3]):[0-5][0-9])` Required: No ** [Destination](#API_CalculateRoutes_RequestSyntax) ** The final position for the route. In the World Geodetic System (WGS 84) format: `[longitude, latitude]`. Type: Array of doubles Array Members: Fixed number of 2 items. Required: Yes ** [DestinationOptions](#API_CalculateRoutes_RequestSyntax) ** Destination related options. Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. Type: [RouteDestinationOptions](API_RouteDestinationOptions.md) object Required: No ** [Driver](#API_CalculateRoutes_RequestSyntax) ** Driver related options. Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. Type: [RouteDriverOptions](API_RouteDriverOptions.md) object Required: No ** [Exclude](#API_CalculateRoutes_RequestSyntax) ** Features to be strictly excluded while calculating the route. Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. Type: [RouteExclusionOptions](API_RouteExclusionOptions.md) object Required: No ** [InstructionsMeasurementSystem](#API_CalculateRoutes_RequestSyntax) ** Measurement system to be used for instructions within steps in the response. Type: String Valid Values: `Metric | Imperial` Required: No ** [Languages](#API_CalculateRoutes_RequestSyntax) ** List of languages for instructions within steps in the response. Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. Instructions in the requested language are returned only if they are available. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 10 items. Length Constraints: Minimum length of 2. Maximum length of 35. Required: No ** [LegAdditionalFeatures](#API_CalculateRoutes_RequestSyntax) ** A list of optional additional parameters such as timezone that can be requested for each result. For [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers, `ap-southeast-1` and `ap-southeast-5` regions support only `PassThroughWaypoints`, `Summary`, and `TravelStepInstructions` + `Elevation`: Retrieves the elevation information for each location. + `Incidents`: Provides information on traffic incidents along the route. + `PassThroughWaypoints`: Indicates waypoints that are passed through without stopping. + `Summary`: Returns a summary of the route, including distance and duration. + `Tolls`: Supplies toll cost information along the route. + `TravelStepInstructions`: Provides step-by-step instructions for travel along the route. + `TruckRoadTypes`: Returns information about road types suitable for trucks. + `TypicalDuration`: Gives typical travel duration based on historical data. + `Zones`: Specifies the time zone information for each waypoint. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 9 items. Valid Values: `Elevation | Incidents | PassThroughWaypoints | Summary | Tolls | TravelStepInstructions | TruckRoadTypes | TypicalDuration | Zones | Bookings | IntermediateStops | NextDepartures` Required: No ** [LegGeometryFormat](#API_CalculateRoutes_RequestSyntax) ** Specifies the format of the geometry returned for each leg of the route. You can choose between two different geometry encoding formats. `FlexiblePolyline`: A compact and precise encoding format for the leg geometry. For more information on the format, see the GitHub repository for [https://github.com/aws-geospatial/polyline](https://github.com/aws-geospatial/polyline). `Simple`: A less compact encoding, which is easier to decode but may be less precise and result in larger payloads. Type: String Valid Values: `FlexiblePolyline | Simple` Required: No ** [MaxAlternatives](#API_CalculateRoutes_RequestSyntax) ** Maximum number of alternative routes to be provided in the response, if available. For [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers, `ap-southeast-1` and `ap-southeast-5` regions support only up to 3 alternative routes. Type: Integer Valid Range: Minimum value of 0. Maximum value of 5. Required: No ** [OptimizeRoutingFor](#API_CalculateRoutes_RequestSyntax) ** Controls the trade-off between achieving the shortest travel time (`FastestRoute`) and achieving the shortest physical distance ((`ShortestRoute`) when calculating each route in the matrix. Default value: `FastestRoute` Type: String Valid Values: `FastestRoute | ShortestRoute` Required: No ** [Origin](#API_CalculateRoutes_RequestSyntax) ** The start position for the route in World Geodetic System (WGS 84) format: [longitude, latitude]. Type: Array of doubles Array Members: Fixed number of 2 items. Required: Yes ** [OriginOptions](#API_CalculateRoutes_RequestSyntax) ** Specifies how the origin point should be matched to the road network and any routing constraints that apply when the traveler is departing the origin. Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. Type: [RouteOriginOptions](API_RouteOriginOptions.md) object Required: No ** [SpanAdditionalFeatures](#API_CalculateRoutes_RequestSyntax) ** A list of optional features such as `SpeedLimit` that can be requested for a Span. A span is a section of a Leg for which the requested features have the same values. Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 24 items. Valid Values: `BestCaseDuration | CarAccess | Country | Distance | Duration | DynamicSpeed | FunctionalClassification | Gates | Incidents | Names | Notices | PedestrianAccess | RailwayCrossings | Region | RoadAttributes | RouteNumbers | ScooterAccess | SpeedLimit | TollSystems | TruckAccess | TruckRoadTypes | TypicalDuration | Zones | Consumption` Required: No ** [Tolls](#API_CalculateRoutes_RequestSyntax) ** Toll related options. Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. Type: [RouteTollOptions](API_RouteTollOptions.md) object Required: No ** [Traffic](#API_CalculateRoutes_RequestSyntax) ** Traffic related options. Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. Type: [RouteTrafficOptions](API_RouteTrafficOptions.md) object Required: No ** [TravelModeOptions](#API_CalculateRoutes_RequestSyntax) ** Travel mode related options for the provided travel mode. For [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers, `ap-southeast-1` and `ap-southeast-5` regions support only `Car` and `Pedestrian` travel mode options. Type: [RouteTravelModeOptions](API_RouteTravelModeOptions.md) object Required: No ** [TravelStepType](#API_CalculateRoutes_RequestSyntax) ** Type of step returned by the response. `Default` provides basic steps intended for web based applications. `TurnByTurn` provides detailed instructions with more granularity intended for a turn based navigation system. For [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers, `ap-southeast-1` and `ap-southeast-5` regions `Default` does not return any steps. Type: String Valid Values: `Default | TurnByTurn` Required: No ** [Waypoints](#API_CalculateRoutes_RequestSyntax) ** List of waypoints between the Origin and Destination. For [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers, `ap-southeast-1` and `ap-southeast-5` regions max length is `100`. Max length: `23` Type: Array of [RouteWaypoint](API_RouteWaypoint.md) objects Required: No ## Response Syntax ``` HTTP/1.1 200 x-amz-geo-pricing-bucket: PricingBucket Content-type: application/json { "LegGeometryFormat": "string", "Notices": [ { "Impact": "string" } ], "Routes": [ { "Legs": [ { "FerryLegDetails": { "AfterTravelSteps": [ { "Duration": number, "Instruction": "string", "Type": "string" } ], "Arrival": { "Place": { "Name": "string", "OriginalPosition": [ number ], "Position": [ number ], "WaypointIndex": number }, "Time": "string" }, "BeforeTravelSteps": [ { "Duration": number, "Instruction": "string", "Type": "string" } ], "Departure": { "Place": { "Name": "string", "OriginalPosition": [ number ], "Position": [ number ], "WaypointIndex": number }, "Time": "string" }, "Notices": [ { "Code": "string", "Impact": "string" } ], "PassThroughWaypoints": [ { "GeometryOffset": number, "Place": { "OriginalPosition": [ number ], "Position": [ number ], "WaypointIndex": number } } ], "RouteName": "string", "Spans": [ { "Country": "string", "Distance": number, "Duration": number, "GeometryOffset": number, "Names": [ { "Language": "string", "Value": "string" } ], "Region": "string" } ], "Summary": { "Overview": { "Distance": number, "Duration": number }, "TravelOnly": { "Duration": number } }, "TravelSteps": [ { "Distance": number, "Duration": number, "GeometryOffset": number, "Instruction": "string", "Type": "string" } ] }, "Geometry": { "LineString": [ [ number ] ], "Polyline": "string" }, "Language": "string", "PedestrianLegDetails": { "Arrival": { "Place": { "Name": "string", "OriginalPosition": [ number ], "Position": [ number ], "SideOfStreet": "string", "WaypointIndex": number }, "Time": "string" }, "Departure": { "Place": { "Name": "string", "OriginalPosition": [ number ], "Position": [ number ], "SideOfStreet": "string", "WaypointIndex": number }, "Time": "string" }, "Notices": [ { "Code": "string", "Impact": "string" } ], "PassThroughWaypoints": [ { "GeometryOffset": number, "Place": { "OriginalPosition": [ number ], "Position": [ number ], "WaypointIndex": number } } ], "Spans": [ { "BestCaseDuration": number, "Country": "string", "Distance": number, "Duration": number, "DynamicSpeed": { "BestCaseSpeed": number, "TurnDuration": number, "TypicalSpeed": number }, "FunctionalClassification": number, "GeometryOffset": number, "Incidents": [ number ], "Names": [ { "Language": "string", "Value": "string" } ], "PedestrianAccess": [ "string" ], "Region": "string", "RoadAttributes": [ "string" ], "RouteNumbers": [ { "Direction": "string", "Language": "string", "Value": "string" } ], "SpeedLimit": { "MaxSpeed": number, "Unlimited": boolean }, "TypicalDuration": number } ], "Summary": { "Overview": { "Distance": number, "Duration": number }, "TravelOnly": { "Duration": number } }, "TravelSteps": [ { "ContinueStepDetails": { "Intersection": [ { "Language": "string", "Value": "string" } ] }, "CurrentRoad": { "RoadName": [ { "Language": "string", "Value": "string" } ], "RouteNumber": [ { "Direction": "string", "Language": "string", "Value": "string" } ], "Towards": [ { "Language": "string", "Value": "string" } ], "Type": "string" }, "Distance": number, "Duration": number, "ExitNumber": [ { "Language": "string", "Value": "string" } ], "GeometryOffset": number, "Instruction": "string", "KeepStepDetails": { "Intersection": [ { "Language": "string", "Value": "string" } ], "SteeringDirection": "string", "TurnAngle": number, "TurnIntensity": "string" }, "NextRoad": { "RoadName": [ { "Language": "string", "Value": "string" } ], "RouteNumber": [ { "Direction": "string", "Language": "string", "Value": "string" } ], "Towards": [ { "Language": "string", "Value": "string" } ], "Type": "string" }, "RoundaboutEnterStepDetails": { "Intersection": [ { "Language": "string", "Value": "string" } ], "SteeringDirection": "string", "TurnAngle": number, "TurnIntensity": "string" }, "RoundaboutExitStepDetails": { "Intersection": [ { "Language": "string", "Value": "string" } ], "RelativeExit": number, "RoundaboutAngle": number, "SteeringDirection": "string" }, "RoundaboutPassStepDetails": { "Intersection": [ { "Language": "string", "Value": "string" } ], "SteeringDirection": "string", "TurnAngle": number, "TurnIntensity": "string" }, "Signpost": { "Labels": [ { "RouteNumber": { "Direction": "string", "Language": "string", "Value": "string" }, "Text": { "Language": "string", "Value": "string" } } ] }, "TurnStepDetails": { "Intersection": [ { "Language": "string", "Value": "string" } ], "SteeringDirection": "string", "TurnAngle": number, "TurnIntensity": "string" } } ] }, "VehicleLegDetails": { "Arrival": { "Place": { "Name": "string", "OriginalPosition": [ number ], "Position": [ number ], "SideOfStreet": "string", "WaypointIndex": number }, "Time": "string" }, "Departure": { "Place": { "Name": "string", "OriginalPosition": [ number ], "Position": [ number ], "SideOfStreet": "string", "WaypointIndex": number }, "Time": "string" }, "Incidents": [ { "Description": "string", "EndTime": "string", "Severity": "string", "StartTime": "string", "Type": "string" } ], "Notices": [ { "Code": "string", "Details": [ { "Title": "string", "ViolatedConstraints": { "AllHazardsRestricted": boolean, "AxleCount": { "Max": number, "Min": number }, "HazardousCargos": [ "string" ], "MaxHeight": number, "MaxKpraLength": number, "MaxLength": number, "MaxPayloadCapacity": number, "MaxWeight": { "Type": "string", "Value": number }, "MaxWeightPerAxle": number, "MaxWeightPerAxleGroup": { "Quad": number, "Quint": number, "Single": number, "Tandem": number, "Triple": number }, "MaxWidth": number, "Occupancy": { "Max": number, "Min": number }, "RestrictedTimes": "string", "TimeDependent": boolean, "TrailerCount": { "Max": number, "Min": number }, "TravelMode": boolean, "TruckRoadType": "string", "TruckType": "string", "TunnelRestrictionCode": "string" } } ], "Impact": "string" } ], "PassThroughWaypoints": [ { "GeometryOffset": number, "Place": { "OriginalPosition": [ number ], "Position": [ number ], "WaypointIndex": number } } ], "Spans": [ { "BestCaseDuration": number, "CarAccess": [ "string" ], "Country": "string", "Distance": number, "Duration": number, "DynamicSpeed": { "BestCaseSpeed": number, "TurnDuration": number, "TypicalSpeed": number }, "FunctionalClassification": number, "Gate": "string", "GeometryOffset": number, "Incidents": [ number ], "Names": [ { "Language": "string", "Value": "string" } ], "Notices": [ number ], "RailwayCrossing": "string", "Region": "string", "RoadAttributes": [ "string" ], "RouteNumbers": [ { "Direction": "string", "Language": "string", "Value": "string" } ], "ScooterAccess": [ "string" ], "SpeedLimit": { "MaxSpeed": number, "Unlimited": boolean }, "TollSystems": [ number ], "TruckAccess": [ "string" ], "TruckRoadTypes": [ number ], "TypicalDuration": number, "Zones": [ number ] } ], "Summary": { "Overview": { "BestCaseDuration": number, "Distance": number, "Duration": number, "TypicalDuration": number }, "TravelOnly": { "BestCaseDuration": number, "Duration": number, "TypicalDuration": number } }, "Tolls": [ { "Country": "string", "PaymentSites": [ { "Name": "string", "Position": [ number ] } ], "Rates": [ { "ApplicableTimes": "string", "ConvertedPrice": { "Currency": "string", "Estimate": boolean, "PerDuration": number, "Range": boolean, "RangeValue": { "Max": number, "Min": number }, "Value": number }, "Id": "string", "LocalPrice": { "Currency": "string", "Estimate": boolean, "PerDuration": number, "Range": boolean, "RangeValue": { "Max": number, "Min": number }, "Value": number }, "Name": "string", "Pass": { "IncludesReturnTrip": boolean, "SeniorPass": boolean, "TransferCount": number, "TripCount": number, "ValidityPeriod": { "Period": "string", "PeriodCount": number } }, "PaymentMethods": [ "string" ], "Transponders": [ { "SystemName": "string" } ] } ], "Systems": [ number ] } ], "TollSystems": [ { "Name": "string" } ], "TravelSteps": [ { "ContinueHighwayStepDetails": { "Intersection": [ { "Language": "string", "Value": "string" } ], "SteeringDirection": "string", "TurnAngle": number, "TurnIntensity": "string" }, "ContinueStepDetails": { "Intersection": [ { "Language": "string", "Value": "string" } ] }, "CurrentRoad": { "RoadName": [ { "Language": "string", "Value": "string" } ], "RouteNumber": [ { "Direction": "string", "Language": "string", "Value": "string" } ], "Towards": [ { "Language": "string", "Value": "string" } ], "Type": "string" }, "Distance": number, "Duration": number, "EnterHighwayStepDetails": { "Intersection": [ { "Language": "string", "Value": "string" } ], "SteeringDirection": "string", "TurnAngle": number, "TurnIntensity": "string" }, "ExitNumber": [ { "Language": "string", "Value": "string" } ], "ExitStepDetails": { "Intersection": [ { "Language": "string", "Value": "string" } ], "RelativeExit": number, "SteeringDirection": "string", "TurnAngle": number, "TurnIntensity": "string" }, "GeometryOffset": number, "Instruction": "string", "KeepStepDetails": { "Intersection": [ { "Language": "string", "Value": "string" } ], "SteeringDirection": "string", "TurnAngle": number, "TurnIntensity": "string" }, "NextRoad": { "RoadName": [ { "Language": "string", "Value": "string" } ], "RouteNumber": [ { "Direction": "string", "Language": "string", "Value": "string" } ], "Towards": [ { "Language": "string", "Value": "string" } ], "Type": "string" }, "RampStepDetails": { "Intersection": [ { "Language": "string", "Value": "string" } ], "SteeringDirection": "string", "TurnAngle": number, "TurnIntensity": "string" }, "RoundaboutEnterStepDetails": { "Intersection": [ { "Language": "string", "Value": "string" } ], "SteeringDirection": "string", "TurnAngle": number, "TurnIntensity": "string" }, "RoundaboutExitStepDetails": { "Intersection": [ { "Language": "string", "Value": "string" } ], "RelativeExit": number, "RoundaboutAngle": number, "SteeringDirection": "string" }, "RoundaboutPassStepDetails": { "Intersection": [ { "Language": "string", "Value": "string" } ], "SteeringDirection": "string", "TurnAngle": number, "TurnIntensity": "string" }, "Signpost": { "Labels": [ { "RouteNumber": { "Direction": "string", "Language": "string", "Value": "string" }, "Text": { "Language": "string", "Value": "string" } } ] }, "TurnStepDetails": { "Intersection": [ { "Language": "string", "Value": "string" } ], "SteeringDirection": "string", "TurnAngle": number, "TurnIntensity": "string" }, "Type": "string", "UTurnStepDetails": { "Intersection": [ { "Language": "string", "Value": "string" } ], "SteeringDirection": "string", "TurnAngle": number, "TurnIntensity": "string" } } ], "TruckRoadTypes": [ "string" ], "Zones": [ { "Category": "string", "Name": "string" } ] } } ], "MajorRoadLabels": [ { "RoadName": { "Language": "string", "Value": "string" }, "RouteNumber": { "Direction": "string", "Language": "string", "Value": "string" } } ], "Summary": { "Distance": number, "Duration": number, "Tolls": { "Total": { "Currency": "string", "Estimate": boolean, "Range": boolean, "RangeValue": { "Max": number, "Min": number }, "Value": number } } } } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The response returns the following HTTP headers. ** [PricingBucket](#API_CalculateRoutes_ResponseSyntax) ** The pricing bucket for which the query is charged at. The following data is returned in JSON format by the service. ** [LegGeometryFormat](#API_CalculateRoutes_ResponseSyntax) ** Specifies the format of the geometry returned for each leg of the route. Type: String Valid Values: `FlexiblePolyline | Simple` ** [Notices](#API_CalculateRoutes_ResponseSyntax) ** Notices are additional information returned that indicate issues that occurred during route calculation. Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. Type: Array of [RouteResponseNotice](API_RouteResponseNotice.md) objects ** [Routes](#API_CalculateRoutes_ResponseSyntax) ** The path from the origin to the destination. Type: Array of [Route](API_Route.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You don't have sufficient access to perform this action. HTTP Status Code: 403 ** InternalServerException ** The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ** ThrottlingException ** The request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the constraints specified by an AWS service. ** FieldList ** The field where the invalid entry was detected. ** Reason ** A message with the reason for the validation exception error. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/geo-routes-2020-11-19/CalculateRoutes) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/geo-routes-2020-11-19/CalculateRoutes) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/geo-routes-2020-11-19/CalculateRoutes) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/geo-routes-2020-11-19/CalculateRoutes) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/geo-routes-2020-11-19/CalculateRoutes) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/geo-routes-2020-11-19/CalculateRoutes) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/geo-routes-2020-11-19/CalculateRoutes) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/geo-routes-2020-11-19/CalculateRoutes) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/geo-routes-2020-11-19/CalculateRoutes) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/geo-routes-2020-11-19/CalculateRoutes) # OptimizeWaypoints `OptimizeWaypoints` calculates the optimal order to travel between a set of waypoints to minimize either the travel time or the distance travelled during the journey, based on road network restrictions and the traffic pattern data. For more information, see [Optimize waypoints](https://docs.aws.amazon.com/location/latest/developerguide/actions-optimize-waypoints.html) in the *Amazon Location Service Developer Guide*. ## Request Syntax ``` POST /optimize-waypoints?key=Key HTTP/1.1 Content-type: application/json { "Avoid": { "Areas": [ { "Geometry": { "BoundingBox": [ number ] } } ], "CarShuttleTrains": boolean, "ControlledAccessHighways": boolean, "DirtRoads": boolean, "Ferries": boolean, "TollRoads": boolean, "Tunnels": boolean, "UTurns": boolean }, "Clustering": { "Algorithm": "string", "DrivingDistanceOptions": { "DrivingDistance": number } }, "DepartureTime": "string", "Destination": [ number ], "DestinationOptions": { "AccessHours": { "From": { "DayOfWeek": "string", "TimeOfDay": "string" }, "To": { "DayOfWeek": "string", "TimeOfDay": "string" } }, "AppointmentTime": "string", "Heading": number, "Id": "string", "ServiceDuration": number, "SideOfStreet": { "Position": [ number ], "UseWith": "string" } }, "Driver": { "RestCycles": { "LongCycle": { "RestDuration": number, "WorkDuration": number }, "ShortCycle": { "RestDuration": number, "WorkDuration": number } }, "RestProfile": { "Profile": "string" }, "TreatServiceTimeAs": "string" }, "Exclude": { "Countries": [ "string" ] }, "OptimizeSequencingFor": "string", "Origin": [ number ], "OriginOptions": { "Id": "string" }, "Traffic": { "Usage": "string" }, "TravelMode": "string", "TravelModeOptions": { "Pedestrian": { "Speed": number }, "Truck": { "GrossWeight": number, "HazardousCargos": [ "string" ], "Height": number, "Length": number, "Trailer": { "TrailerCount": number }, "TruckType": "string", "TunnelRestrictionCode": "string", "WeightPerAxle": number, "Width": number } }, "Waypoints": [ { "AccessHours": { "From": { "DayOfWeek": "string", "TimeOfDay": "string" }, "To": { "DayOfWeek": "string", "TimeOfDay": "string" } }, "AppointmentTime": "string", "Before": [ number ], "Heading": number, "Id": "string", "Position": [ number ], "ServiceDuration": number, "SideOfStreet": { "Position": [ number ], "UseWith": "string" } } ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [Key](#API_OptimizeWaypoints_RequestSyntax) ** Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request. Length Constraints: Minimum length of 0. Maximum length of 1000. ## Request Body The request accepts the following data in JSON format. ** [Avoid](#API_OptimizeWaypoints_RequestSyntax) ** Features that are avoided. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, this setting is ignored. Type: [WaypointOptimizationAvoidanceOptions](API_WaypointOptimizationAvoidanceOptions.md) object Required: No ** [Clustering](#API_OptimizeWaypoints_RequestSyntax) ** Clustering allows you to specify how nearby waypoints can be clustered to improve the optimized sequence. Type: [WaypointOptimizationClusteringOptions](API_WaypointOptimizationClusteringOptions.md) object Required: No ** [DepartureTime](#API_OptimizeWaypoints_RequestSyntax) ** Departure time from the waypoint. Time format:`YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm` Examples: `2020-04-22T17:57:24Z` `2020-04-22T17:57:24+02:00` Type: String Pattern: `([1-2][0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)(\.[0-9]{0,9})?(Z|[+-]([01][0-9]|2[0-3]):[0-5][0-9])` Required: No ** [Destination](#API_OptimizeWaypoints_RequestSyntax) ** The final position for the route in the World Geodetic System (WGS 84) format: `[longitude, latitude]`. Type: Array of doubles Array Members: Fixed number of 2 items. Required: No ** [DestinationOptions](#API_OptimizeWaypoints_RequestSyntax) ** Destination related options. Type: [WaypointOptimizationDestinationOptions](API_WaypointOptimizationDestinationOptions.md) object Required: No ** [Driver](#API_OptimizeWaypoints_RequestSyntax) ** Driver related options. Type: [WaypointOptimizationDriverOptions](API_WaypointOptimizationDriverOptions.md) object Required: No ** [Exclude](#API_OptimizeWaypoints_RequestSyntax) ** Features to be strictly excluded while calculating the route. Type: [WaypointOptimizationExclusionOptions](API_WaypointOptimizationExclusionOptions.md) object Required: No ** [OptimizeSequencingFor](#API_OptimizeWaypoints_RequestSyntax) ** Specifies the optimization criteria for the calculated sequence. Default value: `FastestRoute`. Type: String Valid Values: `FastestRoute | ShortestRoute` Required: No ** [Origin](#API_OptimizeWaypoints_RequestSyntax) ** The start position for the route in World Geodetic System (WGS 84) format: [longitude, latitude]. Type: Array of doubles Array Members: Fixed number of 2 items. Required: Yes ** [OriginOptions](#API_OptimizeWaypoints_RequestSyntax) ** Origin related options. Type: [WaypointOptimizationOriginOptions](API_WaypointOptimizationOriginOptions.md) object Required: No ** [Traffic](#API_OptimizeWaypoints_RequestSyntax) ** Traffic-related options. Type: [WaypointOptimizationTrafficOptions](API_WaypointOptimizationTrafficOptions.md) object Required: No ** [TravelMode](#API_OptimizeWaypoints_RequestSyntax) ** Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. Default value: `Car` Type: String Valid Values: `Car | Pedestrian | Scooter | Truck` Required: No ** [TravelModeOptions](#API_OptimizeWaypoints_RequestSyntax) ** Travel mode related options for the provided travel mode. Type: [WaypointOptimizationTravelModeOptions](API_WaypointOptimizationTravelModeOptions.md) object Required: No ** [Waypoints](#API_OptimizeWaypoints_RequestSyntax) ** List of waypoints between the `Origin` and `Destination`. Type: Array of [WaypointOptimizationWaypoint](API_WaypointOptimizationWaypoint.md) objects Required: No ## Response Syntax ``` HTTP/1.1 200 x-amz-geo-pricing-bucket: PricingBucket Content-type: application/json { "Connections": [ { "Distance": number, "From": "string", "RestDuration": number, "To": "string", "TravelDuration": number, "WaitDuration": number } ], "Distance": number, "Duration": number, "ImpedingWaypoints": [ { "FailedConstraints": [ { "Constraint": "string", "Reason": "string" } ], "Id": "string", "Position": [ number ] } ], "OptimizedWaypoints": [ { "ArrivalTime": "string", "ClusterIndex": number, "DepartureTime": "string", "Id": "string", "Position": [ number ] } ], "TimeBreakdown": { "RestDuration": number, "ServiceDuration": number, "TravelDuration": number, "WaitDuration": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The response returns the following HTTP headers. ** [PricingBucket](#API_OptimizeWaypoints_ResponseSyntax) ** The pricing bucket for which the query is charged at. The following data is returned in JSON format by the service. ** [Connections](#API_OptimizeWaypoints_ResponseSyntax) ** Details about the connection from one waypoint to the next, within the optimized sequence. Type: Array of [WaypointOptimizationConnection](API_WaypointOptimizationConnection.md) objects ** [Distance](#API_OptimizeWaypoints_ResponseSyntax) ** Overall distance to travel the whole sequence. Type: Long Valid Range: Minimum value of 0. Maximum value of 4294967295. ** [Duration](#API_OptimizeWaypoints_ResponseSyntax) ** Overall duration to travel the whole sequence. **Unit**: `seconds` Type: Long Valid Range: Minimum value of 0. Maximum value of 4294967295. ** [ImpedingWaypoints](#API_OptimizeWaypoints_ResponseSyntax) ** Returns waypoints that caused the optimization problem to fail, and the constraints that were unsatisfied leading to the failure. Type: Array of [WaypointOptimizationImpedingWaypoint](API_WaypointOptimizationImpedingWaypoint.md) objects ** [OptimizedWaypoints](#API_OptimizeWaypoints_ResponseSyntax) ** Waypoints in the order of the optimized sequence. Type: Array of [WaypointOptimizationOptimizedWaypoint](API_WaypointOptimizationOptimizedWaypoint.md) objects ** [TimeBreakdown](#API_OptimizeWaypoints_ResponseSyntax) ** Time breakdown for the sequence. Type: [WaypointOptimizationTimeBreakdown](API_WaypointOptimizationTimeBreakdown.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You don't have sufficient access to perform this action. HTTP Status Code: 403 ** InternalServerException ** The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ** ThrottlingException ** The request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the constraints specified by an AWS service. ** FieldList ** The field where the invalid entry was detected. ** Reason ** A message with the reason for the validation exception error. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/geo-routes-2020-11-19/OptimizeWaypoints) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/geo-routes-2020-11-19/OptimizeWaypoints) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/geo-routes-2020-11-19/OptimizeWaypoints) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/geo-routes-2020-11-19/OptimizeWaypoints) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/geo-routes-2020-11-19/OptimizeWaypoints) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/geo-routes-2020-11-19/OptimizeWaypoints) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/geo-routes-2020-11-19/OptimizeWaypoints) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/geo-routes-2020-11-19/OptimizeWaypoints) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/geo-routes-2020-11-19/OptimizeWaypoints) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/geo-routes-2020-11-19/OptimizeWaypoints) # SnapToRoads `SnapToRoads` matches GPS trace to roads most likely traveled on. For more information, see [Snap to Roads](https://docs.aws.amazon.com/location/latest/developerguide/snap-to-roads.html) in the *Amazon Location Service Developer Guide*. ## Request Syntax ``` POST /snap-to-roads?key=Key HTTP/1.1 Content-type: application/json { "SnappedGeometryFormat": "string", "SnapRadius": number, "TracePoints": [ { "Heading": number, "Position": [ number ], "Speed": number, "Timestamp": "string" } ], "TravelMode": "string", "TravelModeOptions": { "Truck": { "GrossWeight": number, "HazardousCargos": [ "string" ], "Height": number, "Length": number, "Trailer": { "TrailerCount": number }, "TunnelRestrictionCode": "string", "Width": number } } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [Key](#API_SnapToRoads_RequestSyntax) ** Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request. Length Constraints: Minimum length of 0. Maximum length of 1000. ## Request Body The request accepts the following data in JSON format. ** [SnappedGeometryFormat](#API_SnapToRoads_RequestSyntax) ** Chooses what the returned SnappedGeometry format should be. Default value: `FlexiblePolyline` Type: String Valid Values: `FlexiblePolyline | Simple` Required: No ** [SnapRadius](#API_SnapToRoads_RequestSyntax) ** The radius around the provided tracepoint that is considered for snapping. **Unit**: `meters` Default value: `300` Type: Long Valid Range: Minimum value of 0. Maximum value of 10000. Required: No ** [TracePoints](#API_SnapToRoads_RequestSyntax) ** List of trace points to be snapped onto the road network. Type: Array of [RoadSnapTracePoint](API_RoadSnapTracePoint.md) objects Array Members: Minimum number of 2 items. Maximum number of 5000 items. Required: Yes ** [TravelMode](#API_SnapToRoads_RequestSyntax) ** Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. Default value: `Car` Type: String Valid Values: `Car | Pedestrian | Scooter | Truck` Required: No ** [TravelModeOptions](#API_SnapToRoads_RequestSyntax) ** Travel mode related options for the provided travel mode. Type: [RoadSnapTravelModeOptions](API_RoadSnapTravelModeOptions.md) object Required: No ## Response Syntax ``` HTTP/1.1 200 x-amz-geo-pricing-bucket: PricingBucket Content-type: application/json { "Notices": [ { "Code": "string", "Title": "string", "TracePointIndexes": [ number ] } ], "SnappedGeometry": { "LineString": [ [ number ] ], "Polyline": "string" }, "SnappedGeometryFormat": "string", "SnappedTracePoints": [ { "Confidence": number, "OriginalPosition": [ number ], "SnappedPosition": [ number ] } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The response returns the following HTTP headers. ** [PricingBucket](#API_SnapToRoads_ResponseSyntax) ** The pricing bucket for which the query is charged at. The following data is returned in JSON format by the service. ** [Notices](#API_SnapToRoads_ResponseSyntax) ** Notices are additional information returned that indicate issues that occurred during route calculation. Type: Array of [RoadSnapNotice](API_RoadSnapNotice.md) objects ** [SnappedGeometry](#API_SnapToRoads_ResponseSyntax) ** The interpolated geometry for the snapped route onto the road network. Type: [RoadSnapSnappedGeometry](API_RoadSnapSnappedGeometry.md) object ** [SnappedGeometryFormat](#API_SnapToRoads_ResponseSyntax) ** Specifies the format of the geometry returned for each leg of the route. Type: String Valid Values: `FlexiblePolyline | Simple` ** [SnappedTracePoints](#API_SnapToRoads_ResponseSyntax) ** The trace points snapped onto the road network. Type: Array of [RoadSnapSnappedTracePoint](API_RoadSnapSnappedTracePoint.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You don't have sufficient access to perform this action. HTTP Status Code: 403 ** InternalServerException ** The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ** ThrottlingException ** The request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the constraints specified by an AWS service. ** FieldList ** The field where the invalid entry was detected. ** Reason ** A message with the reason for the validation exception error. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/geo-routes-2020-11-19/SnapToRoads) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/geo-routes-2020-11-19/SnapToRoads) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/geo-routes-2020-11-19/SnapToRoads) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/geo-routes-2020-11-19/SnapToRoads) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/geo-routes-2020-11-19/SnapToRoads) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/geo-routes-2020-11-19/SnapToRoads) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/geo-routes-2020-11-19/SnapToRoads) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/geo-routes-2020-11-19/SnapToRoads) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/geo-routes-2020-11-19/SnapToRoads) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/geo-routes-2020-11-19/SnapToRoads) # Amazon Location Service Maps V2 The following actions are supported by Amazon Location Service Maps V2: + [GetGlyphs](API_geomaps_GetGlyphs.md) + [GetSprites](API_geomaps_GetSprites.md) + [GetStaticMap](API_geomaps_GetStaticMap.md) + [GetStyleDescriptor](API_geomaps_GetStyleDescriptor.md) + [GetTile](API_geomaps_GetTile.md) # GetGlyphs `GetGlyphs` returns the map's glyphs. For more information, see [Style labels with glyphs](https://docs.aws.amazon.com/location/latest/developerguide/styling-labels-with-glyphs.html) in the *Amazon Location Service Developer Guide*. ## Request Syntax ``` GET /glyphs/FontStack/FontUnicodeRange HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [FontStack](#API_geomaps_GetGlyphs_RequestSyntax) ** Name of the `FontStack` to retrieve. Example: `Amazon Ember Bold,Noto Sans Bold`. The supported font stacks are as follows: + Amazon Ember Bold + Amazon Ember Bold Italic + Amazon Ember Bold,Noto Sans Bold + Amazon Ember Bold,Noto Sans Bold,Noto Sans Arabic Bold + Amazon Ember Condensed RC BdItalic + Amazon Ember Condensed RC Bold + Amazon Ember Condensed RC Bold Italic + Amazon Ember Condensed RC Bold,Noto Sans Bold + Amazon Ember Condensed RC Bold,Noto Sans Bold,Noto Sans Arabic Condensed Bold + Amazon Ember Condensed RC Light + Amazon Ember Condensed RC Light Italic + Amazon Ember Condensed RC LtItalic + Amazon Ember Condensed RC Regular + Amazon Ember Condensed RC Regular Italic + Amazon Ember Condensed RC Regular,Noto Sans Regular + Amazon Ember Condensed RC Regular,Noto Sans Regular,Noto Sans Arabic Condensed Regular + Amazon Ember Condensed RC RgItalic + Amazon Ember Condensed RC ThItalic + Amazon Ember Condensed RC Thin + Amazon Ember Condensed RC Thin Italic + Amazon Ember Heavy + Amazon Ember Heavy Italic + Amazon Ember Light + Amazon Ember Light Italic + Amazon Ember Medium + Amazon Ember Medium Italic + Amazon Ember Medium,Noto Sans Medium + Amazon Ember Medium,Noto Sans Medium,Noto Sans Arabic Medium + Amazon Ember Regular + Amazon Ember Regular Italic + Amazon Ember Regular Italic,Noto Sans Italic + Amazon Ember Regular Italic,Noto Sans Italic,Noto Sans Arabic Regular + Amazon Ember Regular,Noto Sans Regular + Amazon Ember Regular,Noto Sans Regular,Noto Sans Arabic Regular + Amazon Ember Thin + Amazon Ember Thin Italic + AmazonEmberCdRC\$1Bd + AmazonEmberCdRC\$1BdIt + AmazonEmberCdRC\$1Lt + AmazonEmberCdRC\$1LtIt + AmazonEmberCdRC\$1Rg + AmazonEmberCdRC\$1RgIt + AmazonEmberCdRC\$1Th + AmazonEmberCdRC\$1ThIt + AmazonEmber\$1Bd + AmazonEmber\$1BdIt + AmazonEmber\$1He + AmazonEmber\$1HeIt + AmazonEmber\$1Lt + AmazonEmber\$1LtIt + AmazonEmber\$1Md + AmazonEmber\$1MdIt + AmazonEmber\$1Rg + AmazonEmber\$1RgIt + AmazonEmber\$1Th + AmazonEmber\$1ThIt + Noto Sans Black + Noto Sans Black Italic + Noto Sans Bold + Noto Sans Bold Italic + Noto Sans Extra Bold + Noto Sans Extra Bold Italic + Noto Sans Extra Light + Noto Sans Extra Light Italic + Noto Sans Italic + Noto Sans Light + Noto Sans Light Italic + Noto Sans Medium + Noto Sans Medium Italic + Noto Sans Regular + Noto Sans Semi Bold + Noto Sans Semi Bold Italic + Noto Sans Thin + Noto Sans Thin Italic + NotoSans-Bold + NotoSans-Italic + NotoSans-Medium + NotoSans-Regular + Open Sans Regular,Arial Unicode MS Regular Length Constraints: Minimum length of 0. Maximum length of 1000. Required: Yes ** [FontUnicodeRange](#API_geomaps_GetGlyphs_RequestSyntax) ** A Unicode range of characters to download glyphs for. This must be aligned to multiples of 256. Example: `0-255.pbf` Length Constraints: Minimum length of 0. Maximum length of 50. Pattern: `[0-9]+-[0-9]+\.pbf` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-Type: ContentType Cache-Control: CacheControl ETag: ETag Blob ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The response returns the following HTTP headers. ** [CacheControl](#API_geomaps_GetGlyphs_ResponseSyntax) ** Header that instructs caching configuration for the client. ** [ContentType](#API_geomaps_GetGlyphs_ResponseSyntax) ** Header that represents the format of the response. The response returns the following as the HTTP body. ** [ETag](#API_geomaps_GetGlyphs_ResponseSyntax) ** The glyph's Etag. The response returns the following as the HTTP body. ** [Blob](#API_geomaps_GetGlyphs_ResponseSyntax) ** The Glyph, as a binary blob. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/geo-maps-2020-11-19/GetGlyphs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/geo-maps-2020-11-19/GetGlyphs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/geo-maps-2020-11-19/GetGlyphs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/geo-maps-2020-11-19/GetGlyphs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/geo-maps-2020-11-19/GetGlyphs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/geo-maps-2020-11-19/GetGlyphs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/geo-maps-2020-11-19/GetGlyphs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/geo-maps-2020-11-19/GetGlyphs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/geo-maps-2020-11-19/GetGlyphs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/geo-maps-2020-11-19/GetGlyphs) # GetSprites `GetSprites` returns the map's sprites. For more information, see [Style iconography with sprites](https://docs.aws.amazon.com/location/latest/developerguide/styling-iconography-with-sprites.html) in the *Amazon Location Service Developer Guide*. ## Request Syntax ``` GET /styles/Style/ColorScheme/Variant/sprites/FileName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [ColorScheme](#API_geomaps_GetSprites_RequestSyntax) ** Sets the color tone for the map sprites, such as dark and light. Example: `Light` Default value: `Light` Valid values for ColorScheme are case sensitive. Valid Values: `Light | Dark` Required: Yes ** [FileName](#API_geomaps_GetSprites_RequestSyntax) ** `Sprites` API: The name of the sprite ﬁle to retrieve, following pattern `sprites(@2x)?\.(png|json)`. Example: `sprites.png` Pattern: `sprites(@2x)?\.(png|json)` Required: Yes ** [Style](#API_geomaps_GetSprites_RequestSyntax) ** Style specifies the desired map style for the `Sprites` APIs. Valid Values: `Standard | Monochrome | Hybrid | Satellite` Required: Yes ** [Variant](#API_geomaps_GetSprites_RequestSyntax) ** Optimizes map styles for specific use case or industry. You can choose allowed variant only with Standard map style. Example: `Default` Valid values for Variant are case sensitive. Valid Values: `Default` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-Type: ContentType Cache-Control: CacheControl ETag: ETag Blob ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The response returns the following HTTP headers. ** [CacheControl](#API_geomaps_GetSprites_ResponseSyntax) ** Header that instructs caching configuration for the client. ** [ContentType](#API_geomaps_GetSprites_ResponseSyntax) ** Header that represents the format of the response. The response returns the following as the HTTP body. ** [ETag](#API_geomaps_GetSprites_ResponseSyntax) ** The sprite's Etag. The response returns the following as the HTTP body. ** [Blob](#API_geomaps_GetSprites_ResponseSyntax) ** The body of the sprite sheet or JSON offset file (image/png or application/json, depending on input). ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/geo-maps-2020-11-19/GetSprites) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/geo-maps-2020-11-19/GetSprites) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/geo-maps-2020-11-19/GetSprites) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/geo-maps-2020-11-19/GetSprites) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/geo-maps-2020-11-19/GetSprites) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/geo-maps-2020-11-19/GetSprites) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/geo-maps-2020-11-19/GetSprites) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/geo-maps-2020-11-19/GetSprites) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/geo-maps-2020-11-19/GetSprites) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/geo-maps-2020-11-19/GetSprites) # GetStaticMap **Note** This operation is not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. `GetStaticMap` provides high-quality static map images with customizable options. You can modify the map's appearance and overlay additional information. It's an ideal solution for applications requiring tailored static map snapshots. For more information, see the following topics in the *Amazon Location Service Developer Guide*: + [Static maps](https://docs.aws.amazon.com/location/latest/developerguide/static-maps.html) + [Customize static maps](https://docs.aws.amazon.com/location/latest/developerguide/customizing-static-maps.html) + [Overlay on the static map](https://docs.aws.amazon.com/location/latest/developerguide/overlaying-static-map.html) ## Request Syntax ``` GET /static/FileName?bounded-positions=BoundedPositions&bounding-box=BoundingBox¢er=Center&color-scheme=ColorScheme&compact-overlay=CompactOverlay&crop-labels=CropLabels&geojson-overlay=GeoJsonOverlay&height=Height&key=Key&label-size=LabelSize&lang=Language&padding=Padding&pois=PointsOfInterests&political-view=PoliticalView&radius=Radius&scale-unit=ScaleBarUnit&style=Style&width=Width&zoom=Zoom HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [BoundedPositions](#API_geomaps_GetStaticMap_RequestSyntax) ** Takes in two or more pair of coordinates in World Geodetic System (WGS 84) format: [longitude, latitude], with each coordinate separated by a comma. The API will generate an image to encompass all of the provided coordinates. Cannot be used with `Zoom` and or `Radius` Example: 97.170451,78.039098,99.045536,27.176178 Length Constraints: Minimum length of 0. Maximum length of 5000. Pattern: `(-?\d{1,3}(\.\d{1,14})?,-?\d{1,2}(\.\d{1,14})?)(,(-?\d{1,3}(\.\d{1,14})?,-?\d{1,2}(\.\d{1,14})?))*` ** [BoundingBox](#API_geomaps_GetStaticMap_RequestSyntax) ** Takes in two pairs of coordinates in World Geodetic System (WGS 84) format: [longitude, latitude], denoting south-westerly and north-easterly edges of the image. The underlying area becomes the view of the image. Example: -123.17075,49.26959,-123.08125,49.31429 Length Constraints: Minimum length of 0. Maximum length of 100. Pattern: `(-?\d{1,3}(\.\d{1,14})?,-?\d{1,2}(\.\d{1,14})?)(,(-?\d{1,3}(\.\d{1,14})?,-?\d{1,2}(\.\d{1,14})?))*` ** [Center](#API_geomaps_GetStaticMap_RequestSyntax) ** Takes in a pair of coordinates in World Geodetic System (WGS 84) format: [longitude, latitude], which becomes the center point of the image. This parameter requires that either zoom or radius is set. Cannot be used with `Zoom` and or `Radius` Example: 49.295,-123.108 Length Constraints: Minimum length of 3. Maximum length of 36. Pattern: `-?\d{1,3}(\.\d{1,14})?,-?\d{1,2}(\.\d{1,14})?` ** [ColorScheme](#API_geomaps_GetStaticMap_RequestSyntax) ** Sets the color tone for the map, such as dark and light. Example: `Light` Default value: `Light` Valid values for `ColorScheme` are case sensitive. Valid Values: `Light | Dark` ** [CompactOverlay](#API_geomaps_GetStaticMap_RequestSyntax) ** Takes in a string to draw geometries on the image. The input is a comma separated format as follows format: `[Lon, Lat]` Example: `line:-122.407653,37.798557,-122.413291,37.802443;color=%23DD0000;width=7;outline-color=#00DD00;outline-width=5yd|point:-122.40572,37.80004;label=Fog Hill Market;size=large;text-color=%23DD0000;color=#EE4B2B` Currently it supports the following geometry types: point, line and polygon. It does not support multiPoint , multiLine and multiPolgyon. Length Constraints: Minimum length of 1. Maximum length of 5000. ** [CropLabels](#API_geomaps_GetStaticMap_RequestSyntax) ** It is a flag that takes in true or false. It prevents the labels that are on the edge of the image from being cut or obscured. ** [FileName](#API_geomaps_GetStaticMap_RequestSyntax) ** The map scaling parameter to size the image, icons, and labels. It follows the pattern of `^map(@2x)?$`. Example: `map, map@2x` Pattern: `map(@2x)?` Required: Yes ** [GeoJsonOverlay](#API_geomaps_GetStaticMap_RequestSyntax) ** Takes in a string to draw geometries on the image. The input is a valid GeoJSON collection object. Example: `{"type":"FeatureCollection","features": [{"type":"Feature","geometry":{"type":"MultiPoint","coordinates": [[-90.076345,51.504107],[-0.074451,51.506892]]},"properties": {"color":"#00DD00"}}]}` Length Constraints: Minimum length of 1. Maximum length of 4200. ** [Height](#API_geomaps_GetStaticMap_RequestSyntax) ** Specifies the height of the map image. Valid Range: Minimum value of 64. Maximum value of 1400. Required: Yes ** [Key](#API_geomaps_GetStaticMap_RequestSyntax) ** Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request. Length Constraints: Minimum length of 0. Maximum length of 1000. ** [LabelSize](#API_geomaps_GetStaticMap_RequestSyntax) ** Overrides the label size auto-calculated by `FileName`. Takes in one of the values - `Small` or `Large`. Valid Values: `Small | Large` ** [Language](#API_geomaps_GetStaticMap_RequestSyntax) ** Specifies the language on the map labels using the BCP 47 language tag, limited to ISO 639-1 two-letter language codes. If the specified language data isn't available for the map image, the labels will default to the regional primary language. Supported codes: + `ar` + `as` + `az` + `be` + `bg` + `bn` + `bs` + `ca` + `cs` + `cy` + `da` + `de` + `el` + `en` + `es` + `et` + `eu` + `fi` + `fo` + `fr` + `ga` + `gl` + `gn` + `gu` + `he` + `hi` + `hr` + `hu` + `hy` + `id` + `is` + `it` + `ja` + `ka` + `kk` + `km` + `kn` + `ko` + `ky` + `lt` + `lv` + `mk` + `ml` + `mr` + `ms` + `mt` + `my` + `nl` + `no` + `or` + `pa` + `pl` + `pt` + `ro` + `ru` + `sk` + `sl` + `sq` + `sr` + `sv` + `ta` + `te` + `th` + `tr` + `uk` + `uz` + `vi` + `zh` Length Constraints: Minimum length of 2. Maximum length of 35. ** [Padding](#API_geomaps_GetStaticMap_RequestSyntax) ** Applies additional space (in pixels) around overlay feature to prevent them from being cut or obscured. Value for max and min is determined by: Min: `1` Max: `min(height, width)/4` Example: `100` Valid Range: Minimum value of 0. Maximum value of 350. ** [PointsOfInterests](#API_geomaps_GetStaticMap_RequestSyntax) ** Determines if the result image will display icons representing points of interest on the map. Valid Values: `Enabled | Disabled` ** [PoliticalView](#API_geomaps_GetStaticMap_RequestSyntax) ** Specifies the political view, using ISO 3166-2 or ISO 3166-3 country code format. The following political views are currently supported: + `ARG`: Argentina's view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands + `EGY`: Egypt's view on Bir Tawil + `IND`: India's view on Gilgit-Baltistan + `KEN`: Kenya's view on the Ilemi Triangle + `MAR`: Morocco's view on Western Sahara + `RUS`: Russia's view on Crimea + `SDN`: Sudan's view on the Halaib Triangle + `SRB`: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands + `SUR`: Suriname's view on the Courantyne Headwaters and Lawa Headwaters + `SYR`: Syria's view on the Golan Heights + `TUR`: Turkey's view on Cyprus and Northern Cyprus + `TZA`: Tanzania's view on Lake Malawi + `URY`: Uruguay's view on Rincon de Artigas + `VNM`: Vietnam's view on the Paracel Islands and Spratly Islands Length Constraints: Minimum length of 2. Maximum length of 3. Pattern: `([A-Z]{2}|[A-Z]{3})` ** [Radius](#API_geomaps_GetStaticMap_RequestSyntax) ** Used with center parameter, it specifies the zoom of the image where you can control it on a granular level. Takes in any value `>= 1`. Example: `1500` Cannot be used with `Zoom`. **Unit**: `Meters` Valid Range: Minimum value of 0. Maximum value of 4294967295. ** [ScaleBarUnit](#API_geomaps_GetStaticMap_RequestSyntax) ** Displays a scale on the bottom right of the map image with the unit specified in the input. Example: `KilometersMiles, Miles, Kilometers, MilesKilometers` Valid Values: `Kilometers | KilometersMiles | Miles | MilesKilometers` ** [Style](#API_geomaps_GetStaticMap_RequestSyntax) ** `Style` specifies the desired map style. Valid Values: `Satellite | Standard` ** [Width](#API_geomaps_GetStaticMap_RequestSyntax) ** Specifies the width of the map image. Valid Range: Minimum value of 64. Maximum value of 1400. Required: Yes ** [Zoom](#API_geomaps_GetStaticMap_RequestSyntax) ** Specifies the zoom level of the map image. Cannot be used with `Radius`. Valid Range: Minimum value of 0. Maximum value of 20. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-Type: ContentType Cache-Control: CacheControl ETag: ETag x-amz-geo-pricing-bucket: PricingBucket Blob ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The response returns the following HTTP headers. ** [CacheControl](#API_geomaps_GetStaticMap_ResponseSyntax) ** Header that instructs caching configuration for the client. ** [ContentType](#API_geomaps_GetStaticMap_ResponseSyntax) ** Header that represents the format of the response. The response returns the following as the HTTP body. ** [ETag](#API_geomaps_GetStaticMap_ResponseSyntax) ** The static map's Etag. ** [PricingBucket](#API_geomaps_GetStaticMap_ResponseSyntax) ** The pricing bucket for which the request is charged at. The response returns the following as the HTTP body. ** [Blob](#API_geomaps_GetStaticMap_ResponseSyntax) ** The blob represents a map image as a `jpeg` for the `GetStaticMap` API. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions. HTTP Status Code: 403 ** InternalServerException ** The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ** ThrottlingException ** The request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the constraints specified by an AWS service. ** FieldList ** A message with the reason for the validation exception error. ** Reason ** The field where the invalid entry was detected. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/geo-maps-2020-11-19/GetStaticMap) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/geo-maps-2020-11-19/GetStaticMap) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/geo-maps-2020-11-19/GetStaticMap) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/geo-maps-2020-11-19/GetStaticMap) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/geo-maps-2020-11-19/GetStaticMap) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/geo-maps-2020-11-19/GetStaticMap) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/geo-maps-2020-11-19/GetStaticMap) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/geo-maps-2020-11-19/GetStaticMap) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/geo-maps-2020-11-19/GetStaticMap) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/geo-maps-2020-11-19/GetStaticMap) # GetStyleDescriptor `GetStyleDescriptor` returns information about the style. For more information, see [Style dynamic maps](https://docs.aws.amazon.com/location/latest/developerguide/styling-dynamic-maps.html) in the *Amazon Location Service Developer Guide*. ## Request Syntax ``` GET /styles/Style/descriptor?buildings=Buildings&color-scheme=ColorScheme&contour-density=ContourDensity&key=Key&political-view=PoliticalView&terrain=Terrain&traffic=Traffic&travel-modes=TravelModes HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [Buildings](#API_geomaps_GetStyleDescriptor_RequestSyntax) ** Adjusts how building details are rendered on the map. The following building styles are currently supported: + `Buildings3D`: Displays buildings as three-dimensional extrusions on the map. `Buildings3D` is valid only for the `Standard` and `Monochrome` map styles. Valid Values: `Buildings3D` ** [ColorScheme](#API_geomaps_GetStyleDescriptor_RequestSyntax) ** Sets the color tone for the map, such as dark and light. Example: `Light` Default value: `Light` Valid values for ColorScheme are case sensitive. Valid Values: `Light | Dark` ** [ContourDensity](#API_geomaps_GetStyleDescriptor_RequestSyntax) ** Displays the shape and steepness of terrain features using elevation lines. The density value controls how densely the available contour line information is rendered on the map. Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. This parameter is valid for all map styles except `Satellite`. Valid Values: `Low | Medium | High` ** [Key](#API_geomaps_GetStyleDescriptor_RequestSyntax) ** Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request. Length Constraints: Minimum length of 0. Maximum length of 1000. ** [PoliticalView](#API_geomaps_GetStyleDescriptor_RequestSyntax) ** Specifies the political view using ISO 3166-2 or ISO 3166-3 country code format. Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. The following political views are currently supported: + `ARG`: Argentina's view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands + `EGY`: Egypt's view on Bir Tawil + `IND`: India's view on Gilgit-Baltistan + `KEN`: Kenya's view on the Ilemi Triangle + `MAR`: Morocco's view on Western Sahara + `RUS`: Russia's view on Crimea + `SDN`: Sudan's view on the Halaib Triangle + `SRB`: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands + `SUR`: Suriname's view on the Courantyne Headwaters and Lawa Headwaters + `SYR`: Syria's view on the Golan Heights + `TUR`: Turkey's view on Cyprus and Northern Cyprus + `TZA`: Tanzania's view on Lake Malawi + `URY`: Uruguay's view on Rincon de Artigas + `VNM`: Vietnam's view on the Paracel Islands and Spratly Islands Length Constraints: Minimum length of 2. Maximum length of 3. Pattern: `([A-Z]{2}|[A-Z]{3})` ** [Style](#API_geomaps_GetStyleDescriptor_RequestSyntax) ** Style specifies the desired map style. For [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers, `ap-southeast-1` and `ap-southeast-5` regions support only the `Standard` and `Monochrome` values. Valid Values: `Standard | Monochrome | Hybrid | Satellite` Required: Yes ** [Terrain](#API_geomaps_GetStyleDescriptor_RequestSyntax) ** Adjusts how physical terrain details are rendered on the map. Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. The following terrain styles are currently supported: + `Hillshade`: Displays the physical terrain details through shading and highlighting of elevation change and geographic features. + `Terrain3D`: Displays physical terrain details and elevations as a three-dimensional model. `Hillshade` is valid only for the `Standard` and `Monochrome` map styles. Valid Values: `Hillshade | Terrain3D` ** [Traffic](#API_geomaps_GetStyleDescriptor_RequestSyntax) ** Displays real-time traffic information overlay on map, such as incident events and flow events. Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. This parameter is valid for all map styles except `Satellite`. Valid Values: `All | Congestion` ** [TravelModes](#API_geomaps_GetStyleDescriptor_RequestSyntax) ** Renders additional map information relevant to selected travel modes. Information for multiple travel modes can be displayed simultaneously, although this increases the overall information density rendered on the map. Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. This parameter is valid for all map styles except `Satellite`. Array Members: Minimum number of 0 items. Maximum number of 2 items. Valid Values: `Transit | Truck` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-Type: ContentType Cache-Control: CacheControl ETag: ETag Blob ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The response returns the following HTTP headers. ** [CacheControl](#API_geomaps_GetStyleDescriptor_ResponseSyntax) ** Header that instructs caching configuration for the client. ** [ContentType](#API_geomaps_GetStyleDescriptor_ResponseSyntax) ** Header that represents the format of the response. The response returns the following as the HTTP body. ** [ETag](#API_geomaps_GetStyleDescriptor_ResponseSyntax) ** The style descriptor's Etag. The response returns the following as the HTTP body. ** [Blob](#API_geomaps_GetStyleDescriptor_ResponseSyntax) ** This Blob contains the body of the style descriptor which is in application/json format. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/geo-maps-2020-11-19/GetStyleDescriptor) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/geo-maps-2020-11-19/GetStyleDescriptor) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/geo-maps-2020-11-19/GetStyleDescriptor) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/geo-maps-2020-11-19/GetStyleDescriptor) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/geo-maps-2020-11-19/GetStyleDescriptor) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/geo-maps-2020-11-19/GetStyleDescriptor) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/geo-maps-2020-11-19/GetStyleDescriptor) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/geo-maps-2020-11-19/GetStyleDescriptor) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/geo-maps-2020-11-19/GetStyleDescriptor) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/geo-maps-2020-11-19/GetStyleDescriptor) # GetTile `GetTile` returns a tile. Map tiles are used by clients to render a map. They're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level. For more information, see [Tiles](https://docs.aws.amazon.com/location/latest/developerguide/tiles.html) in the *Amazon Location Service Developer Guide*. ## Request Syntax ``` GET /tiles/Tileset/Z/X/Y?additional-features=AdditionalFeatures&key=Key HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [AdditionalFeatures](#API_geomaps_GetTile_RequestSyntax) ** A list of optional additional parameters such as map styles that can be requested for each result. Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. Array Members: Minimum number of 0 items. Maximum number of 4 items. Valid Values: `ContourLines | Hillshade | Logistics | Transit` ** [Key](#API_geomaps_GetTile_RequestSyntax) ** Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request. Length Constraints: Minimum length of 0. Maximum length of 1000. ** [Tileset](#API_geomaps_GetTile_RequestSyntax) ** Specifies the desired tile set. For [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers, `ap-southeast-1` and `ap-southeast-5` regions support only the `vector.basemap` value. Valid Values: `raster.satellite | vector.basemap | vector.traffic | raster.dem` Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-.\w]+` Required: Yes ** [X](#API_geomaps_GetTile_RequestSyntax) ** The X axis value for the map tile. Length Constraints: Minimum length of 0. Maximum length of 7. Pattern: `.*\d+.*` Required: Yes ** [Y](#API_geomaps_GetTile_RequestSyntax) ** The Y axis value for the map tile. Length Constraints: Minimum length of 0. Maximum length of 7. Pattern: `.*\d+.*` Required: Yes ** [Z](#API_geomaps_GetTile_RequestSyntax) ** The zoom value for the map tile. Length Constraints: Minimum length of 0. Maximum length of 2. Pattern: `.*\d+.*` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-Type: ContentType Cache-Control: CacheControl ETag: ETag x-amz-geo-pricing-bucket: PricingBucket Blob ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The response returns the following HTTP headers. ** [CacheControl](#API_geomaps_GetTile_ResponseSyntax) ** Header that instructs caching configuration for the client. ** [ContentType](#API_geomaps_GetTile_ResponseSyntax) ** Header that represents the format of the response. The response returns the following as the HTTP body. ** [ETag](#API_geomaps_GetTile_ResponseSyntax) ** The pricing bucket for which the request is charged at. ** [PricingBucket](#API_geomaps_GetTile_ResponseSyntax) ** The pricing bucket for which the request is charged at. The response returns the following as the HTTP body. ** [Blob](#API_geomaps_GetTile_ResponseSyntax) ** The blob represents a vector tile in `mvt` or a raster tile in an image format. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions. HTTP Status Code: 403 ** InternalServerException ** The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ** ResourceNotFoundException ** Exception thrown when the associated resource could not be found. HTTP Status Code: 404 ** ThrottlingException ** The request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the constraints specified by an AWS service. ** FieldList ** A message with the reason for the validation exception error. ** Reason ** The field where the invalid entry was detected. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/geo-maps-2020-11-19/GetTile) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/geo-maps-2020-11-19/GetTile) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/geo-maps-2020-11-19/GetTile) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/geo-maps-2020-11-19/GetTile) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/geo-maps-2020-11-19/GetTile) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/geo-maps-2020-11-19/GetTile) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/geo-maps-2020-11-19/GetTile) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/geo-maps-2020-11-19/GetTile) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/geo-maps-2020-11-19/GetTile) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/geo-maps-2020-11-19/GetTile) # Amazon Location Service Places V2 The following actions are supported by Amazon Location Service Places V2: + [Autocomplete](API_geoplaces_Autocomplete.md) + [Geocode](API_geoplaces_Geocode.md) + [GetPlace](API_geoplaces_GetPlace.md) + [ReverseGeocode](API_geoplaces_ReverseGeocode.md) + [SearchNearby](API_geoplaces_SearchNearby.md) + [SearchText](API_geoplaces_SearchText.md) + [Suggest](API_geoplaces_Suggest.md) # Autocomplete `Autocomplete` completes potential places and addresses as the user types, based on the partial input. The API enhances the efficiency and accuracy of address by completing query based on a few entered keystrokes. It helps you by completing partial queries with valid address completion. Also, the API supports the filtering of results based on geographic location, country, or specific place types, and can be tailored using optional parameters like language and political views. For more information, see [Autocomplete](https://docs.aws.amazon.com/location/latest/developerguide/autocomplete.html) in the *Amazon Location Service Developer Guide*. ## Request Syntax ``` POST /autocomplete?key=Key HTTP/1.1 Content-type: application/json { "AdditionalFeatures": [ "string" ], "BiasPosition": [ number ], "Filter": { "BoundingBox": [ number ], "Circle": { "Center": [ number ], "Radius": number }, "IncludeCountries": [ "string" ], "IncludePlaceTypes": [ "string" ] }, "IntendedUse": "string", "Language": "string", "MaxResults": number, "PoliticalView": "string", "PostalCodeMode": "string", "QueryText": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [Key](#API_geoplaces_Autocomplete_RequestSyntax) ** Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request. Length Constraints: Minimum length of 0. Maximum length of 1000. ## Request Body The request accepts the following data in JSON format. ** [AdditionalFeatures](#API_geoplaces_Autocomplete_RequestSyntax) ** A list of optional additional parameters that can be requested for each result. Type: Array of strings Array Members: Fixed number of 1 item. Valid Values: `Core` Required: No ** [BiasPosition](#API_geoplaces_Autocomplete_RequestSyntax) ** The position in longitude and latitude that the results should be close to. Typically, place results returned are ranked higher the closer they are to this position. Stored in `[lng, lat]` and in the WGS 84 format. The fields `BiasPosition`, `FilterBoundingBox`, and `FilterCircle` are mutually exclusive. Type: Array of doubles Array Members: Fixed number of 2 items. Required: No ** [Filter](#API_geoplaces_Autocomplete_RequestSyntax) ** A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result. Type: [AutocompleteFilter](API_geoplaces_AutocompleteFilter.md) object Required: No ** [IntendedUse](#API_geoplaces_Autocomplete_RequestSyntax) ** Indicates if the query results will be persisted in customer infrastructure. Defaults to `SingleUse` (not stored). Currently, `Autocomplete` does not support storage of results. Type: String Valid Values: `SingleUse` Required: No ** [Language](#API_geoplaces_Autocomplete_RequestSyntax) ** A list of [BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry. Type: String Length Constraints: Minimum length of 2. Maximum length of 35. Required: No ** [MaxResults](#API_geoplaces_Autocomplete_RequestSyntax) ** An optional limit for the number of results returned in a single call. Default value: 5 Type: Integer Valid Range: Minimum value of 1. Maximum value of 20. Required: No ** [PoliticalView](#API_geoplaces_Autocomplete_RequestSyntax) ** The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country. The following political views are currently supported: + `ARG`: Argentina's view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands + `EGY`: Egypt's view on Bir Tawil + `IND`: India's view on Gilgit-Baltistan + `KEN`: Kenya's view on the Ilemi Triangle + `MAR`: Morocco's view on Western Sahara + `RUS`: Russia's view on Crimea + `SDN`: Sudan's view on the Halaib Triangle + `SRB`: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands + `SUR`: Suriname's view on the Courantyne Headwaters and Lawa Headwaters + `SYR`: Syria's view on the Golan Heights + `TUR`: Turkey's view on Cyprus and Northern Cyprus + `TZA`: Tanzania's view on Lake Malawi + `URY`: Uruguay's view on Rincon de Artigas + `VNM`: Vietnam's view on the Paracel Islands and Spratly Islands Type: String Length Constraints: Minimum length of 2. Maximum length of 3. Pattern: `([A-Z]{2}|[A-Z]{3})` Required: No ** [PostalCodeMode](#API_geoplaces_Autocomplete_RequestSyntax) ** The `PostalCodeMode` affects how postal code results are returned. If a postal code spans multiple localities and this value is empty, partial district or locality information may be returned under a single postal code result entry. If it's populated with the value `EnumerateSpannedLocalities`, all cities in that postal code are returned. Type: String Valid Values: `MergeAllSpannedLocalities | EnumerateSpannedLocalities` Required: No ** [QueryText](#API_geoplaces_Autocomplete_RequestSyntax) ** The free-form text query to match addresses against. This is usually a partially typed address from an end user in an address box or form. The fields `QueryText`, and `QueryID` are mutually exclusive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Required: Yes ## Response Syntax ``` HTTP/1.1 200 x-amz-geo-pricing-bucket: PricingBucket Content-type: application/json { "ResultItems": [ { "Address": { "AddressNumber": "string", "Block": "string", "Building": "string", "Country": { "Code2": "string", "Code3": "string", "Name": "string" }, "District": "string", "Intersection": [ "string" ], "Label": "string", "Locality": "string", "PostalCode": "string", "Region": { "Code": "string", "Name": "string" }, "SecondaryAddressComponents": [ { "Designator": "string", "Number": "string" } ], "Street": "string", "StreetComponents": [ { "BaseName": "string", "Direction": "string", "Language": "string", "Prefix": "string", "Suffix": "string", "Type": "string", "TypePlacement": "string", "TypeSeparator": "string" } ], "SubBlock": "string", "SubDistrict": "string", "SubRegion": { "Code": "string", "Name": "string" } }, "Distance": number, "Highlights": { "Address": { "AddressNumber": [ { "EndIndex": number, "StartIndex": number, "Value": "string" } ], "Block": [ { "EndIndex": number, "StartIndex": number, "Value": "string" } ], "Building": [ { "EndIndex": number, "StartIndex": number, "Value": "string" } ], "Country": { "Code": [ { "EndIndex": number, "StartIndex": number, "Value": "string" } ], "Name": [ { "EndIndex": number, "StartIndex": number, "Value": "string" } ] }, "District": [ { "EndIndex": number, "StartIndex": number, "Value": "string" } ], "Intersection": [ [ { "EndIndex": number, "StartIndex": number, "Value": "string" } ] ], "Label": [ { "EndIndex": number, "StartIndex": number, "Value": "string" } ], "Locality": [ { "EndIndex": number, "StartIndex": number, "Value": "string" } ], "PostalCode": [ { "EndIndex": number, "StartIndex": number, "Value": "string" } ], "Region": { "Code": [ { "EndIndex": number, "StartIndex": number, "Value": "string" } ], "Name": [ { "EndIndex": number, "StartIndex": number, "Value": "string" } ] }, "Street": [ { "EndIndex": number, "StartIndex": number, "Value": "string" } ], "SubBlock": [ { "EndIndex": number, "StartIndex": number, "Value": "string" } ], "SubDistrict": [ { "EndIndex": number, "StartIndex": number, "Value": "string" } ], "SubRegion": { "Code": [ { "EndIndex": number, "StartIndex": number, "Value": "string" } ], "Name": [ { "EndIndex": number, "StartIndex": number, "Value": "string" } ] } }, "Title": [ { "EndIndex": number, "StartIndex": number, "Value": "string" } ] }, "Language": "string", "PlaceId": "string", "PlaceType": "string", "PoliticalView": "string", "Title": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The response returns the following HTTP headers. ** [PricingBucket](#API_geoplaces_Autocomplete_ResponseSyntax) ** The pricing bucket for which the query is charged at. For more information on pricing, please visit [Amazon Location Service Pricing](https://aws.amazon.com/location/pricing/). The following data is returned in JSON format by the service. ** [ResultItems](#API_geoplaces_Autocomplete_ResponseSyntax) ** List of places or results returned for a query. Type: Array of [AutocompleteResultItem](API_geoplaces_AutocompleteResultItem.md) objects Array Members: Minimum number of 0 items. Maximum number of 20 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You don't have sufficient access to perform this action. HTTP Status Code: 403 ** InternalServerException ** The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ** ThrottlingException ** The request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the constraints specified by an AWS service. ** FieldList ** Test stub for FieldList. ** Reason ** Test stub for reason HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/geo-places-2020-11-19/Autocomplete) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/geo-places-2020-11-19/Autocomplete) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/geo-places-2020-11-19/Autocomplete) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/geo-places-2020-11-19/Autocomplete) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/geo-places-2020-11-19/Autocomplete) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/geo-places-2020-11-19/Autocomplete) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/geo-places-2020-11-19/Autocomplete) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/geo-places-2020-11-19/Autocomplete) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/geo-places-2020-11-19/Autocomplete) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/geo-places-2020-11-19/Autocomplete) # Geocode `Geocode` converts a textual address or place into geographic coordinates. You can obtain geographic coordinates, address component, and other related information. It supports flexible queries, including free-form text or structured queries with components like street names, postal codes, and regions. The Geocode API can also provide additional features such as time zone information and the inclusion of political views. For more information, see [Geocode](https://docs.aws.amazon.com/location/latest/developerguide/geocode.html) in the *Amazon Location Service Developer Guide*. ## Request Syntax ``` POST /geocode?key=Key HTTP/1.1 Content-type: application/json { "AdditionalFeatures": [ "string" ], "BiasPosition": [ number ], "Filter": { "IncludeCountries": [ "string" ], "IncludePlaceTypes": [ "string" ] }, "IntendedUse": "string", "Language": "string", "MaxResults": number, "PoliticalView": "string", "QueryComponents": { "AddressNumber": "string", "Country": "string", "District": "string", "Locality": "string", "PostalCode": "string", "Region": "string", "Street": "string", "SubRegion": "string" }, "QueryText": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [Key](#API_geoplaces_Geocode_RequestSyntax) ** Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request. Length Constraints: Minimum length of 0. Maximum length of 1000. ## Request Body The request accepts the following data in JSON format. ** [AdditionalFeatures](#API_geoplaces_Geocode_RequestSyntax) ** A list of optional additional parameters, such as time zone, that can be requested for each result. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 4 items. Valid Values: `TimeZone | Access | SecondaryAddresses | Intersections` Required: No ** [BiasPosition](#API_geoplaces_Geocode_RequestSyntax) ** The position, in longitude and latitude, that the results should be close to. Typically, place results returned are ranked higher the closer they are to this position. Stored in `[lng, lat]` and in the WGS 84 format. Type: Array of doubles Array Members: Fixed number of 2 items. Required: No ** [Filter](#API_geoplaces_Geocode_RequestSyntax) ** A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result. Type: [GeocodeFilter](API_geoplaces_GeocodeFilter.md) object Required: No ** [IntendedUse](#API_geoplaces_Geocode_RequestSyntax) ** Indicates if the query results will be persisted in customer infrastructure. Defaults to `SingleUse` (not stored). Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. When storing `Geocode` responses, you *must* set this field to `Storage` to comply with the terms of service. These requests will be charged at a higher rate. Please review the [user agreement](https://aws.amazon.com/location/sla/) and [service pricing structure](https://aws.amazon.com/location/pricing/) to determine the correct setting for your use case. Type: String Valid Values: `SingleUse | Storage` Required: No ** [Language](#API_geoplaces_Geocode_RequestSyntax) ** A list of [BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry. Type: String Length Constraints: Minimum length of 2. Maximum length of 35. Required: No ** [MaxResults](#API_geoplaces_Geocode_RequestSyntax) ** An optional limit for the number of results returned in a single call. Default value: 20 Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [PoliticalView](#API_geoplaces_Geocode_RequestSyntax) ** The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country. Type: String Length Constraints: Minimum length of 2. Maximum length of 3. Pattern: `([A-Z]{2}|[A-Z]{3})` Required: No ** [QueryComponents](#API_geoplaces_Geocode_RequestSyntax) ** A structured free text query allows you to search for places by the name or text representation of specific properties of the place. Type: [GeocodeQueryComponents](API_geoplaces_GeocodeQueryComponents.md) object Required: No ** [QueryText](#API_geoplaces_Geocode_RequestSyntax) ** The free-form text query to match addresses against. This is usually a partially typed address from an end user in an address box or form. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Required: No ## Response Syntax ``` HTTP/1.1 200 x-amz-geo-pricing-bucket: PricingBucket Content-type: application/json { "ResultItems": [ { "AccessPoints": [ { "Position": [ number ] } ], "Address": { "AddressNumber": "string", "Block": "string", "Building": "string", "Country": { "Code2": "string", "Code3": "string", "Name": "string" }, "District": "string", "Intersection": [ "string" ], "Label": "string", "Locality": "string", "PostalCode": "string", "Region": { "Code": "string", "Name": "string" }, "SecondaryAddressComponents": [ { "Designator": "string", "Number": "string" } ], "Street": "string", "StreetComponents": [ { "BaseName": "string", "Direction": "string", "Language": "string", "Prefix": "string", "Suffix": "string", "Type": "string", "TypePlacement": "string", "TypeSeparator": "string" } ], "SubBlock": "string", "SubDistrict": "string", "SubRegion": { "Code": "string", "Name": "string" } }, "AddressNumberCorrected": boolean, "Categories": [ { "Id": "string", "LocalizedName": "string", "Name": "string", "Primary": boolean } ], "Distance": number, "FoodTypes": [ { "Id": "string", "LocalizedName": "string", "Primary": boolean } ], "Intersections": [ { "AccessPoints": [ { "Position": [ number ] } ], "Address": { "AddressNumber": "string", "Block": "string", "Building": "string", "Country": { "Code2": "string", "Code3": "string", "Name": "string" }, "District": "string", "Intersection": [ "string" ], "Label": "string", "Locality": "string", "PostalCode": "string", "Region": { "Code": "string", "Name": "string" }, "SecondaryAddressComponents": [ { "Designator": "string", "Number": "string" } ], "Street": "string", "StreetComponents": [ { "BaseName": "string", "Direction": "string", "Language": "string", "Prefix": "string", "Suffix": "string", "Type": "string", "TypePlacement": "string", "TypeSeparator": "string" } ], "SubBlock": "string", "SubDistrict": "string", "SubRegion": { "Code": "string", "Name": "string" } }, "Distance": number, "MapView": [ number ], "PlaceId": "string", "Position": [ number ], "RouteDistance": number, "Title": "string" } ], "MainAddress": { "AccessPoints": [ { "Position": [ number ] } ], "Address": { "AddressNumber": "string", "Block": "string", "Building": "string", "Country": { "Code2": "string", "Code3": "string", "Name": "string" }, "District": "string", "Intersection": [ "string" ], "Label": "string", "Locality": "string", "PostalCode": "string", "Region": { "Code": "string", "Name": "string" }, "SecondaryAddressComponents": [ { "Designator": "string", "Number": "string" } ], "Street": "string", "StreetComponents": [ { "BaseName": "string", "Direction": "string", "Language": "string", "Prefix": "string", "Suffix": "string", "Type": "string", "TypePlacement": "string", "TypeSeparator": "string" } ], "SubBlock": "string", "SubDistrict": "string", "SubRegion": { "Code": "string", "Name": "string" } }, "PlaceId": "string", "PlaceType": "string", "Position": [ number ], "Title": "string" }, "MapView": [ number ], "MatchScores": { "Components": { "Address": { "AddressNumber": number, "Block": number, "Building": number, "Country": number, "District": number, "Intersection": [ number ], "Locality": number, "PostalCode": number, "Region": number, "SecondaryAddressComponents": [ { "Number": number } ], "SubBlock": number, "SubDistrict": number, "SubRegion": number }, "Title": number }, "Overall": number }, "ParsedQuery": { "Address": { "AddressNumber": [ { "EndIndex": number, "QueryComponent": "string", "StartIndex": number, "Value": "string" } ], "Block": [ { "EndIndex": number, "QueryComponent": "string", "StartIndex": number, "Value": "string" } ], "Building": [ { "EndIndex": number, "QueryComponent": "string", "StartIndex": number, "Value": "string" } ], "Country": [ { "EndIndex": number, "QueryComponent": "string", "StartIndex": number, "Value": "string" } ], "District": [ { "EndIndex": number, "QueryComponent": "string", "StartIndex": number, "Value": "string" } ], "Locality": [ { "EndIndex": number, "QueryComponent": "string", "StartIndex": number, "Value": "string" } ], "PostalCode": [ { "EndIndex": number, "QueryComponent": "string", "StartIndex": number, "Value": "string" } ], "Region": [ { "EndIndex": number, "QueryComponent": "string", "StartIndex": number, "Value": "string" } ], "SecondaryAddressComponents": [ { "Designator": "string", "EndIndex": number, "Number": "string", "StartIndex": number, "Value": "string" } ], "Street": [ { "EndIndex": number, "QueryComponent": "string", "StartIndex": number, "Value": "string" } ], "SubBlock": [ { "EndIndex": number, "QueryComponent": "string", "StartIndex": number, "Value": "string" } ], "SubDistrict": [ { "EndIndex": number, "QueryComponent": "string", "StartIndex": number, "Value": "string" } ], "SubRegion": [ { "EndIndex": number, "QueryComponent": "string", "StartIndex": number, "Value": "string" } ] }, "Title": [ { "EndIndex": number, "QueryComponent": "string", "StartIndex": number, "Value": "string" } ] }, "PlaceId": "string", "PlaceType": "string", "PoliticalView": "string", "Position": [ number ], "PostalCodeDetails": [ { "PostalAuthority": "string", "PostalCode": "string", "PostalCodeType": "string", "UspsZip": { "ZipClassificationCode": "string" }, "UspsZipPlus4": { "RecordTypeCode": "string" } } ], "SecondaryAddresses": [ { "AccessPoints": [ { "Position": [ number ] } ], "Address": { "AddressNumber": "string", "Block": "string", "Building": "string", "Country": { "Code2": "string", "Code3": "string", "Name": "string" }, "District": "string", "Intersection": [ "string" ], "Label": "string", "Locality": "string", "PostalCode": "string", "Region": { "Code": "string", "Name": "string" }, "SecondaryAddressComponents": [ { "Designator": "string", "Number": "string" } ], "Street": "string", "StreetComponents": [ { "BaseName": "string", "Direction": "string", "Language": "string", "Prefix": "string", "Suffix": "string", "Type": "string", "TypePlacement": "string", "TypeSeparator": "string" } ], "SubBlock": "string", "SubDistrict": "string", "SubRegion": { "Code": "string", "Name": "string" } }, "PlaceId": "string", "PlaceType": "string", "Position": [ number ], "Title": "string" } ], "TimeZone": { "Name": "string", "Offset": "string", "OffsetSeconds": number }, "Title": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The response returns the following HTTP headers. ** [PricingBucket](#API_geoplaces_Geocode_ResponseSyntax) ** The pricing bucket for which the query is charged at, or the maximum pricing bucket when the query is charged per item within the query. For more information on pricing, please visit [Amazon Location Service Pricing](https://aws.amazon.com/location/pricing/). The following data is returned in JSON format by the service. ** [ResultItems](#API_geoplaces_Geocode_ResponseSyntax) ** List of places or results returned for a query. Type: Array of [GeocodeResultItem](API_geoplaces_GeocodeResultItem.md) objects Array Members: Minimum number of 0 items. Maximum number of 100 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You don't have sufficient access to perform this action. HTTP Status Code: 403 ** InternalServerException ** The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ** ThrottlingException ** The request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the constraints specified by an AWS service. ** FieldList ** Test stub for FieldList. ** Reason ** Test stub for reason HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/geo-places-2020-11-19/Geocode) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/geo-places-2020-11-19/Geocode) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/geo-places-2020-11-19/Geocode) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/geo-places-2020-11-19/Geocode) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/geo-places-2020-11-19/Geocode) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/geo-places-2020-11-19/Geocode) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/geo-places-2020-11-19/Geocode) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/geo-places-2020-11-19/Geocode) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/geo-places-2020-11-19/Geocode) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/geo-places-2020-11-19/Geocode) # GetPlace `GetPlace` finds a place by its unique ID. A `PlaceId` is returned by other place operations. For more information, see [GetPlace](https://docs.aws.amazon.com/location/latest/developerguide/get-place.html) in the *Amazon Location Service Developer Guide*. ## Request Syntax ``` GET /place/PlaceId?additional-features=AdditionalFeatures&intended-use=IntendedUse&key=Key&language=Language&political-view=PoliticalView HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [AdditionalFeatures](#API_geoplaces_GetPlace_RequestSyntax) ** A list of optional additional parameters such as time zone that can be requested for each result. For [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers, `ap-southeast-1` and `ap-southeast-5` regions support only the `TimeZone` value. Array Members: Minimum number of 1 item. Maximum number of 5 items. Valid Values: `TimeZone | Phonemes | Access | Contact | SecondaryAddresses` ** [IntendedUse](#API_geoplaces_GetPlace_RequestSyntax) ** Indicates if the query results will be persisted in customer infrastructure. Defaults to `SingleUse` (not stored). Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. When storing `GetPlace` responses, you *must* set this field to `Storage` to comply with the terms of service. These requests will be charged at a higher rate. Please review the [user agreement](https://aws.amazon.com/location/sla/) and [service pricing structure](https://aws.amazon.com/location/pricing/) to determine the correct setting for your use case. Valid Values: `SingleUse | Storage` ** [Key](#API_geoplaces_GetPlace_RequestSyntax) ** Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request. Length Constraints: Minimum length of 0. Maximum length of 1000. ** [Language](#API_geoplaces_GetPlace_RequestSyntax) ** A list of [BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry. For [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers, `ap-southeast-1` and `ap-southeast-5` regions support only the following codes: `en, id, km, lo, ms, my, pt, th, tl, vi, zh` Length Constraints: Minimum length of 2. Maximum length of 35. ** [PlaceId](#API_geoplaces_GetPlace_RequestSyntax) ** The `PlaceId` of the place you wish to receive the information for. Length Constraints: Minimum length of 0. Maximum length of 500. Required: Yes ** [PoliticalView](#API_geoplaces_GetPlace_RequestSyntax) ** The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country. Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. Length Constraints: Minimum length of 2. Maximum length of 3. Pattern: `([A-Z]{2}|[A-Z]{3})` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 x-amz-geo-pricing-bucket: PricingBucket Content-type: application/json { "AccessPoints": [ { "Position": [ number ] } ], "AccessRestrictions": [ { "Categories": [ { "Id": "string", "LocalizedName": "string", "Name": "string", "Primary": boolean } ], "Restricted": boolean } ], "Address": { "AddressNumber": "string", "Block": "string", "Building": "string", "Country": { "Code2": "string", "Code3": "string", "Name": "string" }, "District": "string", "Intersection": [ "string" ], "Label": "string", "Locality": "string", "PostalCode": "string", "Region": { "Code": "string", "Name": "string" }, "SecondaryAddressComponents": [ { "Designator": "string", "Number": "string" } ], "Street": "string", "StreetComponents": [ { "BaseName": "string", "Direction": "string", "Language": "string", "Prefix": "string", "Suffix": "string", "Type": "string", "TypePlacement": "string", "TypeSeparator": "string" } ], "SubBlock": "string", "SubDistrict": "string", "SubRegion": { "Code": "string", "Name": "string" } }, "AddressNumberCorrected": boolean, "BusinessChains": [ { "Id": "string", "Name": "string" } ], "Categories": [ { "Id": "string", "LocalizedName": "string", "Name": "string", "Primary": boolean } ], "Contacts": { "Emails": [ { "Categories": [ { "Id": "string", "LocalizedName": "string", "Name": "string", "Primary": boolean } ], "Label": "string", "Value": "string" } ], "Faxes": [ { "Categories": [ { "Id": "string", "LocalizedName": "string", "Name": "string", "Primary": boolean } ], "Label": "string", "Value": "string" } ], "Phones": [ { "Categories": [ { "Id": "string", "LocalizedName": "string", "Name": "string", "Primary": boolean } ], "Label": "string", "Value": "string" } ], "Websites": [ { "Categories": [ { "Id": "string", "LocalizedName": "string", "Name": "string", "Primary": boolean } ], "Label": "string", "Value": "string" } ] }, "FoodTypes": [ { "Id": "string", "LocalizedName": "string", "Primary": boolean } ], "MainAddress": { "AccessPoints": [ { "Position": [ number ] } ], "Address": { "AddressNumber": "string", "Block": "string", "Building": "string", "Country": { "Code2": "string", "Code3": "string", "Name": "string" }, "District": "string", "Intersection": [ "string" ], "Label": "string", "Locality": "string", "PostalCode": "string", "Region": { "Code": "string", "Name": "string" }, "SecondaryAddressComponents": [ { "Designator": "string", "Number": "string" } ], "Street": "string", "StreetComponents": [ { "BaseName": "string", "Direction": "string", "Language": "string", "Prefix": "string", "Suffix": "string", "Type": "string", "TypePlacement": "string", "TypeSeparator": "string" } ], "SubBlock": "string", "SubDistrict": "string", "SubRegion": { "Code": "string", "Name": "string" } }, "PlaceId": "string", "PlaceType": "string", "Position": [ number ], "Title": "string" }, "MapView": [ number ], "OpeningHours": [ { "Categories": [ { "Id": "string", "LocalizedName": "string", "Name": "string", "Primary": boolean } ], "Components": [ { "OpenDuration": "string", "OpenTime": "string", "Recurrence": "string" } ], "Display": [ "string" ], "OpenNow": boolean } ], "Phonemes": { "Address": { "Block": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ], "Country": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ], "District": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ], "Locality": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ], "Region": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ], "Street": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ], "SubBlock": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ], "SubDistrict": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ], "SubRegion": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ] }, "Title": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ] }, "PlaceId": "string", "PlaceType": "string", "PoliticalView": "string", "Position": [ number ], "PostalCodeDetails": [ { "PostalAuthority": "string", "PostalCode": "string", "PostalCodeType": "string", "UspsZip": { "ZipClassificationCode": "string" }, "UspsZipPlus4": { "RecordTypeCode": "string" } } ], "SecondaryAddresses": [ { "AccessPoints": [ { "Position": [ number ] } ], "Address": { "AddressNumber": "string", "Block": "string", "Building": "string", "Country": { "Code2": "string", "Code3": "string", "Name": "string" }, "District": "string", "Intersection": [ "string" ], "Label": "string", "Locality": "string", "PostalCode": "string", "Region": { "Code": "string", "Name": "string" }, "SecondaryAddressComponents": [ { "Designator": "string", "Number": "string" } ], "Street": "string", "StreetComponents": [ { "BaseName": "string", "Direction": "string", "Language": "string", "Prefix": "string", "Suffix": "string", "Type": "string", "TypePlacement": "string", "TypeSeparator": "string" } ], "SubBlock": "string", "SubDistrict": "string", "SubRegion": { "Code": "string", "Name": "string" } }, "PlaceId": "string", "PlaceType": "string", "Position": [ number ], "Title": "string" } ], "TimeZone": { "Name": "string", "Offset": "string", "OffsetSeconds": number }, "Title": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The response returns the following HTTP headers. ** [PricingBucket](#API_geoplaces_GetPlace_ResponseSyntax) ** The pricing bucket for which the query is charged at. For more information on pricing, please visit [Amazon Location Service Pricing](https://aws.amazon.com/location/pricing/). The following data is returned in JSON format by the service. ** [AccessPoints](#API_geoplaces_GetPlace_ResponseSyntax) ** Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude]. Not available in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. Type: Array of [AccessPoint](API_geoplaces_AccessPoint.md) objects Array Members: Minimum number of 0 items. Maximum number of 100 items. ** [AccessRestrictions](#API_geoplaces_GetPlace_ResponseSyntax) ** Indicates known access restrictions on a vehicle access point. The index correlates to an access point and indicates if access through this point has some form of restriction. Not available in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. Type: Array of [AccessRestriction](API_geoplaces_AccessRestriction.md) objects Array Members: Minimum number of 1 item. Maximum number of 100 items. ** [Address](#API_geoplaces_GetPlace_ResponseSyntax) ** The place's address. Type: [Address](API_geoplaces_Address.md) object ** [AddressNumberCorrected](#API_geoplaces_GetPlace_ResponseSyntax) ** Boolean indicating if the address provided has been corrected. Not available in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. Type: Boolean ** [BusinessChains](#API_geoplaces_GetPlace_ResponseSyntax) ** The Business Chains associated with the place. Type: Array of [BusinessChain](API_geoplaces_BusinessChain.md) objects Array Members: Minimum number of 1 item. Maximum number of 100 items. ** [Categories](#API_geoplaces_GetPlace_ResponseSyntax) ** Categories of results that results must belong to. Type: Array of [Category](API_geoplaces_Category.md) objects Array Members: Minimum number of 1 item. Maximum number of 100 items. ** [Contacts](#API_geoplaces_GetPlace_ResponseSyntax) ** List of potential contact methods for the result/place. Not available in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. Type: [Contacts](API_geoplaces_Contacts.md) object ** [FoodTypes](#API_geoplaces_GetPlace_ResponseSyntax) ** List of food types offered by this result. Not available in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. Type: Array of [FoodType](API_geoplaces_FoodType.md) objects Array Members: Minimum number of 1 item. Maximum number of 100 items. ** [MainAddress](#API_geoplaces_GetPlace_ResponseSyntax) ** The main address corresponding to a place of type Secondary Address. Not available in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. Type: [RelatedPlace](API_geoplaces_RelatedPlace.md) object ** [MapView](#API_geoplaces_GetPlace_ResponseSyntax) ** The bounding box enclosing the geometric shape (area or line) that an individual result covers. The bounding box formed is defined as a set of four coordinates: `[{westward lng}, {southern lat}, {eastward lng}, {northern lat}]` Type: Array of doubles Array Members: Fixed number of 4 items. ** [OpeningHours](#API_geoplaces_GetPlace_ResponseSyntax) ** List of opening hours objects. Not available in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. Type: Array of [OpeningHours](API_geoplaces_OpeningHours.md) objects Array Members: Minimum number of 1 item. Maximum number of 100 items. ** [Phonemes](#API_geoplaces_GetPlace_ResponseSyntax) ** How the various components of the result's address are pronounced in various languages. Not available in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. Type: [PhonemeDetails](API_geoplaces_PhonemeDetails.md) object ** [PlaceId](#API_geoplaces_GetPlace_ResponseSyntax) ** The `PlaceId` of the place you wish to receive the information for. Type: String Length Constraints: Minimum length of 0. Maximum length of 500. ** [PlaceType](#API_geoplaces_GetPlace_ResponseSyntax) ** A `PlaceType` is a category that the result place must belong to. Type: String Valid Values: `Country | Region | SubRegion | Locality | District | SubDistrict | PostalCode | Block | SubBlock | Intersection | Street | PointOfInterest | PointAddress | InterpolatedAddress | SecondaryAddress | InferredSecondaryAddress` ** [PoliticalView](#API_geoplaces_GetPlace_ResponseSyntax) ** The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country. Not available in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. Type: String Length Constraints: Fixed length of 3. Pattern: `[A-Z]{3}` ** [Position](#API_geoplaces_GetPlace_ResponseSyntax) ** The position in World Geodetic System (WGS 84) format: [longitude, latitude]. Type: Array of doubles Array Members: Fixed number of 2 items. ** [PostalCodeDetails](#API_geoplaces_GetPlace_ResponseSyntax) ** Contains details about the postal code of the place/result. Not available in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. Type: Array of [PostalCodeDetails](API_geoplaces_PostalCodeDetails.md) objects Array Members: Minimum number of 0 items. Maximum number of 100 items. ** [SecondaryAddresses](#API_geoplaces_GetPlace_ResponseSyntax) ** All secondary addresses that are associated with a main address. A secondary address is one that includes secondary designators, such as a Suite or Unit Number, Building, or Floor information. Not available in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. Coverage for this functionality is available in the following countries: AUS, CAN, NZL, USA, PRI. Type: Array of [RelatedPlace](API_geoplaces_RelatedPlace.md) objects Array Members: Minimum number of 1 item. ** [TimeZone](#API_geoplaces_GetPlace_ResponseSyntax) ** The time zone in which the place is located. Type: [TimeZone](API_geoplaces_TimeZone.md) object ** [Title](#API_geoplaces_GetPlace_ResponseSyntax) ** The localized display name of this result item based on request parameter `language`. Type: String Length Constraints: Minimum length of 0. Maximum length of 200. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You don't have sufficient access to perform this action. HTTP Status Code: 403 ** InternalServerException ** The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ** ThrottlingException ** The request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the constraints specified by an AWS service. ** FieldList ** Test stub for FieldList. ** Reason ** Test stub for reason HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/geo-places-2020-11-19/GetPlace) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/geo-places-2020-11-19/GetPlace) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/geo-places-2020-11-19/GetPlace) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/geo-places-2020-11-19/GetPlace) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/geo-places-2020-11-19/GetPlace) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/geo-places-2020-11-19/GetPlace) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/geo-places-2020-11-19/GetPlace) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/geo-places-2020-11-19/GetPlace) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/geo-places-2020-11-19/GetPlace) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/geo-places-2020-11-19/GetPlace) # ReverseGeocode `ReverseGeocode` converts geographic coordinates into a human-readable address or place. You can obtain address component, and other related information such as place type, category, street information. The Reverse Geocode API supports filtering to on place type so that you can refine result based on your need. Also, The Reverse Geocode API can also provide additional features such as time zone information and the inclusion of political views. For more information, see [Reverse Geocode](https://docs.aws.amazon.com/location/latest/developerguide/reverse-geocode.html) in the *Amazon Location Service Developer Guide*. ## Request Syntax ``` POST /reverse-geocode?key=Key HTTP/1.1 Content-type: application/json { "AdditionalFeatures": [ "string" ], "Filter": { "IncludePlaceTypes": [ "string" ] }, "Heading": number, "IntendedUse": "string", "Language": "string", "MaxResults": number, "PoliticalView": "string", "QueryPosition": [ number ], "QueryRadius": number } ``` ## URI Request Parameters The request uses the following URI parameters. ** [Key](#API_geoplaces_ReverseGeocode_RequestSyntax) ** Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request. Length Constraints: Minimum length of 0. Maximum length of 1000. ## Request Body The request accepts the following data in JSON format. ** [AdditionalFeatures](#API_geoplaces_ReverseGeocode_RequestSyntax) ** A list of optional additional parameters, such as time zone that can be requested for each result. For [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers, `ap-southeast-1` and `ap-southeast-5` regions support only the `TimeZone` value. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 3 items. Valid Values: `TimeZone | Access | Intersections` Required: No ** [Filter](#API_geoplaces_ReverseGeocode_RequestSyntax) ** A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result. Type: [ReverseGeocodeFilter](API_geoplaces_ReverseGeocodeFilter.md) object Required: No ** [Heading](#API_geoplaces_ReverseGeocode_RequestSyntax) ** The heading in degrees from true north in a navigation context. The heading is measured as the angle clockwise from the North direction. Example: North is `0` degrees, East is `90` degrees, South is `180` degrees, and West is `270` degrees. Type: Double Valid Range: Minimum value of 0.0. Maximum value of 360.0. Required: No ** [IntendedUse](#API_geoplaces_ReverseGeocode_RequestSyntax) ** Indicates if the query results will be persisted in customer infrastructure. Defaults to `SingleUse` (not stored). When storing `ReverseGeocode` responses, you *must* set this field to `Storage` to comply with the terms of service. These requests will be charged at a higher rate. Please review the [user agreement](https://aws.amazon.com/location/sla/) and [service pricing structure](https://aws.amazon.com/location/pricing/) to determine the correct setting for your use case. Type: String Valid Values: `SingleUse | Storage` Required: No ** [Language](#API_geoplaces_ReverseGeocode_RequestSyntax) ** A list of [BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry. For [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers, `ap-southeast-1` and `ap-southeast-5` regions support only the following codes: `en, id, km, lo, ms, my, pt, th, tl, vi, zh` Type: String Length Constraints: Minimum length of 2. Maximum length of 35. Required: No ** [MaxResults](#API_geoplaces_ReverseGeocode_RequestSyntax) ** An optional limit for the number of results returned in a single call. Default value: 1 Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [PoliticalView](#API_geoplaces_ReverseGeocode_RequestSyntax) ** The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country. Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. Type: String Length Constraints: Minimum length of 2. Maximum length of 3. Pattern: `([A-Z]{2}|[A-Z]{3})` Required: No ** [QueryPosition](#API_geoplaces_ReverseGeocode_RequestSyntax) ** The position in World Geodetic System (WGS 84) format: [longitude, latitude] for which you are querying nearby results for. Results closer to the position will be ranked higher then results further away from the position Type: Array of doubles Array Members: Fixed number of 2 items. Required: Yes ** [QueryRadius](#API_geoplaces_ReverseGeocode_RequestSyntax) ** The maximum distance in meters from the QueryPosition from which a result will be returned. For [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers, `ap-southeast-1` and `ap-southeast-5` regions support only up to a maximum value of 100,000. Type: Long Valid Range: Minimum value of 1. Maximum value of 21000000. Required: No ## Response Syntax ``` HTTP/1.1 200 x-amz-geo-pricing-bucket: PricingBucket Content-type: application/json { "ResultItems": [ { "AccessPoints": [ { "Position": [ number ] } ], "Address": { "AddressNumber": "string", "Block": "string", "Building": "string", "Country": { "Code2": "string", "Code3": "string", "Name": "string" }, "District": "string", "Intersection": [ "string" ], "Label": "string", "Locality": "string", "PostalCode": "string", "Region": { "Code": "string", "Name": "string" }, "SecondaryAddressComponents": [ { "Designator": "string", "Number": "string" } ], "Street": "string", "StreetComponents": [ { "BaseName": "string", "Direction": "string", "Language": "string", "Prefix": "string", "Suffix": "string", "Type": "string", "TypePlacement": "string", "TypeSeparator": "string" } ], "SubBlock": "string", "SubDistrict": "string", "SubRegion": { "Code": "string", "Name": "string" } }, "AddressNumberCorrected": boolean, "Categories": [ { "Id": "string", "LocalizedName": "string", "Name": "string", "Primary": boolean } ], "Distance": number, "FoodTypes": [ { "Id": "string", "LocalizedName": "string", "Primary": boolean } ], "Intersections": [ { "AccessPoints": [ { "Position": [ number ] } ], "Address": { "AddressNumber": "string", "Block": "string", "Building": "string", "Country": { "Code2": "string", "Code3": "string", "Name": "string" }, "District": "string", "Intersection": [ "string" ], "Label": "string", "Locality": "string", "PostalCode": "string", "Region": { "Code": "string", "Name": "string" }, "SecondaryAddressComponents": [ { "Designator": "string", "Number": "string" } ], "Street": "string", "StreetComponents": [ { "BaseName": "string", "Direction": "string", "Language": "string", "Prefix": "string", "Suffix": "string", "Type": "string", "TypePlacement": "string", "TypeSeparator": "string" } ], "SubBlock": "string", "SubDistrict": "string", "SubRegion": { "Code": "string", "Name": "string" } }, "Distance": number, "MapView": [ number ], "PlaceId": "string", "Position": [ number ], "RouteDistance": number, "Title": "string" } ], "MapView": [ number ], "PlaceId": "string", "PlaceType": "string", "PoliticalView": "string", "Position": [ number ], "PostalCodeDetails": [ { "PostalAuthority": "string", "PostalCode": "string", "PostalCodeType": "string", "UspsZip": { "ZipClassificationCode": "string" }, "UspsZipPlus4": { "RecordTypeCode": "string" } } ], "TimeZone": { "Name": "string", "Offset": "string", "OffsetSeconds": number }, "Title": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The response returns the following HTTP headers. ** [PricingBucket](#API_geoplaces_ReverseGeocode_ResponseSyntax) ** The pricing bucket for which the query is charged at. For more information on pricing, please visit [Amazon Location Service Pricing](https://aws.amazon.com/location/pricing/). The following data is returned in JSON format by the service. ** [ResultItems](#API_geoplaces_ReverseGeocode_ResponseSyntax) ** List of places or results returned for a query. Type: Array of [ReverseGeocodeResultItem](API_geoplaces_ReverseGeocodeResultItem.md) objects Array Members: Minimum number of 0 items. Maximum number of 100 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You don't have sufficient access to perform this action. HTTP Status Code: 403 ** InternalServerException ** The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ** ThrottlingException ** The request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the constraints specified by an AWS service. ** FieldList ** Test stub for FieldList. ** Reason ** Test stub for reason HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/geo-places-2020-11-19/ReverseGeocode) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/geo-places-2020-11-19/ReverseGeocode) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/geo-places-2020-11-19/ReverseGeocode) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/geo-places-2020-11-19/ReverseGeocode) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/geo-places-2020-11-19/ReverseGeocode) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/geo-places-2020-11-19/ReverseGeocode) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/geo-places-2020-11-19/ReverseGeocode) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/geo-places-2020-11-19/ReverseGeocode) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/geo-places-2020-11-19/ReverseGeocode) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/geo-places-2020-11-19/ReverseGeocode) # SearchNearby `SearchNearby` queries for points of interest within a radius from a central coordinates, returning place results with optional filters such as categories, business chains, food types and more. The API returns details such as a place name, address, phone, category, food type, contact, opening hours. Also, the API can return phonemes, time zones and more based on requested parameters. For more information, see [Search Nearby](https://docs.aws.amazon.com/location/latest/developerguide/search-nearby.html) in the *Amazon Location Service Developer Guide*. ## Request Syntax ``` POST /search-nearby?key=Key HTTP/1.1 Content-type: application/json { "AdditionalFeatures": [ "string" ], "Filter": { "BoundingBox": [ number ], "ExcludeBusinessChains": [ "string" ], "ExcludeCategories": [ "string" ], "ExcludeFoodTypes": [ "string" ], "IncludeBusinessChains": [ "string" ], "IncludeCategories": [ "string" ], "IncludeCountries": [ "string" ], "IncludeFoodTypes": [ "string" ] }, "IntendedUse": "string", "Language": "string", "MaxResults": number, "NextToken": "string", "PoliticalView": "string", "QueryPosition": [ number ], "QueryRadius": number } ``` ## URI Request Parameters The request uses the following URI parameters. ** [Key](#API_geoplaces_SearchNearby_RequestSyntax) ** Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request. Length Constraints: Minimum length of 0. Maximum length of 1000. ## Request Body The request accepts the following data in JSON format. ** [AdditionalFeatures](#API_geoplaces_SearchNearby_RequestSyntax) ** A list of optional additional parameters, such as time zone, that can be requested for each result. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 4 items. Valid Values: `TimeZone | Phonemes | Access | Contact` Required: No ** [Filter](#API_geoplaces_SearchNearby_RequestSyntax) ** A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result. Type: [SearchNearbyFilter](API_geoplaces_SearchNearbyFilter.md) object Required: No ** [IntendedUse](#API_geoplaces_SearchNearby_RequestSyntax) ** Indicates if the query results will be persisted in customer infrastructure. Defaults to `SingleUse` (not stored). Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. When storing `SearchNearby` responses, you *must* set this field to `Storage` to comply with the terms of service. These requests will be charged at a higher rate. Please review the [user agreement](https://aws.amazon.com/location/sla/) and [service pricing structure](https://aws.amazon.com/location/pricing/) to determine the correct setting for your use case. Type: String Valid Values: `SingleUse | Storage` Required: No ** [Language](#API_geoplaces_SearchNearby_RequestSyntax) ** A list of [BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry. Type: String Length Constraints: Minimum length of 2. Maximum length of 35. Required: No ** [MaxResults](#API_geoplaces_SearchNearby_RequestSyntax) ** An optional limit for the number of results returned in a single call. Default value: 20 Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_geoplaces_SearchNearby_RequestSyntax) ** If `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. Required: No ** [PoliticalView](#API_geoplaces_SearchNearby_RequestSyntax) ** The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country. Type: String Length Constraints: Minimum length of 2. Maximum length of 3. Pattern: `([A-Z]{2}|[A-Z]{3})` Required: No ** [QueryPosition](#API_geoplaces_SearchNearby_RequestSyntax) ** The position in World Geodetic System (WGS 84) format: [longitude, latitude] for which you are querying nearby results for. Results closer to the position will be ranked higher then results further away from the position Type: Array of doubles Array Members: Fixed number of 2 items. Required: Yes ** [QueryRadius](#API_geoplaces_SearchNearby_RequestSyntax) ** The maximum distance in meters from the QueryPosition from which a result will be returned. The fields `QueryText`, and `QueryID` are mutually exclusive. Type: Long Valid Range: Minimum value of 1. Maximum value of 21000000. Required: No ## Response Syntax ``` HTTP/1.1 200 x-amz-geo-pricing-bucket: PricingBucket Content-type: application/json { "NextToken": "string", "ResultItems": [ { "AccessPoints": [ { "Position": [ number ] } ], "AccessRestrictions": [ { "Categories": [ { "Id": "string", "LocalizedName": "string", "Name": "string", "Primary": boolean } ], "Restricted": boolean } ], "Address": { "AddressNumber": "string", "Block": "string", "Building": "string", "Country": { "Code2": "string", "Code3": "string", "Name": "string" }, "District": "string", "Intersection": [ "string" ], "Label": "string", "Locality": "string", "PostalCode": "string", "Region": { "Code": "string", "Name": "string" }, "SecondaryAddressComponents": [ { "Designator": "string", "Number": "string" } ], "Street": "string", "StreetComponents": [ { "BaseName": "string", "Direction": "string", "Language": "string", "Prefix": "string", "Suffix": "string", "Type": "string", "TypePlacement": "string", "TypeSeparator": "string" } ], "SubBlock": "string", "SubDistrict": "string", "SubRegion": { "Code": "string", "Name": "string" } }, "AddressNumberCorrected": boolean, "BusinessChains": [ { "Id": "string", "Name": "string" } ], "Categories": [ { "Id": "string", "LocalizedName": "string", "Name": "string", "Primary": boolean } ], "Contacts": { "Emails": [ { "Categories": [ { "Id": "string", "LocalizedName": "string", "Name": "string", "Primary": boolean } ], "Label": "string", "Value": "string" } ], "Faxes": [ { "Categories": [ { "Id": "string", "LocalizedName": "string", "Name": "string", "Primary": boolean } ], "Label": "string", "Value": "string" } ], "Phones": [ { "Categories": [ { "Id": "string", "LocalizedName": "string", "Name": "string", "Primary": boolean } ], "Label": "string", "Value": "string" } ], "Websites": [ { "Categories": [ { "Id": "string", "LocalizedName": "string", "Name": "string", "Primary": boolean } ], "Label": "string", "Value": "string" } ] }, "Distance": number, "FoodTypes": [ { "Id": "string", "LocalizedName": "string", "Primary": boolean } ], "MapView": [ number ], "OpeningHours": [ { "Categories": [ { "Id": "string", "LocalizedName": "string", "Name": "string", "Primary": boolean } ], "Components": [ { "OpenDuration": "string", "OpenTime": "string", "Recurrence": "string" } ], "Display": [ "string" ], "OpenNow": boolean } ], "Phonemes": { "Address": { "Block": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ], "Country": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ], "District": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ], "Locality": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ], "Region": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ], "Street": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ], "SubBlock": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ], "SubDistrict": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ], "SubRegion": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ] }, "Title": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ] }, "PlaceId": "string", "PlaceType": "string", "PoliticalView": "string", "Position": [ number ], "TimeZone": { "Name": "string", "Offset": "string", "OffsetSeconds": number }, "Title": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The response returns the following HTTP headers. ** [PricingBucket](#API_geoplaces_SearchNearby_ResponseSyntax) ** The pricing bucket for which the query is charged at. For more information on pricing, please visit [Amazon Location Service Pricing](https://aws.amazon.com/location/pricing/). The following data is returned in JSON format by the service. ** [NextToken](#API_geoplaces_SearchNearby_ResponseSyntax) ** If `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. ** [ResultItems](#API_geoplaces_SearchNearby_ResponseSyntax) ** List of places or results returned for a query. Type: Array of [SearchNearbyResultItem](API_geoplaces_SearchNearbyResultItem.md) objects Array Members: Minimum number of 0 items. Maximum number of 100 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You don't have sufficient access to perform this action. HTTP Status Code: 403 ** InternalServerException ** The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ** ThrottlingException ** The request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the constraints specified by an AWS service. ** FieldList ** Test stub for FieldList. ** Reason ** Test stub for reason HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/geo-places-2020-11-19/SearchNearby) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/geo-places-2020-11-19/SearchNearby) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/geo-places-2020-11-19/SearchNearby) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/geo-places-2020-11-19/SearchNearby) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/geo-places-2020-11-19/SearchNearby) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/geo-places-2020-11-19/SearchNearby) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/geo-places-2020-11-19/SearchNearby) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/geo-places-2020-11-19/SearchNearby) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/geo-places-2020-11-19/SearchNearby) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/geo-places-2020-11-19/SearchNearby) # SearchText `SearchText` searches for geocode and place information. You can then complete a follow-up query suggested from the `Suggest` API via a query id. For more information, see [Search Text](https://docs.aws.amazon.com/location/latest/developerguide/search-text.html) in the *Amazon Location Service Developer Guide*. ## Request Syntax ``` POST /search-text?key=Key HTTP/1.1 Content-type: application/json { "AdditionalFeatures": [ "string" ], "BiasPosition": [ number ], "Filter": { "BoundingBox": [ number ], "Circle": { "Center": [ number ], "Radius": number }, "IncludeCountries": [ "string" ] }, "IntendedUse": "string", "Language": "string", "MaxResults": number, "NextToken": "string", "PoliticalView": "string", "QueryId": "string", "QueryText": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [Key](#API_geoplaces_SearchText_RequestSyntax) ** Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request. Length Constraints: Minimum length of 0. Maximum length of 1000. ## Request Body The request accepts the following data in JSON format. ** [AdditionalFeatures](#API_geoplaces_SearchText_RequestSyntax) ** A list of optional additional parameters, such as time zone, that can be requested for each result. For [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers, `ap-southeast-1` and `ap-southeast-5` regions support only the `TimeZone` value. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 4 items. Valid Values: `TimeZone | Phonemes | Access | Contact` Required: No ** [BiasPosition](#API_geoplaces_SearchText_RequestSyntax) ** The position, in longitude and latitude, that the results should be close to. Typically, place results returned are ranked higher the closer they are to this position. Stored in `[lng, lat]` and in the WGS 84 format. Exactly one of the following fields must be set: `BiasPosition`, `Filter.BoundingBox`, or `Filter.Circle`. Type: Array of doubles Array Members: Fixed number of 2 items. Required: No ** [Filter](#API_geoplaces_SearchText_RequestSyntax) ** A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result. Type: [SearchTextFilter](API_geoplaces_SearchTextFilter.md) object Required: No ** [IntendedUse](#API_geoplaces_SearchText_RequestSyntax) ** Indicates if the query results will be persisted in customer infrastructure. Defaults to `SingleUse` (not stored). When storing `SearchText` responses, you *must* set this field to `Storage` to comply with the terms of service. These requests will be charged at a higher rate. Please review the [user agreement](https://aws.amazon.com/location/sla/) and [service pricing structure](https://aws.amazon.com/location/pricing/) to determine the correct setting for your use case. Type: String Valid Values: `SingleUse | Storage` Required: No ** [Language](#API_geoplaces_SearchText_RequestSyntax) ** A list of [BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry. For [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers, `ap-southeast-1` and `ap-southeast-5` regions support only the following codes: `en, id, km, lo, ms, my, pt, th, tl, vi, zh` Type: String Length Constraints: Minimum length of 2. Maximum length of 35. Required: No ** [MaxResults](#API_geoplaces_SearchText_RequestSyntax) ** An optional limit for the number of results returned in a single call. Default value: 20 Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_geoplaces_SearchText_RequestSyntax) ** If `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. Required: No ** [PoliticalView](#API_geoplaces_SearchText_RequestSyntax) ** The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country. Not available in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. Type: String Length Constraints: Minimum length of 2. Maximum length of 3. Pattern: `([A-Z]{2}|[A-Z]{3})` Required: No ** [QueryId](#API_geoplaces_SearchText_RequestSyntax) ** The query Id returned by the suggest API. If passed in the request, the SearchText API will preform a SearchText query with the improved query terms for the original query made to the suggest API. Not available in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. Exactly one of the following fields must be set: `QueryText` or `QueryId`. Type: String Length Constraints: Minimum length of 1. Maximum length of 500. Required: No ** [QueryText](#API_geoplaces_SearchText_RequestSyntax) ** The free-form text query to match addresses against. This is usually a partially typed address from an end user in an address box or form. Exactly one of the following fields must be set: `QueryText` or `QueryId`. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Required: No ## Response Syntax ``` HTTP/1.1 200 x-amz-geo-pricing-bucket: PricingBucket Content-type: application/json { "NextToken": "string", "ResultItems": [ { "AccessPoints": [ { "Position": [ number ] } ], "AccessRestrictions": [ { "Categories": [ { "Id": "string", "LocalizedName": "string", "Name": "string", "Primary": boolean } ], "Restricted": boolean } ], "Address": { "AddressNumber": "string", "Block": "string", "Building": "string", "Country": { "Code2": "string", "Code3": "string", "Name": "string" }, "District": "string", "Intersection": [ "string" ], "Label": "string", "Locality": "string", "PostalCode": "string", "Region": { "Code": "string", "Name": "string" }, "SecondaryAddressComponents": [ { "Designator": "string", "Number": "string" } ], "Street": "string", "StreetComponents": [ { "BaseName": "string", "Direction": "string", "Language": "string", "Prefix": "string", "Suffix": "string", "Type": "string", "TypePlacement": "string", "TypeSeparator": "string" } ], "SubBlock": "string", "SubDistrict": "string", "SubRegion": { "Code": "string", "Name": "string" } }, "AddressNumberCorrected": boolean, "BusinessChains": [ { "Id": "string", "Name": "string" } ], "Categories": [ { "Id": "string", "LocalizedName": "string", "Name": "string", "Primary": boolean } ], "Contacts": { "Emails": [ { "Categories": [ { "Id": "string", "LocalizedName": "string", "Name": "string", "Primary": boolean } ], "Label": "string", "Value": "string" } ], "Faxes": [ { "Categories": [ { "Id": "string", "LocalizedName": "string", "Name": "string", "Primary": boolean } ], "Label": "string", "Value": "string" } ], "Phones": [ { "Categories": [ { "Id": "string", "LocalizedName": "string", "Name": "string", "Primary": boolean } ], "Label": "string", "Value": "string" } ], "Websites": [ { "Categories": [ { "Id": "string", "LocalizedName": "string", "Name": "string", "Primary": boolean } ], "Label": "string", "Value": "string" } ] }, "Distance": number, "FoodTypes": [ { "Id": "string", "LocalizedName": "string", "Primary": boolean } ], "MapView": [ number ], "OpeningHours": [ { "Categories": [ { "Id": "string", "LocalizedName": "string", "Name": "string", "Primary": boolean } ], "Components": [ { "OpenDuration": "string", "OpenTime": "string", "Recurrence": "string" } ], "Display": [ "string" ], "OpenNow": boolean } ], "Phonemes": { "Address": { "Block": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ], "Country": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ], "District": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ], "Locality": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ], "Region": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ], "Street": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ], "SubBlock": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ], "SubDistrict": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ], "SubRegion": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ] }, "Title": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ] }, "PlaceId": "string", "PlaceType": "string", "PoliticalView": "string", "Position": [ number ], "TimeZone": { "Name": "string", "Offset": "string", "OffsetSeconds": number }, "Title": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The response returns the following HTTP headers. ** [PricingBucket](#API_geoplaces_SearchText_ResponseSyntax) ** The pricing bucket for which the query is charged at. For more information on pricing, please visit [Amazon Location Service Pricing](https://aws.amazon.com/location/pricing/). The following data is returned in JSON format by the service. ** [NextToken](#API_geoplaces_SearchText_ResponseSyntax) ** If `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. ** [ResultItems](#API_geoplaces_SearchText_ResponseSyntax) ** List of places or results returned for a query. Type: Array of [SearchTextResultItem](API_geoplaces_SearchTextResultItem.md) objects Array Members: Minimum number of 0 items. Maximum number of 100 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You don't have sufficient access to perform this action. HTTP Status Code: 403 ** InternalServerException ** The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ** ThrottlingException ** The request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the constraints specified by an AWS service. ** FieldList ** Test stub for FieldList. ** Reason ** Test stub for reason HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/geo-places-2020-11-19/SearchText) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/geo-places-2020-11-19/SearchText) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/geo-places-2020-11-19/SearchText) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/geo-places-2020-11-19/SearchText) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/geo-places-2020-11-19/SearchText) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/geo-places-2020-11-19/SearchText) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/geo-places-2020-11-19/SearchText) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/geo-places-2020-11-19/SearchText) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/geo-places-2020-11-19/SearchText) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/geo-places-2020-11-19/SearchText) # Suggest `Suggest` provides intelligent predictions or recommendations based on the user's input or context, such as relevant places, points of interest, query terms or search category. It is designed to help users find places or point of interests candidates or identify a follow on query based on incomplete or misspelled queries. It returns a list of possible matches or refinements that can be used to formulate a more accurate query. Users can select the most appropriate suggestion and use it for further searching. The API provides options for filtering results by location and other attributes, and allows for additional features like phonemes and timezones. The response includes refined query terms and detailed place information. For more information, see [Suggest](https://docs.aws.amazon.com/location/latest/developerguide/suggest.html) in the *Amazon Location Service Developer Guide*. ## Request Syntax ``` POST /suggest?key=Key HTTP/1.1 Content-type: application/json { "AdditionalFeatures": [ "string" ], "BiasPosition": [ number ], "Filter": { "BoundingBox": [ number ], "Circle": { "Center": [ number ], "Radius": number }, "IncludeCountries": [ "string" ] }, "IntendedUse": "string", "Language": "string", "MaxQueryRefinements": number, "MaxResults": number, "PoliticalView": "string", "QueryText": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [Key](#API_geoplaces_Suggest_RequestSyntax) ** Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request. Length Constraints: Minimum length of 0. Maximum length of 1000. ## Request Body The request accepts the following data in JSON format. ** [AdditionalFeatures](#API_geoplaces_Suggest_RequestSyntax) ** A list of optional additional parameters, such as time zone, that can be requested for each result. For [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers, `ap-southeast-1` and `ap-southeast-5` regions support only the `Core` and `TimeZone` values. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 4 items. Valid Values: `Core | TimeZone | Phonemes | Access` Required: No ** [BiasPosition](#API_geoplaces_Suggest_RequestSyntax) ** The position, in longitude and latitude, that the results should be close to. Typically, place results returned are ranked higher the closer they are to this position. Stored in `[lng, lat]` and in the WGS 84 format. The fields `BiasPosition`, `FilterBoundingBox`, and `FilterCircle` are mutually exclusive. Type: Array of doubles Array Members: Fixed number of 2 items. Required: No ** [Filter](#API_geoplaces_Suggest_RequestSyntax) ** A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result. Type: [SuggestFilter](API_geoplaces_SuggestFilter.md) object Required: No ** [IntendedUse](#API_geoplaces_Suggest_RequestSyntax) ** Indicates if the query results will be persisted in customer infrastructure. Defaults to `SingleUse` (not stored). Currently, `Suggest` does not support storage of results. Type: String Valid Values: `SingleUse` Required: No ** [Language](#API_geoplaces_Suggest_RequestSyntax) ** A list of [BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry. For [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers, `ap-southeast-1` and `ap-southeast-5` regions support only the following codes: `en, id, km, lo, ms, my, pt, th, tl, vi, zh` Type: String Length Constraints: Minimum length of 2. Maximum length of 35. Required: No ** [MaxQueryRefinements](#API_geoplaces_Suggest_RequestSyntax) ** Maximum number of query terms to be returned for use with a search text query. Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. Type: Integer Valid Range: Minimum value of 1. Maximum value of 10. Required: No ** [MaxResults](#API_geoplaces_Suggest_RequestSyntax) ** An optional limit for the number of results returned in a single call. Default value: 20 Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [PoliticalView](#API_geoplaces_Suggest_RequestSyntax) ** The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country. Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. Type: String Length Constraints: Minimum length of 2. Maximum length of 3. Pattern: `([A-Z]{2}|[A-Z]{3})` Required: No ** [QueryText](#API_geoplaces_Suggest_RequestSyntax) ** The free-form text query to match addresses against. This is usually a partially typed address from an end user in an address box or form. The fields `QueryText` and `QueryID` are mutually exclusive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Required: Yes ## Response Syntax ``` HTTP/1.1 200 x-amz-geo-pricing-bucket: PricingBucket Content-type: application/json { "QueryRefinements": [ { "EndIndex": number, "OriginalTerm": "string", "RefinedTerm": "string", "StartIndex": number } ], "ResultItems": [ { "Highlights": { "Address": { "Label": [ { "EndIndex": number, "StartIndex": number, "Value": "string" } ] }, "Title": [ { "EndIndex": number, "StartIndex": number, "Value": "string" } ] }, "Place": { "AccessPoints": [ { "Position": [ number ] } ], "AccessRestrictions": [ { "Categories": [ { "Id": "string", "LocalizedName": "string", "Name": "string", "Primary": boolean } ], "Restricted": boolean } ], "Address": { "AddressNumber": "string", "Block": "string", "Building": "string", "Country": { "Code2": "string", "Code3": "string", "Name": "string" }, "District": "string", "Intersection": [ "string" ], "Label": "string", "Locality": "string", "PostalCode": "string", "Region": { "Code": "string", "Name": "string" }, "SecondaryAddressComponents": [ { "Designator": "string", "Number": "string" } ], "Street": "string", "StreetComponents": [ { "BaseName": "string", "Direction": "string", "Language": "string", "Prefix": "string", "Suffix": "string", "Type": "string", "TypePlacement": "string", "TypeSeparator": "string" } ], "SubBlock": "string", "SubDistrict": "string", "SubRegion": { "Code": "string", "Name": "string" } }, "BusinessChains": [ { "Id": "string", "Name": "string" } ], "Categories": [ { "Id": "string", "LocalizedName": "string", "Name": "string", "Primary": boolean } ], "Distance": number, "FoodTypes": [ { "Id": "string", "LocalizedName": "string", "Primary": boolean } ], "MapView": [ number ], "Phonemes": { "Address": { "Block": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ], "Country": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ], "District": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ], "Locality": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ], "Region": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ], "Street": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ], "SubBlock": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ], "SubDistrict": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ], "SubRegion": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ] }, "Title": [ { "Language": "string", "Preferred": boolean, "Value": "string" } ] }, "PlaceId": "string", "PlaceType": "string", "PoliticalView": "string", "Position": [ number ], "TimeZone": { "Name": "string", "Offset": "string", "OffsetSeconds": number } }, "Query": { "QueryId": "string", "QueryType": "string" }, "SuggestResultItemType": "string", "Title": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The response returns the following HTTP headers. ** [PricingBucket](#API_geoplaces_Suggest_ResponseSyntax) ** The pricing bucket for which the query is charged at. For more information on pricing, please visit [Amazon Location Service Pricing](https://aws.amazon.com/location/pricing/). The following data is returned in JSON format by the service. ** [QueryRefinements](#API_geoplaces_Suggest_ResponseSyntax) ** Maximum number of query terms to be returned for use with a search text query. Not available in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. Type: Array of [QueryRefinement](API_geoplaces_QueryRefinement.md) objects Array Members: Minimum number of 0 items. Maximum number of 10 items. ** [ResultItems](#API_geoplaces_Suggest_ResponseSyntax) ** List of places or results returned for a query. Type: Array of [SuggestResultItem](API_geoplaces_SuggestResultItem.md) objects Array Members: Minimum number of 0 items. Maximum number of 100 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You don't have sufficient access to perform this action. HTTP Status Code: 403 ** InternalServerException ** The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ** ThrottlingException ** The request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The input fails to satisfy the constraints specified by an AWS service. ** FieldList ** Test stub for FieldList. ** Reason ** Test stub for reason HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/geo-places-2020-11-19/Suggest) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/geo-places-2020-11-19/Suggest) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/geo-places-2020-11-19/Suggest) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/geo-places-2020-11-19/Suggest) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/geo-places-2020-11-19/Suggest) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/geo-places-2020-11-19/Suggest) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/geo-places-2020-11-19/Suggest) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/geo-places-2020-11-19/Suggest) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/geo-places-2020-11-19/Suggest) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/geo-places-2020-11-19/Suggest) # Amazon Location Service Tagging The following actions are supported by Amazon Location Service Tagging: + [CreateKey](API_geotags_CreateKey.md) + [DeleteKey](API_geotags_DeleteKey.md) + [DescribeKey](API_geotags_DescribeKey.md) + [ListKeys](API_geotags_ListKeys.md) + [ListTagsForResource](API_geotags_ListTagsForResource.md) + [TagResource](API_geotags_TagResource.md) + [UntagResource](API_geotags_UntagResource.md) + [UpdateKey](API_geotags_UpdateKey.md) # CreateKey Creates an API key resource in your AWS account, which lets you grant actions for Amazon Location resources to the API key bearer. For more information, see [Use API keys to authenticate](https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html) in the *Amazon Location Service Developer Guide*. ## Request Syntax ``` POST /metadata/v0/keys HTTP/1.1 Content-type: application/json { "Description": "string", "ExpireTime": "string", "KeyName": "string", "NoExpiry": boolean, "Restrictions": { "AllowActions": [ "string" ], "AllowAndroidApps": [ { "CertificateFingerprint": "string", "Package": "string" } ], "AllowAppleApps": [ { "BundleId": "string" } ], "AllowReferers": [ "string" ], "AllowResources": [ "string" ] }, "Tags": { "string" : "string" } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [Description](#API_geotags_CreateKey_RequestSyntax) ** An optional description for the API key resource. Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. Required: No ** [ExpireTime](#API_geotags_CreateKey_RequestSyntax) ** The optional timestamp for when the API key resource will expire in [ ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sss`. One of `NoExpiry` or `ExpireTime` must be set. Type: Timestamp Required: No ** [KeyName](#API_geotags_CreateKey_RequestSyntax) ** A custom name for the API key resource. Requirements: + Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (\$1). + Must be a unique API key name. + No spaces allowed. For example, `ExampleAPIKey`. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` Required: Yes ** [NoExpiry](#API_geotags_CreateKey_RequestSyntax) ** Optionally set to `true` to set no expiration time for the API key. One of `NoExpiry` or `ExpireTime` must be set. Type: Boolean Required: No ** [Restrictions](#API_geotags_CreateKey_RequestSyntax) ** The API key restrictions for the API key resource. Type: [ApiKeyRestrictions](API_geotags_ApiKeyRestrictions.md) object Required: Yes ** [Tags](#API_geotags_CreateKey_RequestSyntax) ** Applies one or more tags to the map resource. A tag is a key-value pair that 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: \$1 - = . \$1 : / @. + Cannot use `"aws:"` as a prefix for a key. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)` Value Length Constraints: Minimum length of 0. Maximum length of 256. Value Pattern: `([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CreateTime": "string", "Key": "string", "KeyArn": "string", "KeyName": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreateTime](#API_geotags_CreateKey_ResponseSyntax) ** The timestamp for when the API key resource was created in [ ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sss`. Type: Timestamp ** [Key](#API_geotags_CreateKey_ResponseSyntax) ** The key value/string of an API key. This value is used when making API calls to authorize the call. For example, see [GetMapGlyphs](https://docs.aws.amazon.com/location/previous/APIReference/API_GetMapGlyphs.html). Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. ** [KeyArn](#API_geotags_CreateKey_ResponseSyntax) ** The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all AWS. + Format example: `arn:aws:geo:region:account-id:key/ExampleKey` Type: String Length Constraints: Minimum length of 0. Maximum length of 1600. Pattern: `arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?` ** [KeyName](#API_geotags_CreateKey_ResponseSyntax) ** The name of the API key resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** ConflictException ** HTTP Status Code: 409 ** InternalServerException ** HTTP Status Code: 500 ** ServiceQuotaExceededException ** HTTP Status Code: 402 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/geotags-2020-11-19/CreateKey) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/geotags-2020-11-19/CreateKey) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/geotags-2020-11-19/CreateKey) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/geotags-2020-11-19/CreateKey) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/geotags-2020-11-19/CreateKey) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/geotags-2020-11-19/CreateKey) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/geotags-2020-11-19/CreateKey) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/geotags-2020-11-19/CreateKey) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/geotags-2020-11-19/CreateKey) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/geotags-2020-11-19/CreateKey) # DeleteKey Deletes the specified API key. The API key must have been deactivated more than 90 days previously. For more information, see [Use API keys to authenticate](https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html) in the *Amazon Location Service Developer Guide*. ## Request Syntax ``` DELETE /metadata/v0/keys/KeyName?forceDelete=ForceDelete HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [ForceDelete](#API_geotags_DeleteKey_RequestSyntax) ** ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter `true` to delete the key or to `false` to not preemptively delete the API key. Valid values: `true`, or `false`. Required: No This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use. ** [KeyName](#API_geotags_DeleteKey_RequestSyntax) ** The name of the API key to delete. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/geotags-2020-11-19/DeleteKey) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/geotags-2020-11-19/DeleteKey) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/geotags-2020-11-19/DeleteKey) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/geotags-2020-11-19/DeleteKey) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/geotags-2020-11-19/DeleteKey) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/geotags-2020-11-19/DeleteKey) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/geotags-2020-11-19/DeleteKey) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/geotags-2020-11-19/DeleteKey) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/geotags-2020-11-19/DeleteKey) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/geotags-2020-11-19/DeleteKey) # DescribeKey Retrieves the API key resource details. For more information, see [Use API keys to authenticate](https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html) in the *Amazon Location Service Developer Guide*. ## Request Syntax ``` GET /metadata/v0/keys/KeyName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [KeyName](#API_geotags_DescribeKey_RequestSyntax) ** The name of the API key resource. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CreateTime": "string", "Description": "string", "ExpireTime": "string", "Key": "string", "KeyArn": "string", "KeyName": "string", "Restrictions": { "AllowActions": [ "string" ], "AllowAndroidApps": [ { "CertificateFingerprint": "string", "Package": "string" } ], "AllowAppleApps": [ { "BundleId": "string" } ], "AllowReferers": [ "string" ], "AllowResources": [ "string" ] }, "Tags": { "string" : "string" }, "UpdateTime": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreateTime](#API_geotags_DescribeKey_ResponseSyntax) ** The timestamp for when the API key resource was created in [ ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sss`. Type: Timestamp ** [Description](#API_geotags_DescribeKey_ResponseSyntax) ** The optional description for the API key resource. Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. ** [ExpireTime](#API_geotags_DescribeKey_ResponseSyntax) ** The timestamp for when the API key resource will expire in [ ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sss`. Type: Timestamp ** [Key](#API_geotags_DescribeKey_ResponseSyntax) ** The key value/string of an API key. Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. ** [KeyArn](#API_geotags_DescribeKey_ResponseSyntax) ** The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all AWS. + Format example: `arn:aws:geo:region:account-id:key/ExampleKey` Type: String Length Constraints: Minimum length of 0. Maximum length of 1600. Pattern: `arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?` ** [KeyName](#API_geotags_DescribeKey_ResponseSyntax) ** The name of the API key resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` ** [Restrictions](#API_geotags_DescribeKey_ResponseSyntax) ** API Restrictions on the allowed actions, resources, referers, Android apps, and Apple apps for an API key resource. Type: [ApiKeyRestrictions](API_geotags_ApiKeyRestrictions.md) object ** [Tags](#API_geotags_DescribeKey_ResponseSyntax) ** Tags associated with the API key resource. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)` Value Length Constraints: Minimum length of 0. Maximum length of 256. Value Pattern: `([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)` ** [UpdateTime](#API_geotags_DescribeKey_ResponseSyntax) ** The timestamp for when the API key resource was last updated in [ ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sss`. Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/geotags-2020-11-19/DescribeKey) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/geotags-2020-11-19/DescribeKey) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/geotags-2020-11-19/DescribeKey) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/geotags-2020-11-19/DescribeKey) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/geotags-2020-11-19/DescribeKey) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/geotags-2020-11-19/DescribeKey) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/geotags-2020-11-19/DescribeKey) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/geotags-2020-11-19/DescribeKey) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/geotags-2020-11-19/DescribeKey) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/geotags-2020-11-19/DescribeKey) # ListKeys Lists API key resources in your AWS account. For more information, see [Use API keys to authenticate](https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html) in the *Amazon Location Service Developer Guide*. ## Request Syntax ``` POST /metadata/v0/list-keys HTTP/1.1 Content-type: application/json { "Filter": { "KeyStatus": "string" }, "MaxResults": number, "NextToken": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [Filter](#API_geotags_ListKeys_RequestSyntax) ** Optionally filter the list to only `Active` or `Expired` API keys. Type: [ApiKeyFilter](API_geotags_ApiKeyFilter.md) object Required: No ** [MaxResults](#API_geotags_ListKeys_RequestSyntax) ** An optional limit for the number of resources returned in a single call. Default value: `100` Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_geotags_ListKeys_RequestSyntax) ** 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` Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Entries": [ { "CreateTime": "string", "Description": "string", "ExpireTime": "string", "KeyName": "string", "Restrictions": { "AllowActions": [ "string" ], "AllowAndroidApps": [ { "CertificateFingerprint": "string", "Package": "string" } ], "AllowAppleApps": [ { "BundleId": "string" } ], "AllowReferers": [ "string" ], "AllowResources": [ "string" ] }, "UpdateTime": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Entries](#API_geotags_ListKeys_ResponseSyntax) ** Contains API key resources in your AWS account. Details include API key name, allowed referers and timestamp for when the API key will expire. Type: Array of [ListKeysResponseEntry](API_geotags_ListKeysResponseEntry.md) objects ** [NextToken](#API_geotags_ListKeys_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/geotags-2020-11-19/ListKeys) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/geotags-2020-11-19/ListKeys) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/geotags-2020-11-19/ListKeys) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/geotags-2020-11-19/ListKeys) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/geotags-2020-11-19/ListKeys) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/geotags-2020-11-19/ListKeys) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/geotags-2020-11-19/ListKeys) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/geotags-2020-11-19/ListKeys) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/geotags-2020-11-19/ListKeys) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/geotags-2020-11-19/ListKeys) # ListTagsForResource Returns a list of tags that are applied to the specified Amazon Location resource. ## Request Syntax ``` GET /tags/ResourceArn HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [ResourceArn](#API_geotags_ListTagsForResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve. + Format example: `arn:aws:geo:region:account-id:resourcetype/ExampleResource` Length Constraints: Minimum length of 0. Maximum length of 1600. Pattern: `arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Tags](#API_geotags_ListTagsForResource_ResponseSyntax) ** 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"} ` Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)` Value Length Constraints: Minimum length of 0. Maximum length of 256. Value Pattern: `([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/geotags-2020-11-19/ListTagsForResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/geotags-2020-11-19/ListTagsForResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/geotags-2020-11-19/ListTagsForResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/geotags-2020-11-19/ListTagsForResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/geotags-2020-11-19/ListTagsForResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/geotags-2020-11-19/ListTagsForResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/geotags-2020-11-19/ListTagsForResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/geotags-2020-11-19/ListTagsForResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/geotags-2020-11-19/ListTagsForResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/geotags-2020-11-19/ListTagsForResource) # TagResource Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the `TagResource` operation with an Amazon Location Service resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the tags already associated with the resource. If you specify a tag key that's already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate up to 50 tags with a resource. ## Request Syntax ``` POST /tags/ResourceArn HTTP/1.1 Content-type: application/json { "Tags": { "string" : "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [ResourceArn](#API_geotags_TagResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the resource whose tags you want to update. + Format example: `arn:aws:geo:region:account-id:resourcetype/ExampleResource` Length Constraints: Minimum length of 0. Maximum length of 1600. Pattern: `arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Tags](#API_geotags_TagResource_RequestSyntax) ** 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: \$1 - = . \$1 : / @ + Cannot use `"aws:"` as a prefix for a key. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)` Value Length Constraints: Minimum length of 0. Maximum length of 256. Value Pattern: `([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)` Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/geotags-2020-11-19/TagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/geotags-2020-11-19/TagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/geotags-2020-11-19/TagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/geotags-2020-11-19/TagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/geotags-2020-11-19/TagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/geotags-2020-11-19/TagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/geotags-2020-11-19/TagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/geotags-2020-11-19/TagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/geotags-2020-11-19/TagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/geotags-2020-11-19/TagResource) # UntagResource Removes one or more tags from the specified Amazon Location resource. ## Request Syntax ``` DELETE /tags/ResourceArn?tagKeys=TagKeys HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [ResourceArn](#API_geotags_UntagResource_RequestSyntax) ** 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` Length Constraints: Minimum length of 0. Maximum length of 1600. Pattern: `arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?` Required: Yes ** [TagKeys](#API_geotags_UntagResource_RequestSyntax) ** The list of tag keys to remove from the specified resource. Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/geotags-2020-11-19/UntagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/geotags-2020-11-19/UntagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/geotags-2020-11-19/UntagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/geotags-2020-11-19/UntagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/geotags-2020-11-19/UntagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/geotags-2020-11-19/UntagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/geotags-2020-11-19/UntagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/geotags-2020-11-19/UntagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/geotags-2020-11-19/UntagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/geotags-2020-11-19/UntagResource) # UpdateKey Updates the specified properties of a given API key resource. ## Request Syntax ``` PATCH /metadata/v0/keys/KeyName HTTP/1.1 Content-type: application/json { "Description": "string", "ExpireTime": "string", "ForceUpdate": boolean, "NoExpiry": boolean, "Restrictions": { "AllowActions": [ "string" ], "AllowAndroidApps": [ { "CertificateFingerprint": "string", "Package": "string" } ], "AllowAppleApps": [ { "BundleId": "string" } ], "AllowReferers": [ "string" ], "AllowResources": [ "string" ] } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [KeyName](#API_geotags_UpdateKey_RequestSyntax) ** The name of the API key resource to update. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Description](#API_geotags_UpdateKey_RequestSyntax) ** Updates the description for the API key resource. Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. Required: No ** [ExpireTime](#API_geotags_UpdateKey_RequestSyntax) ** Updates the timestamp for when the API key resource will expire in [ ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sss`. Type: Timestamp Required: No ** [ForceUpdate](#API_geotags_UpdateKey_RequestSyntax) ** The boolean flag to be included for updating `ExpireTime` or `Restrictions` details. Must be set to `true` to update an API key resource that has been used in the past 7 days. `False` if force update is not preferred Default value: `False` Type: Boolean Required: No ** [NoExpiry](#API_geotags_UpdateKey_RequestSyntax) ** Whether the API key should expire. Set to `true` to set the API key to have no expiration time. Type: Boolean Required: No ** [Restrictions](#API_geotags_UpdateKey_RequestSyntax) ** Updates the API key restrictions for the API key resource. Type: [ApiKeyRestrictions](API_geotags_ApiKeyRestrictions.md) object Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "KeyArn": "string", "KeyName": "string", "UpdateTime": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [KeyArn](#API_geotags_UpdateKey_ResponseSyntax) ** The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all AWS. + Format example: `arn:aws:geo:region:account-id:key/ExampleKey` Type: String Length Constraints: Minimum length of 0. Maximum length of 1600. Pattern: `arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?` ** [KeyName](#API_geotags_UpdateKey_ResponseSyntax) ** The name of the API key resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` ** [UpdateTime](#API_geotags_UpdateKey_ResponseSyntax) ** The timestamp for when the API key resource was last updated in [ ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sss`. Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/geotags-2020-11-19/UpdateKey) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/geotags-2020-11-19/UpdateKey) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/geotags-2020-11-19/UpdateKey) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/geotags-2020-11-19/UpdateKey) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/geotags-2020-11-19/UpdateKey) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/geotags-2020-11-19/UpdateKey) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/geotags-2020-11-19/UpdateKey) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/geotags-2020-11-19/UpdateKey) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/geotags-2020-11-19/UpdateKey) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/geotags-2020-11-19/UpdateKey) # Amazon Location Service Geofences The following actions are supported by Amazon Location Service Geofences: + [BatchDeleteGeofence](API_WaypointGeofencing_BatchDeleteGeofence.md) + [BatchEvaluateGeofences](API_WaypointGeofencing_BatchEvaluateGeofences.md) + [BatchPutGeofence](API_WaypointGeofencing_BatchPutGeofence.md) + [CreateGeofenceCollection](API_WaypointGeofencing_CreateGeofenceCollection.md) + [DeleteGeofenceCollection](API_WaypointGeofencing_DeleteGeofenceCollection.md) + [DescribeGeofenceCollection](API_WaypointGeofencing_DescribeGeofenceCollection.md) + [ForecastGeofenceEvents](API_WaypointGeofencing_ForecastGeofenceEvents.md) + [GetGeofence](API_WaypointGeofencing_GetGeofence.md) + [ListGeofenceCollections](API_WaypointGeofencing_ListGeofenceCollections.md) + [ListGeofences](API_WaypointGeofencing_ListGeofences.md) + [PutGeofence](API_WaypointGeofencing_PutGeofence.md) + [UpdateGeofenceCollection](API_WaypointGeofencing_UpdateGeofenceCollection.md) # BatchDeleteGeofence Deletes a batch of geofences from a geofence collection. **Note** This operation deletes the resource permanently. ## Request Syntax ``` POST /geofencing/v0/collections/CollectionName/delete-geofences HTTP/1.1 Content-type: application/json { "GeofenceIds": [ "string" ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [CollectionName](#API_WaypointGeofencing_BatchDeleteGeofence_RequestSyntax) ** The geofence collection storing the geofences to be deleted. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [GeofenceIds](#API_WaypointGeofencing_BatchDeleteGeofence_RequestSyntax) ** The batch of geofences to be deleted. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\p{L}\p{N}]+` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Errors": [ { "Error": { "Code": "string", "Message": "string" }, "GeofenceId": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Errors](#API_WaypointGeofencing_BatchDeleteGeofence_ResponseSyntax) ** Contains error details for each geofence that failed to delete. Type: Array of [BatchDeleteGeofenceError](API_WaypointGeofencing_BatchDeleteGeofenceError.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waypointgeofencing-2020-11-19/BatchDeleteGeofence) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waypointgeofencing-2020-11-19/BatchDeleteGeofence) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waypointgeofencing-2020-11-19/BatchDeleteGeofence) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waypointgeofencing-2020-11-19/BatchDeleteGeofence) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waypointgeofencing-2020-11-19/BatchDeleteGeofence) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waypointgeofencing-2020-11-19/BatchDeleteGeofence) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waypointgeofencing-2020-11-19/BatchDeleteGeofence) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waypointgeofencing-2020-11-19/BatchDeleteGeofence) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waypointgeofencing-2020-11-19/BatchDeleteGeofence) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waypointgeofencing-2020-11-19/BatchDeleteGeofence) # BatchEvaluateGeofences Evaluates device positions against the geofence geometries from a given geofence collection. This operation always returns an empty response because geofences are asynchronously evaluated. The evaluation determines if the device has entered or exited a geofenced area, and then publishes one of the following events to Amazon EventBridge: + `ENTER` if Amazon Location determines that the tracked device has entered a geofenced area. + `EXIT` if Amazon Location determines that the tracked device has exited a geofenced area. **Note** The last geofence that a device was observed within is tracked for 30 days after the most recent device position update. **Note** Geofence evaluation uses the given device position. It does not account for the optional `Accuracy` of a `DevicePositionUpdate`. **Note** The `DeviceID` is used as a string to represent the device. You do not need to have a `Tracker` associated with the `DeviceID`. ## Request Syntax ``` POST /geofencing/v0/collections/CollectionName/positions HTTP/1.1 Content-type: application/json { "DevicePositionUpdates": [ { "Accuracy": { "Horizontal": number }, "DeviceId": "string", "Position": [ number ], "PositionProperties": { "string" : "string" }, "SampleTime": "string" } ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [CollectionName](#API_WaypointGeofencing_BatchEvaluateGeofences_RequestSyntax) ** The geofence collection used in evaluating the position of devices against its geofences. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [DevicePositionUpdates](#API_WaypointGeofencing_BatchEvaluateGeofences_RequestSyntax) ** Contains device details for each device to be evaluated against the given geofence collection. Type: Array of [DevicePositionUpdate](API_WaypointGeofencing_DevicePositionUpdate.md) objects Array Members: Minimum number of 1 item. Maximum number of 10 items. Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Errors": [ { "DeviceId": "string", "Error": { "Code": "string", "Message": "string" }, "SampleTime": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Errors](#API_WaypointGeofencing_BatchEvaluateGeofences_ResponseSyntax) ** Contains error details for each device that failed to evaluate its position against the given geofence collection. Type: Array of [BatchEvaluateGeofencesError](API_WaypointGeofencing_BatchEvaluateGeofencesError.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waypointgeofencing-2020-11-19/BatchEvaluateGeofences) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waypointgeofencing-2020-11-19/BatchEvaluateGeofences) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waypointgeofencing-2020-11-19/BatchEvaluateGeofences) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waypointgeofencing-2020-11-19/BatchEvaluateGeofences) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waypointgeofencing-2020-11-19/BatchEvaluateGeofences) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waypointgeofencing-2020-11-19/BatchEvaluateGeofences) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waypointgeofencing-2020-11-19/BatchEvaluateGeofences) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waypointgeofencing-2020-11-19/BatchEvaluateGeofences) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waypointgeofencing-2020-11-19/BatchEvaluateGeofences) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waypointgeofencing-2020-11-19/BatchEvaluateGeofences) # BatchPutGeofence A batch request for storing geofence geometries into a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request. ## Request Syntax ``` POST /geofencing/v0/collections/CollectionName/put-geofences HTTP/1.1 Content-type: application/json { "Entries": [ { "GeofenceId": "string", "GeofenceProperties": { "string" : "string" }, "Geometry": { "Circle": { "Center": [ number ], "Radius": number }, "Geobuf": blob, "MultiPolygon": [ [ [ [ number ] ] ] ], "Polygon": [ [ [ number ] ] ] } } ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [CollectionName](#API_WaypointGeofencing_BatchPutGeofence_RequestSyntax) ** The geofence collection storing the geofences. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Entries](#API_WaypointGeofencing_BatchPutGeofence_RequestSyntax) ** The batch of geofences to be stored in a geofence collection. Type: Array of [BatchPutGeofenceRequestEntry](API_WaypointGeofencing_BatchPutGeofenceRequestEntry.md) objects Array Members: Minimum number of 1 item. Maximum number of 10 items. Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Errors": [ { "Error": { "Code": "string", "Message": "string" }, "GeofenceId": "string" } ], "Successes": [ { "CreateTime": "string", "GeofenceId": "string", "UpdateTime": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Errors](#API_WaypointGeofencing_BatchPutGeofence_ResponseSyntax) ** Contains additional error details for each geofence that failed to be stored in a geofence collection. Type: Array of [BatchPutGeofenceError](API_WaypointGeofencing_BatchPutGeofenceError.md) objects ** [Successes](#API_WaypointGeofencing_BatchPutGeofence_ResponseSyntax) ** Contains each geofence that was successfully stored in a geofence collection. Type: Array of [BatchPutGeofenceSuccess](API_WaypointGeofencing_BatchPutGeofenceSuccess.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waypointgeofencing-2020-11-19/BatchPutGeofence) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waypointgeofencing-2020-11-19/BatchPutGeofence) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waypointgeofencing-2020-11-19/BatchPutGeofence) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waypointgeofencing-2020-11-19/BatchPutGeofence) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waypointgeofencing-2020-11-19/BatchPutGeofence) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waypointgeofencing-2020-11-19/BatchPutGeofence) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waypointgeofencing-2020-11-19/BatchPutGeofence) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waypointgeofencing-2020-11-19/BatchPutGeofence) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waypointgeofencing-2020-11-19/BatchPutGeofence) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waypointgeofencing-2020-11-19/BatchPutGeofence) # CreateGeofenceCollection Creates a geofence collection, which manages and stores geofences. ## Request Syntax ``` POST /geofencing/v0/collections HTTP/1.1 Content-type: application/json { "CollectionName": "string", "Description": "string", "KmsKeyId": "string", "PricingPlan": "string", "PricingPlanDataSource": "string", "Tags": { "string" : "string" } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [CollectionName](#API_WaypointGeofencing_CreateGeofenceCollection_RequestSyntax) ** A custom name for the geofence collection. Requirements: + Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (\$1). + Must be a unique geofence collection name. + No spaces allowed. For example, `ExampleGeofenceCollection`. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` Required: Yes ** [Description](#API_WaypointGeofencing_CreateGeofenceCollection_RequestSyntax) ** An optional description for the geofence collection. Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. Required: No ** [KmsKeyId](#API_WaypointGeofencing_CreateGeofenceCollection_RequestSyntax) ** A key identifier for an [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html). Enter a key ID, key ARN, alias name, or alias ARN. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ** [PricingPlan](#API_WaypointGeofencing_CreateGeofenceCollection_RequestSyntax) ** *This parameter has been deprecated.* No longer used. If included, the only allowed value is `RequestBasedUsage`. Type: String Valid Values: `RequestBasedUsage | MobileAssetTracking | MobileAssetManagement` Required: No ** [PricingPlanDataSource](#API_WaypointGeofencing_CreateGeofenceCollection_RequestSyntax) ** *This parameter has been deprecated.* This parameter is no longer used. Type: String Required: No ** [Tags](#API_WaypointGeofencing_CreateGeofenceCollection_RequestSyntax) ** 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: \$1 - = . \$1 : / @. + Cannot use `"aws:"` as a prefix for a key. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)` Value Length Constraints: Minimum length of 0. Maximum length of 256. Value Pattern: `([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CollectionArn": "string", "CollectionName": "string", "CreateTime": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CollectionArn](#API_WaypointGeofencing_CreateGeofenceCollection_ResponseSyntax) ** 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` Type: String Length Constraints: Minimum length of 0. Maximum length of 1600. Pattern: `arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?` ** [CollectionName](#API_WaypointGeofencing_CreateGeofenceCollection_ResponseSyntax) ** The name for the geofence collection. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` ** [CreateTime](#API_WaypointGeofencing_CreateGeofenceCollection_ResponseSyntax) ** The timestamp for when the geofence collection was created in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sss` Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** ConflictException ** HTTP Status Code: 409 ** InternalServerException ** HTTP Status Code: 500 ** ServiceQuotaExceededException ** HTTP Status Code: 402 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waypointgeofencing-2020-11-19/CreateGeofenceCollection) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waypointgeofencing-2020-11-19/CreateGeofenceCollection) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waypointgeofencing-2020-11-19/CreateGeofenceCollection) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waypointgeofencing-2020-11-19/CreateGeofenceCollection) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waypointgeofencing-2020-11-19/CreateGeofenceCollection) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waypointgeofencing-2020-11-19/CreateGeofenceCollection) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waypointgeofencing-2020-11-19/CreateGeofenceCollection) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waypointgeofencing-2020-11-19/CreateGeofenceCollection) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waypointgeofencing-2020-11-19/CreateGeofenceCollection) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waypointgeofencing-2020-11-19/CreateGeofenceCollection) # DeleteGeofenceCollection Deletes a geofence collection from your AWS account. **Note** This operation deletes the resource permanently. If the geofence collection is the target of a tracker resource, the devices will no longer be monitored. ## Request Syntax ``` DELETE /geofencing/v0/collections/CollectionName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [CollectionName](#API_WaypointGeofencing_DeleteGeofenceCollection_RequestSyntax) ** The name of the geofence collection to be deleted. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waypointgeofencing-2020-11-19/DeleteGeofenceCollection) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waypointgeofencing-2020-11-19/DeleteGeofenceCollection) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waypointgeofencing-2020-11-19/DeleteGeofenceCollection) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waypointgeofencing-2020-11-19/DeleteGeofenceCollection) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waypointgeofencing-2020-11-19/DeleteGeofenceCollection) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waypointgeofencing-2020-11-19/DeleteGeofenceCollection) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waypointgeofencing-2020-11-19/DeleteGeofenceCollection) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waypointgeofencing-2020-11-19/DeleteGeofenceCollection) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waypointgeofencing-2020-11-19/DeleteGeofenceCollection) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waypointgeofencing-2020-11-19/DeleteGeofenceCollection) # DescribeGeofenceCollection Retrieves the geofence collection details. ## Request Syntax ``` GET /geofencing/v0/collections/CollectionName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [CollectionName](#API_WaypointGeofencing_DescribeGeofenceCollection_RequestSyntax) ** The name of the geofence collection. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CollectionArn": "string", "CollectionName": "string", "CreateTime": "string", "Description": "string", "GeofenceCount": number, "KmsKeyId": "string", "PricingPlan": "string", "PricingPlanDataSource": "string", "Tags": { "string" : "string" }, "UpdateTime": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CollectionArn](#API_WaypointGeofencing_DescribeGeofenceCollection_ResponseSyntax) ** 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` Type: String Length Constraints: Minimum length of 0. Maximum length of 1600. Pattern: `arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?` ** [CollectionName](#API_WaypointGeofencing_DescribeGeofenceCollection_ResponseSyntax) ** The name of the geofence collection. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` ** [CreateTime](#API_WaypointGeofencing_DescribeGeofenceCollection_ResponseSyntax) ** The timestamp for when the geofence resource was created in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sss` Type: Timestamp ** [Description](#API_WaypointGeofencing_DescribeGeofenceCollection_ResponseSyntax) ** The optional description for the geofence collection. Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. ** [GeofenceCount](#API_WaypointGeofencing_DescribeGeofenceCollection_ResponseSyntax) ** The number of geofences in the geofence collection. Type: Integer Valid Range: Minimum value of 0. ** [KmsKeyId](#API_WaypointGeofencing_DescribeGeofenceCollection_ResponseSyntax) ** A key identifier for an [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) assigned to the Amazon Location resource Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ** [PricingPlan](#API_WaypointGeofencing_DescribeGeofenceCollection_ResponseSyntax) ** *This parameter has been deprecated.* No longer used. Always returns `RequestBasedUsage`. Type: String Valid Values: `RequestBasedUsage | MobileAssetTracking | MobileAssetManagement` ** [PricingPlanDataSource](#API_WaypointGeofencing_DescribeGeofenceCollection_ResponseSyntax) ** *This parameter has been deprecated.* No longer used. Always returns an empty string. Type: String ** [Tags](#API_WaypointGeofencing_DescribeGeofenceCollection_ResponseSyntax) ** Displays the key, value pairs of tags associated with this resource. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)` Value Length Constraints: Minimum length of 0. Maximum length of 256. Value Pattern: `([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)` ** [UpdateTime](#API_WaypointGeofencing_DescribeGeofenceCollection_ResponseSyntax) ** The timestamp for when the geofence collection was last updated in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sss` Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waypointgeofencing-2020-11-19/DescribeGeofenceCollection) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waypointgeofencing-2020-11-19/DescribeGeofenceCollection) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waypointgeofencing-2020-11-19/DescribeGeofenceCollection) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waypointgeofencing-2020-11-19/DescribeGeofenceCollection) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waypointgeofencing-2020-11-19/DescribeGeofenceCollection) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waypointgeofencing-2020-11-19/DescribeGeofenceCollection) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waypointgeofencing-2020-11-19/DescribeGeofenceCollection) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waypointgeofencing-2020-11-19/DescribeGeofenceCollection) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waypointgeofencing-2020-11-19/DescribeGeofenceCollection) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waypointgeofencing-2020-11-19/DescribeGeofenceCollection) # ForecastGeofenceEvents This action forecasts future geofence events that are likely to occur within a specified time horizon if a device continues moving at its current speed. Each forecasted event is associated with a geofence from a provided geofence collection. A forecast event can have one of the following states: `ENTER`: The device position is outside the referenced geofence, but the device may cross into the geofence during the forecasting time horizon if it maintains its current speed. `EXIT`: The device position is inside the referenced geofence, but the device may leave the geofence during the forecasted time horizon if the device maintains it's current speed. `IDLE`:The device is inside the geofence, and it will remain inside the geofence through the end of the time horizon if the device maintains it's current speed. **Note** Heading direction is not considered in the current version. The API takes a conservative approach and includes events that can occur for any heading. ## Request Syntax ``` POST /geofencing/v0/collections/CollectionName/forecast-geofence-events HTTP/1.1 Content-type: application/json { "DeviceState": { "Position": [ number ], "Speed": number }, "DistanceUnit": "string", "MaxResults": number, "NextToken": "string", "SpeedUnit": "string", "TimeHorizonMinutes": number } ``` ## URI Request Parameters The request uses the following URI parameters. ** [CollectionName](#API_WaypointGeofencing_ForecastGeofenceEvents_RequestSyntax) ** The name of the geofence collection. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [DeviceState](#API_WaypointGeofencing_ForecastGeofenceEvents_RequestSyntax) ** Represents the device's state, including its current position and speed. When speed is omitted, this API performs a *containment check*. The *containment check* operation returns `IDLE` events for geofences where the device is currently inside of, but no other events. Type: [ForecastGeofenceEventsDeviceState](API_WaypointGeofencing_ForecastGeofenceEventsDeviceState.md) object Required: Yes ** [DistanceUnit](#API_WaypointGeofencing_ForecastGeofenceEvents_RequestSyntax) ** The distance unit used for the `NearestDistance` property returned in a forecasted event. The measurement system must match for `DistanceUnit` and `SpeedUnit`; if `Kilometers` is specified for `DistanceUnit`, then `SpeedUnit` must be `KilometersPerHour`. Default Value: `Kilometers` Type: String Valid Values: `Kilometers | Miles` Required: No ** [MaxResults](#API_WaypointGeofencing_ForecastGeofenceEvents_RequestSyntax) ** An optional limit for the number of resources returned in a single call. Default value: `20` Type: Integer Valid Range: Minimum value of 1. Maximum value of 20. Required: No ** [NextToken](#API_WaypointGeofencing_ForecastGeofenceEvents_RequestSyntax) ** 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` Type: String Length Constraints: Minimum length of 1. Maximum length of 60000. Required: No ** [SpeedUnit](#API_WaypointGeofencing_ForecastGeofenceEvents_RequestSyntax) ** The speed unit for the device captured by the device state. The measurement system must match for `DistanceUnit` and `SpeedUnit`; if `Kilometers` is specified for `DistanceUnit`, then `SpeedUnit` must be `KilometersPerHour`. Default Value: `KilometersPerHour`. Type: String Valid Values: `KilometersPerHour | MilesPerHour` Required: No ** [TimeHorizonMinutes](#API_WaypointGeofencing_ForecastGeofenceEvents_RequestSyntax) ** The forward-looking time window for forecasting, specified in minutes. The API only returns events that are predicted to occur within this time horizon. When no value is specified, this API performs a *containment check*. The *containment check* operation returns `IDLE` events for geofences where the device is currently inside of, but no other events. Type: Double Valid Range: Minimum value of 0. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "DistanceUnit": "string", "ForecastedEvents": [ { "EventId": "string", "EventType": "string", "ForecastedBreachTime": "string", "GeofenceId": "string", "GeofenceProperties": { "string" : "string" }, "IsDeviceInGeofence": boolean, "NearestDistance": number } ], "NextToken": "string", "SpeedUnit": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DistanceUnit](#API_WaypointGeofencing_ForecastGeofenceEvents_ResponseSyntax) ** The distance unit for the forecasted events. Type: String Valid Values: `Kilometers | Miles` ** [ForecastedEvents](#API_WaypointGeofencing_ForecastGeofenceEvents_ResponseSyntax) ** The list of forecasted events. Type: Array of [ForecastedEvent](API_WaypointGeofencing_ForecastedEvent.md) objects ** [NextToken](#API_WaypointGeofencing_ForecastGeofenceEvents_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 60000. ** [SpeedUnit](#API_WaypointGeofencing_ForecastGeofenceEvents_ResponseSyntax) ** The speed unit for the forecasted events. Type: String Valid Values: `KilometersPerHour | MilesPerHour` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waypointgeofencing-2020-11-19/ForecastGeofenceEvents) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waypointgeofencing-2020-11-19/ForecastGeofenceEvents) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waypointgeofencing-2020-11-19/ForecastGeofenceEvents) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waypointgeofencing-2020-11-19/ForecastGeofenceEvents) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waypointgeofencing-2020-11-19/ForecastGeofenceEvents) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waypointgeofencing-2020-11-19/ForecastGeofenceEvents) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waypointgeofencing-2020-11-19/ForecastGeofenceEvents) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waypointgeofencing-2020-11-19/ForecastGeofenceEvents) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waypointgeofencing-2020-11-19/ForecastGeofenceEvents) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waypointgeofencing-2020-11-19/ForecastGeofenceEvents) # GetGeofence Retrieves the geofence details from a geofence collection. **Note** The returned geometry will always match the geometry format used when the geofence was created. ## Request Syntax ``` GET /geofencing/v0/collections/CollectionName/geofences/GeofenceId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [CollectionName](#API_WaypointGeofencing_GetGeofence_RequestSyntax) ** The geofence collection storing the target geofence. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` Required: Yes ** [GeofenceId](#API_WaypointGeofencing_GetGeofence_RequestSyntax) ** The geofence you're retrieving details for. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\p{L}\p{N}]+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CreateTime": "string", "GeofenceId": "string", "GeofenceProperties": { "string" : "string" }, "Geometry": { "Circle": { "Center": [ number ], "Radius": number }, "Geobuf": blob, "MultiPolygon": [ [ [ [ number ] ] ] ], "Polygon": [ [ [ number ] ] ] }, "Status": "string", "UpdateTime": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreateTime](#API_WaypointGeofencing_GetGeofence_ResponseSyntax) ** The timestamp for when the geofence collection was created in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sss` Type: Timestamp ** [GeofenceId](#API_WaypointGeofencing_GetGeofence_ResponseSyntax) ** The geofence identifier. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\p{L}\p{N}]+` ** [GeofenceProperties](#API_WaypointGeofencing_GetGeofence_ResponseSyntax) ** User defined properties of the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence. Format: `"key" : "value"` Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 3 items. Key Length Constraints: Minimum length of 1. Maximum length of 20. Value Length Constraints: Minimum length of 1. Maximum length of 40. ** [Geometry](#API_WaypointGeofencing_GetGeofence_ResponseSyntax) ** Contains the geofence geometry details describing a polygon or a circle. Type: [GeofenceGeometry](API_WaypointGeofencing_GeofenceGeometry.md) object ** [Status](#API_WaypointGeofencing_GetGeofence_ResponseSyntax) ** 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. Type: String ** [UpdateTime](#API_WaypointGeofencing_GetGeofence_ResponseSyntax) ** The timestamp for when the geofence collection was last updated in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sss` Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waypointgeofencing-2020-11-19/GetGeofence) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waypointgeofencing-2020-11-19/GetGeofence) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waypointgeofencing-2020-11-19/GetGeofence) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waypointgeofencing-2020-11-19/GetGeofence) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waypointgeofencing-2020-11-19/GetGeofence) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waypointgeofencing-2020-11-19/GetGeofence) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waypointgeofencing-2020-11-19/GetGeofence) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waypointgeofencing-2020-11-19/GetGeofence) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waypointgeofencing-2020-11-19/GetGeofence) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waypointgeofencing-2020-11-19/GetGeofence) # ListGeofenceCollections Lists geofence collections in your AWS account. ## Request Syntax ``` POST /geofencing/v0/list-collections HTTP/1.1 Content-type: application/json { "MaxResults": number, "NextToken": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [MaxResults](#API_WaypointGeofencing_ListGeofenceCollections_RequestSyntax) ** An optional limit for the number of resources returned in a single call. Default value: `100` Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_WaypointGeofencing_ListGeofenceCollections_RequestSyntax) ** 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` Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Entries": [ { "CollectionName": "string", "CreateTime": "string", "Description": "string", "PricingPlan": "string", "PricingPlanDataSource": "string", "UpdateTime": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Entries](#API_WaypointGeofencing_ListGeofenceCollections_ResponseSyntax) ** Lists the geofence collections that exist in your AWS account. Type: Array of [ListGeofenceCollectionsResponseEntry](API_WaypointGeofencing_ListGeofenceCollectionsResponseEntry.md) objects ** [NextToken](#API_WaypointGeofencing_ListGeofenceCollections_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waypointgeofencing-2020-11-19/ListGeofenceCollections) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waypointgeofencing-2020-11-19/ListGeofenceCollections) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waypointgeofencing-2020-11-19/ListGeofenceCollections) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waypointgeofencing-2020-11-19/ListGeofenceCollections) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waypointgeofencing-2020-11-19/ListGeofenceCollections) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waypointgeofencing-2020-11-19/ListGeofenceCollections) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waypointgeofencing-2020-11-19/ListGeofenceCollections) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waypointgeofencing-2020-11-19/ListGeofenceCollections) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waypointgeofencing-2020-11-19/ListGeofenceCollections) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waypointgeofencing-2020-11-19/ListGeofenceCollections) # ListGeofences Lists geofences stored in a given geofence collection. ## Request Syntax ``` POST /geofencing/v0/collections/CollectionName/list-geofences HTTP/1.1 Content-type: application/json { "MaxResults": number, "NextToken": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [CollectionName](#API_WaypointGeofencing_ListGeofences_RequestSyntax) ** The name of the geofence collection storing the list of geofences. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [MaxResults](#API_WaypointGeofencing_ListGeofences_RequestSyntax) ** An optional limit for the number of geofences returned in a single call. Default value: `100` Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_WaypointGeofencing_ListGeofences_RequestSyntax) ** 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` Type: String Length Constraints: Minimum length of 1. Maximum length of 60000. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Entries": [ { "CreateTime": "string", "GeofenceId": "string", "GeofenceProperties": { "string" : "string" }, "Geometry": { "Circle": { "Center": [ number ], "Radius": number }, "Geobuf": blob, "MultiPolygon": [ [ [ [ number ] ] ] ], "Polygon": [ [ [ number ] ] ] }, "Status": "string", "UpdateTime": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Entries](#API_WaypointGeofencing_ListGeofences_ResponseSyntax) ** Contains a list of geofences stored in the geofence collection. Type: Array of [ListGeofenceResponseEntry](API_WaypointGeofencing_ListGeofenceResponseEntry.md) objects ** [NextToken](#API_WaypointGeofencing_ListGeofences_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 60000. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waypointgeofencing-2020-11-19/ListGeofences) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waypointgeofencing-2020-11-19/ListGeofences) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waypointgeofencing-2020-11-19/ListGeofences) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waypointgeofencing-2020-11-19/ListGeofences) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waypointgeofencing-2020-11-19/ListGeofences) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waypointgeofencing-2020-11-19/ListGeofences) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waypointgeofencing-2020-11-19/ListGeofences) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waypointgeofencing-2020-11-19/ListGeofences) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waypointgeofencing-2020-11-19/ListGeofences) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waypointgeofencing-2020-11-19/ListGeofences) # PutGeofence Stores a geofence geometry in a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request. ## Request Syntax ``` PUT /geofencing/v0/collections/CollectionName/geofences/GeofenceId HTTP/1.1 Content-type: application/json { "GeofenceProperties": { "string" : "string" }, "Geometry": { "Circle": { "Center": [ number ], "Radius": number }, "Geobuf": blob, "MultiPolygon": [ [ [ [ number ] ] ] ], "Polygon": [ [ [ number ] ] ] } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [CollectionName](#API_WaypointGeofencing_PutGeofence_RequestSyntax) ** The geofence collection to store the geofence in. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` Required: Yes ** [GeofenceId](#API_WaypointGeofencing_PutGeofence_RequestSyntax) ** An identifier for the geofence. For example, `ExampleGeofence-1`. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\p{L}\p{N}]+` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [GeofenceProperties](#API_WaypointGeofencing_PutGeofence_RequestSyntax) ** Associates one of more properties with the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence. Format: `"key" : "value"` Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 3 items. Key Length Constraints: Minimum length of 1. Maximum length of 20. Value Length Constraints: Minimum length of 1. Maximum length of 40. Required: No ** [Geometry](#API_WaypointGeofencing_PutGeofence_RequestSyntax) ** Contains the details to specify the position of the geofence. Can be a circle, a polygon, or a multipolygon. `Polygon` and `MultiPolygon` geometries can be defined using their respective parameters, or encoded in Geobuf format using the `Geobuf` parameter. Including multiple geometry types in the same request will return a validation error. The geofence `Polygon` and `MultiPolygon` formats support a maximum of 1,000 total vertices. The `Geobuf` format supports a maximum of 100,000 vertices. Type: [GeofenceGeometry](API_WaypointGeofencing_GeofenceGeometry.md) object Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CreateTime": "string", "GeofenceId": "string", "UpdateTime": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreateTime](#API_WaypointGeofencing_PutGeofence_ResponseSyntax) ** The timestamp for when the geofence was created in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sss` Type: Timestamp ** [GeofenceId](#API_WaypointGeofencing_PutGeofence_ResponseSyntax) ** The geofence identifier entered in the request. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\p{L}\p{N}]+` ** [UpdateTime](#API_WaypointGeofencing_PutGeofence_ResponseSyntax) ** The timestamp for when the geofence was last updated in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sss` Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** ConflictException ** HTTP Status Code: 409 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waypointgeofencing-2020-11-19/PutGeofence) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waypointgeofencing-2020-11-19/PutGeofence) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waypointgeofencing-2020-11-19/PutGeofence) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waypointgeofencing-2020-11-19/PutGeofence) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waypointgeofencing-2020-11-19/PutGeofence) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waypointgeofencing-2020-11-19/PutGeofence) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waypointgeofencing-2020-11-19/PutGeofence) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waypointgeofencing-2020-11-19/PutGeofence) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waypointgeofencing-2020-11-19/PutGeofence) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waypointgeofencing-2020-11-19/PutGeofence) # UpdateGeofenceCollection Updates the specified properties of a given geofence collection. ## Request Syntax ``` PATCH /geofencing/v0/collections/CollectionName HTTP/1.1 Content-type: application/json { "Description": "string", "PricingPlan": "string", "PricingPlanDataSource": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [CollectionName](#API_WaypointGeofencing_UpdateGeofenceCollection_RequestSyntax) ** The name of the geofence collection to update. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Description](#API_WaypointGeofencing_UpdateGeofenceCollection_RequestSyntax) ** Updates the description for the geofence collection. Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. Required: No ** [PricingPlan](#API_WaypointGeofencing_UpdateGeofenceCollection_RequestSyntax) ** *This parameter has been deprecated.* No longer used. If included, the only allowed value is `RequestBasedUsage`. Type: String Valid Values: `RequestBasedUsage | MobileAssetTracking | MobileAssetManagement` Required: No ** [PricingPlanDataSource](#API_WaypointGeofencing_UpdateGeofenceCollection_RequestSyntax) ** *This parameter has been deprecated.* This parameter is no longer used. Type: String Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CollectionArn": "string", "CollectionName": "string", "UpdateTime": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CollectionArn](#API_WaypointGeofencing_UpdateGeofenceCollection_ResponseSyntax) ** 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` Type: String Length Constraints: Minimum length of 0. Maximum length of 1600. Pattern: `arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?` ** [CollectionName](#API_WaypointGeofencing_UpdateGeofenceCollection_ResponseSyntax) ** The name of the updated geofence collection. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` ** [UpdateTime](#API_WaypointGeofencing_UpdateGeofenceCollection_ResponseSyntax) ** The time when the geofence collection was last updated in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sss` Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waypointgeofencing-2020-11-19/UpdateGeofenceCollection) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waypointgeofencing-2020-11-19/UpdateGeofenceCollection) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waypointgeofencing-2020-11-19/UpdateGeofenceCollection) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waypointgeofencing-2020-11-19/UpdateGeofenceCollection) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waypointgeofencing-2020-11-19/UpdateGeofenceCollection) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waypointgeofencing-2020-11-19/UpdateGeofenceCollection) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waypointgeofencing-2020-11-19/UpdateGeofenceCollection) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waypointgeofencing-2020-11-19/UpdateGeofenceCollection) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waypointgeofencing-2020-11-19/UpdateGeofenceCollection) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waypointgeofencing-2020-11-19/UpdateGeofenceCollection) # Amazon Location Service Trackers The following actions are supported by Amazon Location Service Trackers: + [AssociateTrackerConsumer](API_WaypointTracking_AssociateTrackerConsumer.md) + [BatchDeleteDevicePositionHistory](API_WaypointTracking_BatchDeleteDevicePositionHistory.md) + [BatchGetDevicePosition](API_WaypointTracking_BatchGetDevicePosition.md) + [BatchUpdateDevicePosition](API_WaypointTracking_BatchUpdateDevicePosition.md) + [CreateTracker](API_WaypointTracking_CreateTracker.md) + [DeleteTracker](API_WaypointTracking_DeleteTracker.md) + [DescribeTracker](API_WaypointTracking_DescribeTracker.md) + [DisassociateTrackerConsumer](API_WaypointTracking_DisassociateTrackerConsumer.md) + [GetDevicePosition](API_WaypointTracking_GetDevicePosition.md) + [GetDevicePositionHistory](API_WaypointTracking_GetDevicePositionHistory.md) + [ListDevicePositions](API_WaypointTracking_ListDevicePositions.md) + [ListTrackerConsumers](API_WaypointTracking_ListTrackerConsumers.md) + [ListTrackers](API_WaypointTracking_ListTrackers.md) + [UpdateTracker](API_WaypointTracking_UpdateTracker.md) + [VerifyDevicePosition](API_WaypointTracking_VerifyDevicePosition.md) # AssociateTrackerConsumer Creates an association between a geofence collection and a tracker resource. This allows the tracker resource to communicate location data to the linked geofence collection. You can associate up to five geofence collections to each tracker resource. **Note** Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account. ## Request Syntax ``` POST /tracking/v0/trackers/TrackerName/consumers HTTP/1.1 Content-type: application/json { "ConsumerArn": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [TrackerName](#API_WaypointTracking_AssociateTrackerConsumer_RequestSyntax) ** The name of the tracker resource to be associated with a geofence collection. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [ConsumerArn](#API_WaypointTracking_AssociateTrackerConsumer_RequestSyntax) ** 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` Type: String Length Constraints: Minimum length of 0. Maximum length of 1600. Pattern: `arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?` Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** ConflictException ** HTTP Status Code: 409 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ServiceQuotaExceededException ** HTTP Status Code: 402 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waypointtracking-2020-11-19/AssociateTrackerConsumer) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waypointtracking-2020-11-19/AssociateTrackerConsumer) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waypointtracking-2020-11-19/AssociateTrackerConsumer) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waypointtracking-2020-11-19/AssociateTrackerConsumer) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waypointtracking-2020-11-19/AssociateTrackerConsumer) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waypointtracking-2020-11-19/AssociateTrackerConsumer) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waypointtracking-2020-11-19/AssociateTrackerConsumer) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waypointtracking-2020-11-19/AssociateTrackerConsumer) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waypointtracking-2020-11-19/AssociateTrackerConsumer) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waypointtracking-2020-11-19/AssociateTrackerConsumer) # BatchDeleteDevicePositionHistory Deletes the position history of one or more devices from a tracker resource. ## Request Syntax ``` POST /tracking/v0/trackers/TrackerName/delete-positions HTTP/1.1 Content-type: application/json { "DeviceIds": [ "string" ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [TrackerName](#API_WaypointTracking_BatchDeleteDevicePositionHistory_RequestSyntax) ** The name of the tracker resource to delete the device position history from. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [DeviceIds](#API_WaypointTracking_BatchDeleteDevicePositionHistory_RequestSyntax) ** Devices whose position history you want to delete. + For example, for two devices: `“DeviceIds” : [DeviceId1,DeviceId2]` Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 100 items. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\p{L}\p{N}]+` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Errors": [ { "DeviceId": "string", "Error": { "Code": "string", "Message": "string" } } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Errors](#API_WaypointTracking_BatchDeleteDevicePositionHistory_ResponseSyntax) ** Contains error details for each device history that failed to delete. Type: Array of [BatchDeleteDevicePositionHistoryError](API_WaypointTracking_BatchDeleteDevicePositionHistoryError.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waypointtracking-2020-11-19/BatchDeleteDevicePositionHistory) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waypointtracking-2020-11-19/BatchDeleteDevicePositionHistory) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waypointtracking-2020-11-19/BatchDeleteDevicePositionHistory) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waypointtracking-2020-11-19/BatchDeleteDevicePositionHistory) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waypointtracking-2020-11-19/BatchDeleteDevicePositionHistory) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waypointtracking-2020-11-19/BatchDeleteDevicePositionHistory) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waypointtracking-2020-11-19/BatchDeleteDevicePositionHistory) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waypointtracking-2020-11-19/BatchDeleteDevicePositionHistory) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waypointtracking-2020-11-19/BatchDeleteDevicePositionHistory) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waypointtracking-2020-11-19/BatchDeleteDevicePositionHistory) # BatchGetDevicePosition Lists the latest device positions for requested devices. ## Request Syntax ``` POST /tracking/v0/trackers/TrackerName/get-positions HTTP/1.1 Content-type: application/json { "DeviceIds": [ "string" ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [TrackerName](#API_WaypointTracking_BatchGetDevicePosition_RequestSyntax) ** The tracker resource retrieving the device position. Length Constraints: Minimum length of 1. Pattern: `[-._\w]+` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [DeviceIds](#API_WaypointTracking_BatchGetDevicePosition_RequestSyntax) ** Devices whose position you want to retrieve. + For example, for two devices: `device-ids=DeviceId1&device-ids=DeviceId2` Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\p{L}\p{N}]+` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "DevicePositions": [ { "Accuracy": { "Horizontal": number }, "DeviceId": "string", "Position": [ number ], "PositionProperties": { "string" : "string" }, "ReceivedTime": "string", "SampleTime": "string" } ], "Errors": [ { "DeviceId": "string", "Error": { "Code": "string", "Message": "string" } } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DevicePositions](#API_WaypointTracking_BatchGetDevicePosition_ResponseSyntax) ** Contains device position details such as the device ID, position, and timestamps for when the position was received and sampled. Type: Array of [DevicePosition](API_WaypointTracking_DevicePosition.md) objects ** [Errors](#API_WaypointTracking_BatchGetDevicePosition_ResponseSyntax) ** Contains error details for each device that failed to send its position to the tracker resource. Type: Array of [BatchGetDevicePositionError](API_WaypointTracking_BatchGetDevicePositionError.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waypointtracking-2020-11-19/BatchGetDevicePosition) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waypointtracking-2020-11-19/BatchGetDevicePosition) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waypointtracking-2020-11-19/BatchGetDevicePosition) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waypointtracking-2020-11-19/BatchGetDevicePosition) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waypointtracking-2020-11-19/BatchGetDevicePosition) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waypointtracking-2020-11-19/BatchGetDevicePosition) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waypointtracking-2020-11-19/BatchGetDevicePosition) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waypointtracking-2020-11-19/BatchGetDevicePosition) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waypointtracking-2020-11-19/BatchGetDevicePosition) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waypointtracking-2020-11-19/BatchGetDevicePosition) # BatchUpdateDevicePosition Uploads position update data for one or more devices to a tracker resource (up to 10 devices per batch). Amazon Location uses the data when it reports the last known device position and position history. Amazon Location retains location data for 30 days. **Note** Position updates are handled based on the `PositionFiltering` property of the tracker. When `PositionFiltering` is set to `TimeBased`, updates are evaluated against linked geofence collections, and location data is stored at a maximum of one position per 30 second interval. If your update frequency is more often than every 30 seconds, only one update per 30 seconds is stored for each unique device ID. When `PositionFiltering` is set to `DistanceBased` filtering, location data is stored and evaluated against linked geofence collections only if the device has moved more than 30 m (98.4 ft). When `PositionFiltering` is set to `AccuracyBased` filtering, location data is stored and evaluated against linked geofence collections only if the device has moved more than the measured accuracy. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is neither stored or evaluated if the device has moved less than 15 m. If `PositionFiltering` is set to `AccuracyBased` filtering, Amazon Location uses the default value `{ "Horizontal": 0}` when accuracy is not provided on a `DevicePositionUpdate`. ## Request Syntax ``` POST /tracking/v0/trackers/TrackerName/positions HTTP/1.1 Content-type: application/json { "Updates": [ { "Accuracy": { "Horizontal": number }, "DeviceId": "string", "Position": [ number ], "PositionProperties": { "string" : "string" }, "SampleTime": "string" } ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [TrackerName](#API_WaypointTracking_BatchUpdateDevicePosition_RequestSyntax) ** The name of the tracker resource to update. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Updates](#API_WaypointTracking_BatchUpdateDevicePosition_RequestSyntax) ** Contains the position update details for each device, up to 10 devices. Type: Array of [DevicePositionUpdate](API_WaypointTracking_DevicePositionUpdate.md) objects Array Members: Minimum number of 1 item. Maximum number of 10 items. Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Errors": [ { "DeviceId": "string", "Error": { "Code": "string", "Message": "string" }, "SampleTime": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Errors](#API_WaypointTracking_BatchUpdateDevicePosition_ResponseSyntax) ** Contains error details for each device that failed to update its position. Type: Array of [BatchUpdateDevicePositionError](API_WaypointTracking_BatchUpdateDevicePositionError.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waypointtracking-2020-11-19/BatchUpdateDevicePosition) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waypointtracking-2020-11-19/BatchUpdateDevicePosition) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waypointtracking-2020-11-19/BatchUpdateDevicePosition) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waypointtracking-2020-11-19/BatchUpdateDevicePosition) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waypointtracking-2020-11-19/BatchUpdateDevicePosition) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waypointtracking-2020-11-19/BatchUpdateDevicePosition) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waypointtracking-2020-11-19/BatchUpdateDevicePosition) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waypointtracking-2020-11-19/BatchUpdateDevicePosition) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waypointtracking-2020-11-19/BatchUpdateDevicePosition) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waypointtracking-2020-11-19/BatchUpdateDevicePosition) # CreateTracker Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of devices. ## Request Syntax ``` POST /tracking/v0/trackers HTTP/1.1 Content-type: application/json { "Description": "string", "EventBridgeEnabled": boolean, "KmsKeyEnableGeospatialQueries": boolean, "KmsKeyId": "string", "PositionFiltering": "string", "PricingPlan": "string", "PricingPlanDataSource": "string", "Tags": { "string" : "string" }, "TrackerName": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [Description](#API_WaypointTracking_CreateTracker_RequestSyntax) ** An optional description for the tracker resource. Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. Required: No ** [EventBridgeEnabled](#API_WaypointTracking_CreateTracker_RequestSyntax) ** Whether to enable position `UPDATE` events from this tracker to be sent to EventBridge. You do not need enable this feature to get `ENTER` and `EXIT` events for geofences with this tracker. Those events are always sent to EventBridge. Type: Boolean Required: No ** [KmsKeyEnableGeospatialQueries](#API_WaypointTracking_CreateTracker_RequestSyntax) ** Enables `GeospatialQueries` for a tracker that uses a [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html). This parameter is only used if you are using a KMS customer managed key. If you wish to encrypt your data using your own KMS customer managed key, then the Bounding Polygon Queries feature will be disabled by default. This is because by using this feature, a representation of your device positions will not be encrypted using the your KMS managed key. The exact device position, however; is still encrypted using your managed key. You can choose to opt-in to the Bounding Polygon Quseries feature. This is done by setting the `KmsKeyEnableGeospatialQueries` parameter to true when creating or updating a Tracker. Type: Boolean Required: No ** [KmsKeyId](#API_WaypointTracking_CreateTracker_RequestSyntax) ** A key identifier for an [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html). Enter a key ID, key ARN, alias name, or alias ARN. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ** [PositionFiltering](#API_WaypointTracking_CreateTracker_RequestSyntax) ** 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`. Type: String Valid Values: `TimeBased | DistanceBased | AccuracyBased` Required: No ** [PricingPlan](#API_WaypointTracking_CreateTracker_RequestSyntax) ** *This parameter has been deprecated.* No longer used. If included, the only allowed value is `RequestBasedUsage`. Type: String Valid Values: `RequestBasedUsage | MobileAssetTracking | MobileAssetManagement` Required: No ** [PricingPlanDataSource](#API_WaypointTracking_CreateTracker_RequestSyntax) ** *This parameter has been deprecated.* This parameter is no longer used. Type: String Required: No ** [Tags](#API_WaypointTracking_CreateTracker_RequestSyntax) ** 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: \$1 - = . \$1 : / @. + Cannot use `"aws:"` as a prefix for a key. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)` Value Length Constraints: Minimum length of 0. Maximum length of 256. Value Pattern: `([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)` Required: No ** [TrackerName](#API_WaypointTracking_CreateTracker_RequestSyntax) ** The name for the tracker resource. Requirements: + Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (\$1). + Must be a unique tracker resource name. + No spaces allowed. For example, `ExampleTracker`. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CreateTime": "string", "TrackerArn": "string", "TrackerName": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreateTime](#API_WaypointTracking_CreateTracker_ResponseSyntax) ** The timestamp for when the tracker resource was created in [ ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sss`. Type: Timestamp ** [TrackerArn](#API_WaypointTracking_CreateTracker_ResponseSyntax) ** 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` Type: String Length Constraints: Minimum length of 0. Maximum length of 1600. Pattern: `arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?` ** [TrackerName](#API_WaypointTracking_CreateTracker_ResponseSyntax) ** The name of the tracker resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** ConflictException ** HTTP Status Code: 409 ** InternalServerException ** HTTP Status Code: 500 ** ServiceQuotaExceededException ** HTTP Status Code: 402 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waypointtracking-2020-11-19/CreateTracker) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waypointtracking-2020-11-19/CreateTracker) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waypointtracking-2020-11-19/CreateTracker) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waypointtracking-2020-11-19/CreateTracker) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waypointtracking-2020-11-19/CreateTracker) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waypointtracking-2020-11-19/CreateTracker) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waypointtracking-2020-11-19/CreateTracker) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waypointtracking-2020-11-19/CreateTracker) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waypointtracking-2020-11-19/CreateTracker) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waypointtracking-2020-11-19/CreateTracker) # DeleteTracker Deletes a tracker resource from your AWS account. **Note** This operation deletes the resource permanently. If the tracker resource is in use, you may encounter an error. Make sure that the target resource isn't a dependency for your applications. ## Request Syntax ``` DELETE /tracking/v0/trackers/TrackerName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [TrackerName](#API_WaypointTracking_DeleteTracker_RequestSyntax) ** The name of the tracker resource to be deleted. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waypointtracking-2020-11-19/DeleteTracker) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waypointtracking-2020-11-19/DeleteTracker) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waypointtracking-2020-11-19/DeleteTracker) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waypointtracking-2020-11-19/DeleteTracker) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waypointtracking-2020-11-19/DeleteTracker) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waypointtracking-2020-11-19/DeleteTracker) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waypointtracking-2020-11-19/DeleteTracker) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waypointtracking-2020-11-19/DeleteTracker) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waypointtracking-2020-11-19/DeleteTracker) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waypointtracking-2020-11-19/DeleteTracker) # DescribeTracker Retrieves the tracker resource details. ## Request Syntax ``` GET /tracking/v0/trackers/TrackerName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [TrackerName](#API_WaypointTracking_DescribeTracker_RequestSyntax) ** The name of the tracker resource. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CreateTime": "string", "Description": "string", "EventBridgeEnabled": boolean, "KmsKeyEnableGeospatialQueries": boolean, "KmsKeyId": "string", "PositionFiltering": "string", "PricingPlan": "string", "PricingPlanDataSource": "string", "Tags": { "string" : "string" }, "TrackerArn": "string", "TrackerName": "string", "UpdateTime": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreateTime](#API_WaypointTracking_DescribeTracker_ResponseSyntax) ** The timestamp for when the tracker resource was created in [ ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sss`. Type: Timestamp ** [Description](#API_WaypointTracking_DescribeTracker_ResponseSyntax) ** The optional description for the tracker resource. Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. ** [EventBridgeEnabled](#API_WaypointTracking_DescribeTracker_ResponseSyntax) ** Whether `UPDATE` events from this tracker in EventBridge are enabled. If set to `true` these events will be sent to EventBridge. Type: Boolean ** [KmsKeyEnableGeospatialQueries](#API_WaypointTracking_DescribeTracker_ResponseSyntax) ** Enables `GeospatialQueries` for a tracker that uses a [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html). This parameter is only used if you are using a KMS customer managed key. If you wish to encrypt your data using your own KMS customer managed key, then the Bounding Polygon Queries feature will be disabled by default. This is because by using this feature, a representation of your device positions will not be encrypted using the your KMS managed key. The exact device position, however; is still encrypted using your managed key. You can choose to opt-in to the Bounding Polygon Quseries feature. This is done by setting the `KmsKeyEnableGeospatialQueries` parameter to true when creating or updating a Tracker. Type: Boolean ** [KmsKeyId](#API_WaypointTracking_DescribeTracker_ResponseSyntax) ** A key identifier for an [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) assigned to the Amazon Location resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ** [PositionFiltering](#API_WaypointTracking_DescribeTracker_ResponseSyntax) ** The position filtering method of the tracker resource. Type: String Valid Values: `TimeBased | DistanceBased | AccuracyBased` ** [PricingPlan](#API_WaypointTracking_DescribeTracker_ResponseSyntax) ** *This parameter has been deprecated.* Always returns `RequestBasedUsage`. Type: String Valid Values: `RequestBasedUsage | MobileAssetTracking | MobileAssetManagement` ** [PricingPlanDataSource](#API_WaypointTracking_DescribeTracker_ResponseSyntax) ** *This parameter has been deprecated.* No longer used. Always returns an empty string. Type: String ** [Tags](#API_WaypointTracking_DescribeTracker_ResponseSyntax) ** The tags associated with the tracker resource. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)` Value Length Constraints: Minimum length of 0. Maximum length of 256. Value Pattern: `([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)` ** [TrackerArn](#API_WaypointTracking_DescribeTracker_ResponseSyntax) ** 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` Type: String Length Constraints: Minimum length of 0. Maximum length of 1600. Pattern: `arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?` ** [TrackerName](#API_WaypointTracking_DescribeTracker_ResponseSyntax) ** The name of the tracker resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` ** [UpdateTime](#API_WaypointTracking_DescribeTracker_ResponseSyntax) ** The timestamp for when the tracker resource was last updated in [ ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sss`. Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waypointtracking-2020-11-19/DescribeTracker) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waypointtracking-2020-11-19/DescribeTracker) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waypointtracking-2020-11-19/DescribeTracker) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waypointtracking-2020-11-19/DescribeTracker) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waypointtracking-2020-11-19/DescribeTracker) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waypointtracking-2020-11-19/DescribeTracker) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waypointtracking-2020-11-19/DescribeTracker) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waypointtracking-2020-11-19/DescribeTracker) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waypointtracking-2020-11-19/DescribeTracker) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waypointtracking-2020-11-19/DescribeTracker) # DisassociateTrackerConsumer Removes the association between a tracker resource and a geofence collection. **Note** Once you unlink a tracker resource from a geofence collection, the tracker positions will no longer be automatically evaluated against geofences. ## Request Syntax ``` DELETE /tracking/v0/trackers/TrackerName/consumers/ConsumerArn HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [ConsumerArn](#API_WaypointTracking_DisassociateTrackerConsumer_RequestSyntax) ** 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` Length Constraints: Minimum length of 0. Maximum length of 1600. Pattern: `arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?` Required: Yes ** [TrackerName](#API_WaypointTracking_DisassociateTrackerConsumer_RequestSyntax) ** The name of the tracker resource to be dissociated from the consumer. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waypointtracking-2020-11-19/DisassociateTrackerConsumer) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waypointtracking-2020-11-19/DisassociateTrackerConsumer) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waypointtracking-2020-11-19/DisassociateTrackerConsumer) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waypointtracking-2020-11-19/DisassociateTrackerConsumer) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waypointtracking-2020-11-19/DisassociateTrackerConsumer) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waypointtracking-2020-11-19/DisassociateTrackerConsumer) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waypointtracking-2020-11-19/DisassociateTrackerConsumer) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waypointtracking-2020-11-19/DisassociateTrackerConsumer) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waypointtracking-2020-11-19/DisassociateTrackerConsumer) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waypointtracking-2020-11-19/DisassociateTrackerConsumer) # GetDevicePosition Retrieves a device's most recent position according to its sample time. **Note** Device positions are deleted after 30 days. ## Request Syntax ``` GET /tracking/v0/trackers/TrackerName/devices/DeviceId/positions/latest HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DeviceId](#API_WaypointTracking_GetDevicePosition_RequestSyntax) ** The device whose position you want to retrieve. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\p{L}\p{N}]+` Required: Yes ** [TrackerName](#API_WaypointTracking_GetDevicePosition_RequestSyntax) ** The tracker resource receiving the position update. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Accuracy": { "Horizontal": number }, "DeviceId": "string", "Position": [ number ], "PositionProperties": { "string" : "string" }, "ReceivedTime": "string", "SampleTime": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Accuracy](#API_WaypointTracking_GetDevicePosition_ResponseSyntax) ** The accuracy of the device position. Type: [PositionalAccuracy](API_WaypointTracking_PositionalAccuracy.md) object ** [DeviceId](#API_WaypointTracking_GetDevicePosition_ResponseSyntax) ** The device whose position you retrieved. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\p{L}\p{N}]+` ** [Position](#API_WaypointTracking_GetDevicePosition_ResponseSyntax) ** The last known device position. Type: Array of doubles Array Members: Fixed number of 2 items. ** [PositionProperties](#API_WaypointTracking_GetDevicePosition_ResponseSyntax) ** The properties associated with the position. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 4 items. Key Length Constraints: Minimum length of 1. Maximum length of 20. Value Length Constraints: Minimum length of 1. Maximum length of 150. ** [ReceivedTime](#API_WaypointTracking_GetDevicePosition_ResponseSyntax) ** The timestamp for when the tracker resource received the device position. Uses [ ISO 8601 ](https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sss`. Type: Timestamp ** [SampleTime](#API_WaypointTracking_GetDevicePosition_ResponseSyntax) ** The timestamp at which the device's position was determined. Uses [ ISO 8601 ](https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sss`. Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waypointtracking-2020-11-19/GetDevicePosition) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waypointtracking-2020-11-19/GetDevicePosition) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waypointtracking-2020-11-19/GetDevicePosition) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waypointtracking-2020-11-19/GetDevicePosition) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waypointtracking-2020-11-19/GetDevicePosition) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waypointtracking-2020-11-19/GetDevicePosition) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waypointtracking-2020-11-19/GetDevicePosition) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waypointtracking-2020-11-19/GetDevicePosition) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waypointtracking-2020-11-19/GetDevicePosition) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waypointtracking-2020-11-19/GetDevicePosition) # GetDevicePositionHistory Retrieves the device position history from a tracker resource within a specified range of time. **Note** Device positions are deleted after 30 days. ## Request Syntax ``` POST /tracking/v0/trackers/TrackerName/devices/DeviceId/list-positions HTTP/1.1 Content-type: application/json { "EndTimeExclusive": "string", "MaxResults": number, "NextToken": "string", "StartTimeInclusive": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DeviceId](#API_WaypointTracking_GetDevicePositionHistory_RequestSyntax) ** The device whose position history you want to retrieve. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\p{L}\p{N}]+` Required: Yes ** [TrackerName](#API_WaypointTracking_GetDevicePositionHistory_RequestSyntax) ** The tracker resource receiving the request for the device position history. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [EndTimeExclusive](#API_WaypointTracking_GetDevicePositionHistory_RequestSyntax) ** Specify the end time for the position history in [ ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sss`. 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`. Type: Timestamp Required: No ** [MaxResults](#API_WaypointTracking_GetDevicePositionHistory_RequestSyntax) ** An optional limit for the number of device positions returned in a single call. Default value: `100` Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_WaypointTracking_GetDevicePositionHistory_RequestSyntax) ** 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` Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. Required: No ** [StartTimeInclusive](#API_WaypointTracking_GetDevicePositionHistory_RequestSyntax) ** Specify the start time for the position history in [ ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sss`. 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`. Type: Timestamp Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "DevicePositions": [ { "Accuracy": { "Horizontal": number }, "DeviceId": "string", "Position": [ number ], "PositionProperties": { "string" : "string" }, "ReceivedTime": "string", "SampleTime": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DevicePositions](#API_WaypointTracking_GetDevicePositionHistory_ResponseSyntax) ** Contains the position history details for the requested device. Type: Array of [DevicePosition](API_WaypointTracking_DevicePosition.md) objects ** [NextToken](#API_WaypointTracking_GetDevicePositionHistory_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waypointtracking-2020-11-19/GetDevicePositionHistory) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waypointtracking-2020-11-19/GetDevicePositionHistory) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waypointtracking-2020-11-19/GetDevicePositionHistory) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waypointtracking-2020-11-19/GetDevicePositionHistory) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waypointtracking-2020-11-19/GetDevicePositionHistory) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waypointtracking-2020-11-19/GetDevicePositionHistory) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waypointtracking-2020-11-19/GetDevicePositionHistory) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waypointtracking-2020-11-19/GetDevicePositionHistory) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waypointtracking-2020-11-19/GetDevicePositionHistory) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waypointtracking-2020-11-19/GetDevicePositionHistory) # ListDevicePositions A batch request to retrieve all device positions. ## Request Syntax ``` POST /tracking/v0/trackers/TrackerName/list-positions HTTP/1.1 Content-type: application/json { "FilterGeometry": { "Polygon": [ [ [ number ] ] ] }, "MaxResults": number, "NextToken": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [TrackerName](#API_WaypointTracking_ListDevicePositions_RequestSyntax) ** The tracker resource containing the requested devices. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [FilterGeometry](#API_WaypointTracking_ListDevicePositions_RequestSyntax) ** The geometry used to filter device positions. Type: [TrackingFilterGeometry](API_WaypointTracking_TrackingFilterGeometry.md) object Required: No ** [MaxResults](#API_WaypointTracking_ListDevicePositions_RequestSyntax) ** An optional limit for the number of entries returned in a single call. Default value: `100` Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_WaypointTracking_ListDevicePositions_RequestSyntax) ** 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` Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Entries": [ { "Accuracy": { "Horizontal": number }, "DeviceId": "string", "Position": [ number ], "PositionProperties": { "string" : "string" }, "SampleTime": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Entries](#API_WaypointTracking_ListDevicePositions_ResponseSyntax) ** Contains details about each device's last known position. Type: Array of [ListDevicePositionsResponseEntry](API_WaypointTracking_ListDevicePositionsResponseEntry.md) objects ** [NextToken](#API_WaypointTracking_ListDevicePositions_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waypointtracking-2020-11-19/ListDevicePositions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waypointtracking-2020-11-19/ListDevicePositions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waypointtracking-2020-11-19/ListDevicePositions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waypointtracking-2020-11-19/ListDevicePositions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waypointtracking-2020-11-19/ListDevicePositions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waypointtracking-2020-11-19/ListDevicePositions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waypointtracking-2020-11-19/ListDevicePositions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waypointtracking-2020-11-19/ListDevicePositions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waypointtracking-2020-11-19/ListDevicePositions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waypointtracking-2020-11-19/ListDevicePositions) # ListTrackerConsumers Lists geofence collections currently associated to the given tracker resource. ## Request Syntax ``` POST /tracking/v0/trackers/TrackerName/list-consumers HTTP/1.1 Content-type: application/json { "MaxResults": number, "NextToken": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [TrackerName](#API_WaypointTracking_ListTrackerConsumers_RequestSyntax) ** The tracker resource whose associated geofence collections you want to list. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [MaxResults](#API_WaypointTracking_ListTrackerConsumers_RequestSyntax) ** An optional limit for the number of resources returned in a single call. Default value: `100` Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_WaypointTracking_ListTrackerConsumers_RequestSyntax) ** 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` Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "ConsumerArns": [ "string" ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ConsumerArns](#API_WaypointTracking_ListTrackerConsumers_ResponseSyntax) ** Contains the list of geofence collection ARNs associated to the tracker resource. Type: Array of strings Length Constraints: Minimum length of 0. Maximum length of 1600. Pattern: `arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?` ** [NextToken](#API_WaypointTracking_ListTrackerConsumers_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waypointtracking-2020-11-19/ListTrackerConsumers) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waypointtracking-2020-11-19/ListTrackerConsumers) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waypointtracking-2020-11-19/ListTrackerConsumers) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waypointtracking-2020-11-19/ListTrackerConsumers) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waypointtracking-2020-11-19/ListTrackerConsumers) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waypointtracking-2020-11-19/ListTrackerConsumers) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waypointtracking-2020-11-19/ListTrackerConsumers) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waypointtracking-2020-11-19/ListTrackerConsumers) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waypointtracking-2020-11-19/ListTrackerConsumers) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waypointtracking-2020-11-19/ListTrackerConsumers) # ListTrackers Lists tracker resources in your AWS account. ## Request Syntax ``` POST /tracking/v0/list-trackers HTTP/1.1 Content-type: application/json { "MaxResults": number, "NextToken": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [MaxResults](#API_WaypointTracking_ListTrackers_RequestSyntax) ** An optional limit for the number of resources returned in a single call. Default value: `100` Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_WaypointTracking_ListTrackers_RequestSyntax) ** 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` Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Entries": [ { "CreateTime": "string", "Description": "string", "PricingPlan": "string", "PricingPlanDataSource": "string", "TrackerName": "string", "UpdateTime": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Entries](#API_WaypointTracking_ListTrackers_ResponseSyntax) ** Contains tracker resources in your AWS account. Details include tracker name, description and timestamps for when the tracker was created and last updated. Type: Array of [ListTrackersResponseEntry](API_WaypointTracking_ListTrackersResponseEntry.md) objects ** [NextToken](#API_WaypointTracking_ListTrackers_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waypointtracking-2020-11-19/ListTrackers) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waypointtracking-2020-11-19/ListTrackers) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waypointtracking-2020-11-19/ListTrackers) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waypointtracking-2020-11-19/ListTrackers) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waypointtracking-2020-11-19/ListTrackers) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waypointtracking-2020-11-19/ListTrackers) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waypointtracking-2020-11-19/ListTrackers) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waypointtracking-2020-11-19/ListTrackers) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waypointtracking-2020-11-19/ListTrackers) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waypointtracking-2020-11-19/ListTrackers) # UpdateTracker Updates the specified properties of a given tracker resource. ## Request Syntax ``` PATCH /tracking/v0/trackers/TrackerName HTTP/1.1 Content-type: application/json { "Description": "string", "EventBridgeEnabled": boolean, "KmsKeyEnableGeospatialQueries": boolean, "PositionFiltering": "string", "PricingPlan": "string", "PricingPlanDataSource": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [TrackerName](#API_WaypointTracking_UpdateTracker_RequestSyntax) ** The name of the tracker resource to update. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Description](#API_WaypointTracking_UpdateTracker_RequestSyntax) ** Updates the description for the tracker resource. Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. Required: No ** [EventBridgeEnabled](#API_WaypointTracking_UpdateTracker_RequestSyntax) ** Whether to enable position `UPDATE` events from this tracker to be sent to EventBridge. You do not need enable this feature to get `ENTER` and `EXIT` events for geofences with this tracker. Those events are always sent to EventBridge. Type: Boolean Required: No ** [KmsKeyEnableGeospatialQueries](#API_WaypointTracking_UpdateTracker_RequestSyntax) ** Enables `GeospatialQueries` for a tracker that uses a [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html). This parameter is only used if you are using a KMS customer managed key. Type: Boolean Required: No ** [PositionFiltering](#API_WaypointTracking_UpdateTracker_RequestSyntax) ** 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. Type: String Valid Values: `TimeBased | DistanceBased | AccuracyBased` Required: No ** [PricingPlan](#API_WaypointTracking_UpdateTracker_RequestSyntax) ** *This parameter has been deprecated.* No longer used. If included, the only allowed value is `RequestBasedUsage`. Type: String Valid Values: `RequestBasedUsage | MobileAssetTracking | MobileAssetManagement` Required: No ** [PricingPlanDataSource](#API_WaypointTracking_UpdateTracker_RequestSyntax) ** *This parameter has been deprecated.* This parameter is no longer used. Type: String Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "TrackerArn": "string", "TrackerName": "string", "UpdateTime": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [TrackerArn](#API_WaypointTracking_UpdateTracker_ResponseSyntax) ** 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` Type: String Length Constraints: Minimum length of 0. Maximum length of 1600. Pattern: `arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?` ** [TrackerName](#API_WaypointTracking_UpdateTracker_ResponseSyntax) ** The name of the updated tracker resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` ** [UpdateTime](#API_WaypointTracking_UpdateTracker_ResponseSyntax) ** The timestamp for when the tracker resource was last updated in [ ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sss`. Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waypointtracking-2020-11-19/UpdateTracker) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waypointtracking-2020-11-19/UpdateTracker) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waypointtracking-2020-11-19/UpdateTracker) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waypointtracking-2020-11-19/UpdateTracker) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waypointtracking-2020-11-19/UpdateTracker) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waypointtracking-2020-11-19/UpdateTracker) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waypointtracking-2020-11-19/UpdateTracker) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waypointtracking-2020-11-19/UpdateTracker) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waypointtracking-2020-11-19/UpdateTracker) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waypointtracking-2020-11-19/UpdateTracker) # VerifyDevicePosition Verifies the integrity of the device's position by determining if it was reported behind a proxy, and by comparing it to an inferred position estimated based on the device's state. **Note** The Location Integrity SDK provides enhanced features related to device verification, and it is available for use by request. To get access to the SDK, contact [Sales Support](https://aws.amazon.com/contact-us/sales-support/?pg=locationprice&cta=herobtn). ## Request Syntax ``` POST /tracking/v0/trackers/TrackerName/positions/verify HTTP/1.1 Content-type: application/json { "DeviceState": { "Accuracy": { "Horizontal": number }, "CellSignals": { "LteCellDetails": [ { "CellId": number, "LocalId": { "Earfcn": number, "Pci": number }, "Mcc": number, "Mnc": number, "NetworkMeasurements": [ { "CellId": number, "Earfcn": number, "Pci": number, "Rsrp": number, "Rsrq": number } ], "NrCapable": boolean, "Rsrp": number, "Rsrq": number, "Tac": number, "TimingAdvance": number } ] }, "DeviceId": "string", "Ipv4Address": "string", "Position": [ number ], "SampleTime": "string", "WiFiAccessPoints": [ { "MacAddress": "string", "Rss": number } ] }, "DistanceUnit": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [TrackerName](#API_WaypointTracking_VerifyDevicePosition_RequestSyntax) ** The name of the tracker resource to be associated with verification request. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\w]+` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [DeviceState](#API_WaypointTracking_VerifyDevicePosition_RequestSyntax) ** The device's state, including position, IP address, cell signals and Wi-Fi access points. Type: [DeviceState](API_WaypointTracking_DeviceState.md) object Required: Yes ** [DistanceUnit](#API_WaypointTracking_VerifyDevicePosition_RequestSyntax) ** The distance unit for the verification request. Default Value: `Kilometers` Type: String Valid Values: `Kilometers | Miles` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "DeviceId": "string", "DistanceUnit": "string", "InferredState": { "Accuracy": { "Horizontal": number }, "DeviationDistance": number, "Position": [ number ], "ProxyDetected": boolean }, "ReceivedTime": "string", "SampleTime": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DeviceId](#API_WaypointTracking_VerifyDevicePosition_ResponseSyntax) ** The device identifier. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[-._\p{L}\p{N}]+` ** [DistanceUnit](#API_WaypointTracking_VerifyDevicePosition_ResponseSyntax) ** The distance unit for the verification response. Type: String Valid Values: `Kilometers | Miles` ** [InferredState](#API_WaypointTracking_VerifyDevicePosition_ResponseSyntax) ** The inferred state of the device, given the provided position, IP address, cellular signals, and Wi-Fi- access points. Type: [InferredState](API_WaypointTracking_InferredState.md) object ** [ReceivedTime](#API_WaypointTracking_VerifyDevicePosition_ResponseSyntax) ** The timestamp for when the tracker resource received the device position in [ ISO 8601 ](https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sss`. Type: Timestamp ** [SampleTime](#API_WaypointTracking_VerifyDevicePosition_ResponseSyntax) ** The timestamp at which the device's position was determined. Uses [ ISO 8601 ](https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sss`. Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/waypointtracking-2020-11-19/VerifyDevicePosition) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/waypointtracking-2020-11-19/VerifyDevicePosition) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/waypointtracking-2020-11-19/VerifyDevicePosition) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/waypointtracking-2020-11-19/VerifyDevicePosition) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/waypointtracking-2020-11-19/VerifyDevicePosition) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/waypointtracking-2020-11-19/VerifyDevicePosition) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/waypointtracking-2020-11-19/VerifyDevicePosition) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/waypointtracking-2020-11-19/VerifyDevicePosition) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/waypointtracking-2020-11-19/VerifyDevicePosition) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/waypointtracking-2020-11-19/VerifyDevicePosition)