|
| 1 | +# Amazon Location code examples for the SDK for JavaScript (v3) |
| 2 | + |
| 3 | +## Overview |
| 4 | + |
| 5 | +Shows how to use the AWS SDK for JavaScript (v3) to work with Amazon Location Service. |
| 6 | + |
| 7 | +<!--custom.overview.start--> |
| 8 | +<!--custom.overview.end--> |
| 9 | + |
| 10 | +_Amazon Location lets you easily and securely add maps, places, routes, geofences, and trackers, to your applications._ |
| 11 | + |
| 12 | +## ⚠ Important |
| 13 | + |
| 14 | +* Running this code might result in charges to your AWS account. For more details, see [AWS Pricing](https://aws.amazon.com/pricing/) and [Free Tier](https://aws.amazon.com/free/). |
| 15 | +* Running the tests might result in charges to your AWS account. |
| 16 | +* We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see [Grant least privilege](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege). |
| 17 | +* This code is not tested in every AWS Region. For more information, see [AWS Regional Services](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services). |
| 18 | + |
| 19 | +<!--custom.important.start--> |
| 20 | +<!--custom.important.end--> |
| 21 | + |
| 22 | +## Code examples |
| 23 | + |
| 24 | +### Prerequisites |
| 25 | + |
| 26 | +For prerequisites, see the [README](../../README.md#Prerequisites) in the `javascriptv3` folder. |
| 27 | + |
| 28 | + |
| 29 | +<!--custom.prerequisites.start--> |
| 30 | +<!--custom.prerequisites.end--> |
| 31 | + |
| 32 | +### Basics |
| 33 | + |
| 34 | +Code examples that show you how to perform the essential operations within a service. |
| 35 | + |
| 36 | +- [Learn the basics](scenarios/location-service-basics.js) |
| 37 | + |
| 38 | + |
| 39 | +### Single actions |
| 40 | + |
| 41 | +Code excerpts that show you how to call individual service functions. |
| 42 | + |
| 43 | +- [BatchUpdateDevicePosition](actions/batch-update-device-position.js#L4) |
| 44 | +- [CalculateRoute](actions/calculate-distance-async.js#L4) |
| 45 | +- [CreateGeofenceCollection](actions/create-geofence-collection.js#L4) |
| 46 | +- [CreateMap](actions/create-map.js#L4) |
| 47 | +- [CreateRouteCalculator](actions/create-route-calculator.js#L4) |
| 48 | +- [CreateTracker](actions/create-tracker.js#L4) |
| 49 | +- [DeleteGeofenceCollection](actions/delete-geofence-collection.js#L4) |
| 50 | +- [DeleteMap](actions/delete-map.js#L4) |
| 51 | +- [DeleteRouteCalculator](actions/delete-route-calculator.js#L4) |
| 52 | +- [DeleteTracker](actions/delete-tracker.js#L4) |
| 53 | +- [GetDevicePosition](actions/get-device-position.js#L4) |
| 54 | +- [PutGeofence](actions/put-geofence.js#L4) |
| 55 | + |
| 56 | + |
| 57 | +<!--custom.examples.start--> |
| 58 | +<!--custom.examples.end--> |
| 59 | + |
| 60 | +## Run the examples |
| 61 | + |
| 62 | +### Instructions |
| 63 | + |
| 64 | +**Note**: All code examples are written in ECMAscript 6 (ES6). For guidelines on converting to CommonJS, see |
| 65 | +[JavaScript ES6/CommonJS syntax](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/sdk-examples-javascript-syntax.html). |
| 66 | + |
| 67 | +**Run a single action** |
| 68 | + |
| 69 | +```bash |
| 70 | +node ./actions/<fileName> |
| 71 | +``` |
| 72 | + |
| 73 | +**Run a scenario** |
| 74 | + |
| 75 | +Most scenarios can be run with the following command: |
| 76 | +```bash |
| 77 | +node ./scenarios/<fileName> |
| 78 | +``` |
| 79 | + |
| 80 | +**Run with options** |
| 81 | + |
| 82 | +Some actions and scenarios can be run with options from the command line: |
| 83 | +```bash |
| 84 | +node ./scenarios/<fileName> --option1 --option2 |
| 85 | +``` |
| 86 | +[util.parseArgs](https://nodejs.org/api/util.html#utilparseargsconfig) is used to configure |
| 87 | +these options. For the specific options available to each script, see the `parseArgs` usage |
| 88 | +for that file. |
| 89 | + |
| 90 | +<!--custom.instructions.start--> |
| 91 | +<!--custom.instructions.end--> |
| 92 | + |
| 93 | + |
| 94 | +#### Learn the basics |
| 95 | + |
| 96 | +This example shows you how to do the following: |
| 97 | + |
| 98 | +- Create an Amazon Location map. |
| 99 | +- Create an Amazon Location API key. |
| 100 | +- Display Map URL. |
| 101 | +- Create a geofence collection. |
| 102 | +- Store a geofence geometry. |
| 103 | +- Create a tracker resource. |
| 104 | +- Update the position of a device. |
| 105 | +- Retrieve the most recent position update for a specified device. |
| 106 | +- Create a route calculator. |
| 107 | +- Determine the distance between Seattle and Vancouver. |
| 108 | +- Use Amazon Location higher level APIs. |
| 109 | +- Delete the Amazon Location Assets. |
| 110 | + |
| 111 | +<!--custom.basic_prereqs.location_Scenario.start--> |
| 112 | +<!--custom.basic_prereqs.location_Scenario.end--> |
| 113 | + |
| 114 | + |
| 115 | +<!--custom.basics.location_Scenario.start--> |
| 116 | +<!--custom.basics.location_Scenario.end--> |
| 117 | + |
| 118 | + |
| 119 | +### Tests |
| 120 | + |
| 121 | +⚠ Running tests might result in charges to your AWS account. |
| 122 | + |
| 123 | + |
| 124 | +To find instructions for running these tests, see the [README](../../README.md#Tests) |
| 125 | +in the `javascriptv3` folder. |
| 126 | + |
| 127 | + |
| 128 | + |
| 129 | +<!--custom.tests.start--> |
| 130 | +<!--custom.tests.end--> |
| 131 | + |
| 132 | +## Additional resources |
| 133 | + |
| 134 | +- [Amazon Location Developer Guide](https://docs.aws.amazon.com/location/latest/developerguide/what-is.html) |
| 135 | +- [Amazon Location API Reference](https://docs.aws.amazon.com/location/latest/APIReference/Welcome.html) |
| 136 | +- [SDK for JavaScript (v3) Amazon Location reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/location/) |
| 137 | + |
| 138 | +<!--custom.resources.start--> |
| 139 | +<!--custom.resources.end--> |
| 140 | + |
| 141 | +--- |
| 142 | + |
| 143 | +Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. |
| 144 | + |
| 145 | +SPDX-License-Identifier: Apache-2.0 |
0 commit comments